label_view.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 "../../Display/Font/font.h"
33 #include "../../Display/2D/color.h"
34
35 namespace clan
36 {
37 enum class TextAlignment
38 {
39 left,
40 right,
41 center,
42 justify/*,
43 start,
44 end*/
45 };
46
47 enum class LineBreakMode
48 {
49 //word_wrapping,
50 //char_wrapping,
51 clipping,
52 truncating_head,
53 truncating_tail,
54 truncating_middle
55 };
56
57 class LabelViewImpl;
58
59 class LabelView : public View
60 {
61 public:
62 LabelView();
63
64 std::string text() const;
65 void set_text(const std::string &value);
66
67 TextAlignment text_alignment() const;
68 void set_text_alignment(TextAlignment alignment);
69
70 LineBreakMode line_break_mode() const;
71 void set_line_break_mode(LineBreakMode value);
72
73 void render_content(Canvas &canvas) override;
74 float get_preferred_width(Canvas &canvas) override;
75 float get_preferred_height(Canvas &canvas, float width) override;
76 float get_first_baseline_offset(Canvas &canvas, float width) override;
77 float get_last_baseline_offset(Canvas &canvas, float width) override;
78
79 void layout_subviews(Canvas &canvas) override;
80
81 private:
82 std::shared_ptr<LabelViewImpl> impl;
83 };
84
85 }
clan::LineBreakMode
LineBreakMode
Definition: label_view.h:47
clan
Definition: clanapp.h:35
clan::View
View for an area of the user interface.
Definition: view.h:61
clan::LabelView::get_last_baseline_offset
float get_last_baseline_offset(Canvas &canvas, float width) override
Calculates the offset to the last baseline.
clan::Canvas
2D Graphics Canvas
Definition: canvas.h:72
clan::LineBreakMode::truncating_tail
clan::LineBreakMode::clipping
clan::LabelView::set_text_alignment
void set_text_alignment(TextAlignment alignment)
clan::LabelView::get_first_baseline_offset
float get_first_baseline_offset(Canvas &canvas, float width) override
Calculates the offset to the first baseline.
clan::LabelView::get_preferred_width
float get_preferred_width(Canvas &canvas) override
Calculates the preferred width of this view.
clan::LabelView
Definition: label_view.h:59
clan::LabelView::render_content
void render_content(Canvas &canvas) override
Renders the content of a view.
clan::TextAlignment::left
clan::LineBreakMode::truncating_head
clan::StyleTokenType::string
@ keyword
clan::LabelView::get_preferred_height
float get_preferred_height(Canvas &canvas, float width) override
Calculates the preferred height of this view.
clan::LabelView::text
std::string text() const
clan::LabelView::set_text
void set_text(const std::string &value)
clan::LabelView::set_line_break_mode
void set_line_break_mode(LineBreakMode value)
clan::LabelView::layout_subviews
void layout_subviews(Canvas &canvas) override
Sets the view geometry for all subviews of this view.
clan::LabelView::LabelView
LabelView()
clan::LabelView::line_break_mode
LineBreakMode line_break_mode() const
clan::TextAlignment
TextAlignment
Definition: label_view.h:37
clan::TextAlignment::right
clan::TextAlignment::center
clan::TextAlignment::justify
clan::LineBreakMode::truncating_middle
clan::LabelView::text_alignment
TextAlignment text_alignment() const