text_view.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 The ClanLib Team
4**
5** This software is provided 'as-is', without any express or implied
6** warranty. In no event will the authors be held liable for any damages
7** arising from the use of this software.
8**
9** Permission is granted to anyone to use this software for any purpose,
10** including commercial applications, and to alter it and redistribute it
11** freely, subject to the following restrictions:
12**
13** 1. The origin of this software must not be misrepresented; you must not
14** claim that you wrote the original software. If you use this software
15** in a product, an acknowledgment in the product documentation would be
16** appreciated but is not required.
17** 2. Altered source versions must be plainly marked as such, and must not be
18** misrepresented as being the original software.
19** 3. This notice may not be removed or altered from any source distribution.
20**
21** Note: Some of the libraries ClanLib may link to may have additional
22** requirements or restrictions.
23**
24** File Author(s):
25**
26** Magnus Norddahl
27*/
28
29#pragma once
30
31#include "../View/view.h"
32#include "../../Core/Math/size.h"
33#include "../../Core/Math/vec2.h"
34#include "label_view.h"
35
36namespace clan
37{
38 class TextViewImpl;
39
40 class TextView : public View
41 {
42 public:
45
47 void set_preferred_size(Size num_characters);
48
49 std::string text() const;
50 void set_text(const std::string &value);
51
52 std::string placeholder() const;
53 void set_placeholder(const std::string &value);
54
57
58 bool is_read_only() const;
59 void set_read_only(bool value = true);
60
61 std::string selection() const;
64 void set_selection(Vec2i head, Vec2i tail);
67 void select_all();
68
72
77
78 protected:
79 void render_content(Canvas &canvas) override;
81 float calculate_preferred_height(Canvas &canvas, float width) override;
82 float calculate_first_baseline_offset(Canvas &canvas, float width) override;
83 float calculate_last_baseline_offset(Canvas &canvas, float width) override;
84
85 private:
86 std::unique_ptr<TextViewImpl> impl;
87 };
88}
2D Graphics Canvas
Definition: canvas.h:72
Keyboard key event.
Definition: key_event.h:48
Definition: signal.h:105
2D (width,height) size structure - Integer
Definition: size.h:171
Definition: text_view.h:41
Signal< void(KeyEvent &)> & sig_before_edit_changed()
void set_selection(Vec2i head, Vec2i tail)
void set_cursor_pos(Vec2i pos)
Signal< void(KeyEvent &)> & sig_after_edit_changed()
std::string selection() const
float calculate_last_baseline_offset(Canvas &canvas, float width) override
Calculates the offset to the last baseline.
Vec2i selection_start() const
std::string placeholder() const
std::string text() const
float calculate_first_baseline_offset(Canvas &canvas, float width) override
Calculates the offset to the first baseline.
Signal< void(KeyEvent &)> & sig_enter_pressed()
void render_content(Canvas &canvas) override
Renders the content of a view.
void clear_selection()
void set_placeholder(const std::string &value)
bool is_read_only() const
Signal< void()> & sig_selection_changed()
void delete_selected_text()
void set_preferred_size(Size num_characters)
TextAlignment text_alignment() const
void set_cursor_drawing_enabled(bool value)
void set_text_alignment(TextAlignment value)
float calculate_preferred_height(Canvas &canvas, float width) override
Calculates the preferred height of this view.
float calculate_preferred_width(Canvas &canvas) override
Calculates the preferred width of this view.
Vec2i selection_end() const
Size preferred_size() const
void set_text(const std::string &value)
void set_read_only(bool value=true)
Vec2i cursor_pos() const
View for an area of the user interface.
Definition: view.h:66
Canvas canvas() const
Definition: clanapp.h:36
TextAlignment
Definition: label_view.h:39