text_view.h Source File - ClanLib SDK
Description: text_view.h Source File

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:
43 TextView();
44 ~TextView();
45
46 Size preferred_size() const;
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
55 TextAlignment text_alignment() const;
56 void set_text_alignment(TextAlignment value);
57
58 bool is_read_only() const;
59 void set_read_only(bool value = true);
60
61 std::string selection() const;
62 Vec2i selection_start() const;
63 Vec2i selection_end() const;
64 void set_selection(Vec2i head, Vec2i tail);
65 void clear_selection();
66 void delete_selected_text();
67 void select_all();
68
69 Vec2i cursor_pos() const;
70 void set_cursor_pos(Vec2i pos);
71 void set_cursor_drawing_enabled(bool value);
72
73 Signal<void(KeyEvent &)> &sig_before_edit_changed();
74 Signal<void(KeyEvent &)> &sig_after_edit_changed();
75 Signal<void()> &sig_selection_changed();
76 Signal<void(KeyEvent &)> &sig_enter_pressed();
77
78 protected:
79 void render_content(Canvas &canvas) override;
80 float calculate_preferred_width(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}
clan::Canvas
2D Graphics Canvas
Definition canvas.h:72
clan::KeyEvent
Keyboard key event.
Definition key_event.h:48
clan::Signal
Definition signal.h:105
clan::Size
2D (width,height) size structure - Integer
Definition size.h:171
clan::TextView
Definition text_view.h:41
clan::TextView::sig_before_edit_changed
Signal< void(KeyEvent &)> & sig_before_edit_changed()
clan::TextView::set_selection
void set_selection(Vec2i head, Vec2i tail)
clan::TextView::set_cursor_pos
void set_cursor_pos(Vec2i pos)
clan::TextView::sig_after_edit_changed
Signal< void(KeyEvent &)> & sig_after_edit_changed()
clan::TextView::selection
std::string selection() const
clan::TextView::calculate_last_baseline_offset
float calculate_last_baseline_offset(Canvas &canvas, float width) override
Calculates the offset to the last baseline.
clan::TextView::selection_start
Vec2i selection_start() const
clan::TextView::placeholder
std::string placeholder() const
clan::TextView::~TextView
~TextView()
clan::TextView::text
std::string text() const
clan::TextView::calculate_first_baseline_offset
float calculate_first_baseline_offset(Canvas &canvas, float width) override
Calculates the offset to the first baseline.
clan::TextView::sig_enter_pressed
Signal< void(KeyEvent &)> & sig_enter_pressed()
clan::TextView::render_content
void render_content(Canvas &canvas) override
Renders the content of a view.
clan::TextView::clear_selection
void clear_selection()
clan::TextView::select_all
void select_all()
clan::TextView::set_placeholder
void set_placeholder(const std::string &value)
clan::TextView::is_read_only
bool is_read_only() const
clan::TextView::sig_selection_changed
Signal< void()> & sig_selection_changed()
clan::TextView::delete_selected_text
void delete_selected_text()
clan::TextView::TextView
TextView()
clan::TextView::set_preferred_size
void set_preferred_size(Size num_characters)
clan::TextView::text_alignment
TextAlignment text_alignment() const
clan::TextView::set_cursor_drawing_enabled
void set_cursor_drawing_enabled(bool value)
clan::TextView::set_text_alignment
void set_text_alignment(TextAlignment value)
clan::TextView::calculate_preferred_height
float calculate_preferred_height(Canvas &canvas, float width) override
Calculates the preferred height of this view.
clan::TextView::calculate_preferred_width
float calculate_preferred_width(Canvas &canvas) override
Calculates the preferred width of this view.
clan::TextView::selection_end
Vec2i selection_end() const
clan::TextView::preferred_size
Size preferred_size() const
clan::TextView::set_text
void set_text(const std::string &value)
clan::TextView::set_read_only
void set_read_only(bool value=true)
clan::TextView::cursor_pos
Vec2i cursor_pos() const
clan::Vec2< int >
clan::View
View for an area of the user interface.
Definition view.h:66
clan::View::canvas
Canvas canvas() const
clan
Definition clanapp.h:36
clan::TextAlignment
TextAlignment
Definition label_view.h:39