MyGUI: MyGUI_ISubWidgetText.h Source File

MyGUI 3.4.3

MyGUI_ISubWidgetText.h
Go to the documentation of this file.
1/*
2 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
3 * Distributed under the MIT License
4 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
5 */
6
7#ifndef MYGUI_I_SUB_WIDGET_TEXT_H_
8#define MYGUI_I_SUB_WIDGET_TEXT_H_
9
10#include "MyGUI_Prerequest.h"
11#include "MyGUI_ISubWidget.h"
12#include "MyGUI_Colour.h"
13#include "MyGUI_Constants.h"
14
15namespace MyGUI
16{
17
18 class MYGUI_EXPORT ISubWidgetText : public ISubWidget
19 {
20 MYGUI_RTTI_DERIVED(ISubWidgetText)
21
22 public:
24 virtual size_t getTextSelectionStart() const
25 {
26 return 0;
27 }
28
30 virtual size_t getTextSelectionEnd() const
31 {
32 return 0;
33 }
34
36 virtual void setTextSelection(size_t /*_start*/, size_t /*_end*/)
37 {
38 }
39
40 // интенсивность выделенного текста
41 virtual bool getSelectBackground() const
42 {
43 return true;
44 }
45
46 virtual void setSelectBackground(bool /*_normal*/)
47 {
48 }
49
50 // нужно ли инвертировать выделение
51 virtual bool getInvertSelected() const
52 {
53 return true;
54 }
55
56 virtual void setInvertSelected(bool /*_value*/)
57 {
58 }
59
60 // нужно ли показывать тень
61 virtual bool getShadow() const
62 {
63 return false;
64 }
65
66 virtual void setShadow(bool /*_value*/)
67 {
68 }
69
70 // управление видимостью курсора
71 virtual bool isVisibleCursor() const
72 {
73 return false;
74 }
75
76 virtual void setVisibleCursor(bool /*_value*/)
77 {
78 }
79
80 // управление положением курсора
81 virtual size_t getCursorPosition() const
82 {
83 return 0;
84 }
85
86 virtual void setCursorPosition(size_t /*_index*/)
87 {
88 }
89
90 virtual void setWordWrap(bool /*_value*/)
91 {
92 }
93
94 // возвращает положение курсора по произвольному положению
95 // позиция абсолютная, без учета смещений
96 virtual size_t getCursorPosition(const IntPoint& /*_point*/) const
97 {
98 return 0;
99 }
100
101 // возвращает положение курсора в обсолютных координатах
102 virtual IntCoord getCursorCoord(size_t /*_position*/) const
103 {
104 return {};
105 }
106
107 // возвращает положение курсора в обсолютных координатах
108 IntPoint getCursorPoint(size_t _position) const
109 {
110 const IntCoord& coord = getCursorCoord(_position);
111 return {coord.left + coord.width / 2, coord.top + coord.height / 2};
112 }
113
114 // возвращает положение курсора в обсолютных координатах
115 IntRect getCursorRect(size_t _position) const
116 {
117 const IntCoord& coord = getCursorCoord(_position);
118 return {coord.left, coord.top, coord.left + coord.width, coord.top + coord.height};
119 }
120
121 // возвращает размер текста в пикселях
122 virtual IntSize getTextSize() const
123 {
124 return {};
125 }
126
127 // устанавливает смещение текста в пикселях
128 virtual void setViewOffset(const IntPoint& /*_point*/)
129 {
130 }
131 virtual IntPoint getViewOffset() const
132 {
133 return {};
134 }
135
136 virtual void setCaption(const UString& /*_value*/)
137 {
138 }
139 virtual const UString& getCaption() const
140 {
141 return Constants::getEmptyUString();
142 }
143
144 virtual void setTextColour(const Colour& /*_value*/)
145 {
146 }
147 virtual const Colour& getTextColour() const
148 {
149 return Colour::Zero;
150 }
151
152 virtual void setFontName(std::string_view /*_value*/)
153 {
154 }
155 virtual std::string_view getFontName() const
156 {
157 return {};
158 }
159
160 virtual void setFontHeight(int /*_value*/)
161 {
162 }
163 virtual int getFontHeight() const
164 {
165 return 0;
166 }
167
168 virtual void setTextAlign(Align /*_value*/)
169 {
170 }
171 virtual Align getTextAlign() const
172 {
173 return Align::Default;
174 }
175
176 virtual void setShiftText(bool /*_value*/)
177 {
178 }
179
180 virtual void setShadowColour(const Colour& /*_value*/)
181 {
182 }
183 virtual const Colour& getShadowColour() const
184 {
185 return Colour::Zero;
186 }
187 };
188
189} // namespace MyGUI
190
191#endif // MYGUI_I_SUB_WIDGET_TEXT_H_
MyGUI_Colour.h
MyGUI_Constants.h
MyGUI_ISubWidget.h
MYGUI_EXPORT
#define MYGUI_EXPORT
Definition MyGUI_Platform.h:77
MyGUI_Prerequest.h
MYGUI_RTTI_DERIVED
#define MYGUI_RTTI_DERIVED(DerivedType)
Definition MyGUI_RTTI.h:69
MyGUI::Constants::getEmptyUString
static const UString & getEmptyUString()
Definition MyGUI_Constants.h:20
MyGUI::ISubWidget
Definition MyGUI_ISubWidget.h:25
MyGUI::ISubWidgetText
Definition MyGUI_ISubWidgetText.h:19
MyGUI::ISubWidgetText::getShadow
virtual bool getShadow() const
Definition MyGUI_ISubWidgetText.h:61
MyGUI::ISubWidgetText::getInvertSelected
virtual bool getInvertSelected() const
Definition MyGUI_ISubWidgetText.h:51
MyGUI::ISubWidgetText::setTextColour
virtual void setTextColour(const Colour &)
Definition MyGUI_ISubWidgetText.h:144
MyGUI::ISubWidgetText::getViewOffset
virtual IntPoint getViewOffset() const
Definition MyGUI_ISubWidgetText.h:131
MyGUI::ISubWidgetText::getTextColour
virtual const Colour & getTextColour() const
Definition MyGUI_ISubWidgetText.h:147
MyGUI::ISubWidgetText::getCaption
virtual const UString & getCaption() const
Definition MyGUI_ISubWidgetText.h:139
MyGUI::ISubWidgetText::setTextAlign
virtual void setTextAlign(Align)
Definition MyGUI_ISubWidgetText.h:168
MyGUI::ISubWidgetText::getCursorRect
IntRect getCursorRect(size_t _position) const
Definition MyGUI_ISubWidgetText.h:115
MyGUI::ISubWidgetText::getCursorPoint
IntPoint getCursorPoint(size_t _position) const
Definition MyGUI_ISubWidgetText.h:108
MyGUI::ISubWidgetText::setCaption
virtual void setCaption(const UString &)
Definition MyGUI_ISubWidgetText.h:136
MyGUI::ISubWidgetText::getTextSize
virtual IntSize getTextSize() const
Definition MyGUI_ISubWidgetText.h:122
MyGUI::ISubWidgetText::setShadowColour
virtual void setShadowColour(const Colour &)
Definition MyGUI_ISubWidgetText.h:180
MyGUI::ISubWidgetText::setWordWrap
virtual void setWordWrap(bool)
Definition MyGUI_ISubWidgetText.h:90
MyGUI::ISubWidgetText::setCursorPosition
virtual void setCursorPosition(size_t)
Definition MyGUI_ISubWidgetText.h:86
MyGUI::ISubWidgetText::getCursorCoord
virtual IntCoord getCursorCoord(size_t) const
Definition MyGUI_ISubWidgetText.h:102
MyGUI::ISubWidgetText::setFontHeight
virtual void setFontHeight(int)
Definition MyGUI_ISubWidgetText.h:160
MyGUI::ISubWidgetText::getCursorPosition
virtual size_t getCursorPosition(const IntPoint &) const
Definition MyGUI_ISubWidgetText.h:96
MyGUI::ISubWidgetText::getCursorPosition
virtual size_t getCursorPosition() const
Definition MyGUI_ISubWidgetText.h:81
MyGUI::ISubWidgetText::getFontHeight
virtual int getFontHeight() const
Definition MyGUI_ISubWidgetText.h:163
MyGUI::ISubWidgetText::setInvertSelected
virtual void setInvertSelected(bool)
Definition MyGUI_ISubWidgetText.h:56
MyGUI::ISubWidgetText::setFontName
virtual void setFontName(std::string_view)
Definition MyGUI_ISubWidgetText.h:152
MyGUI::ISubWidgetText::setVisibleCursor
virtual void setVisibleCursor(bool)
Definition MyGUI_ISubWidgetText.h:76
MyGUI::ISubWidgetText::getTextSelectionStart
virtual size_t getTextSelectionStart() const
Definition MyGUI_ISubWidgetText.h:24
MyGUI::ISubWidgetText::setTextSelection
virtual void setTextSelection(size_t, size_t)
Definition MyGUI_ISubWidgetText.h:36
MyGUI::ISubWidgetText::getTextAlign
virtual Align getTextAlign() const
Definition MyGUI_ISubWidgetText.h:171
MyGUI::ISubWidgetText::getFontName
virtual std::string_view getFontName() const
Definition MyGUI_ISubWidgetText.h:155
MyGUI::ISubWidgetText::getShadowColour
virtual const Colour & getShadowColour() const
Definition MyGUI_ISubWidgetText.h:183
MyGUI::ISubWidgetText::setSelectBackground
virtual void setSelectBackground(bool)
Definition MyGUI_ISubWidgetText.h:46
MyGUI::ISubWidgetText::setShiftText
virtual void setShiftText(bool)
Definition MyGUI_ISubWidgetText.h:176
MyGUI::ISubWidgetText::getTextSelectionEnd
virtual size_t getTextSelectionEnd() const
Definition MyGUI_ISubWidgetText.h:30
MyGUI::ISubWidgetText::setViewOffset
virtual void setViewOffset(const IntPoint &)
Definition MyGUI_ISubWidgetText.h:128
MyGUI::ISubWidgetText::getSelectBackground
virtual bool getSelectBackground() const
Definition MyGUI_ISubWidgetText.h:41
MyGUI::ISubWidgetText::setShadow
virtual void setShadow(bool)
Definition MyGUI_ISubWidgetText.h:66
MyGUI::ISubWidgetText::isVisibleCursor
virtual bool isVisibleCursor() const
Definition MyGUI_ISubWidgetText.h:71
MyGUI::UString
A UTF-16 string with implicit conversion to/from std::string and std::wstring.
Definition MyGUI_UString.h:144
MyGUI
Definition MyGUI_ActionController.h:15
MyGUI::IntRect
types::TRect< int > IntRect
Definition MyGUI_Types.h:33
MyGUI::IntPoint
types::TPoint< int > IntPoint
Definition MyGUI_Types.h:27
MyGUI::IntCoord
types::TCoord< int > IntCoord
Definition MyGUI_Types.h:36
MyGUI::IntSize
types::TSize< int > IntSize
Definition MyGUI_Types.h:30
MyGUI::Align
Definition MyGUI_Align.h:20
MyGUI::Align::Default
@ Default
Definition MyGUI_Align.h:36
MyGUI::Colour
Definition MyGUI_Colour.h:17
MyGUI::Colour::Zero
static const Colour Zero
Definition MyGUI_Colour.h:53
MyGUI::types::TCoord::height
T height
Definition MyGUI_TCoord.h:23
MyGUI::types::TCoord::width
T width
Definition MyGUI_TCoord.h:22
MyGUI::types::TCoord::top
T top
Definition MyGUI_TCoord.h:21
MyGUI::types::TCoord::left
T left
Definition MyGUI_TCoord.h:20