MyGUI: MyGUI_ISubWidgetText.h Source File

MyGUI 3.2.2

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
15 namespace MyGUI
16 {
17
18 class MYGUI_EXPORT ISubWidgetText :
19 public ISubWidget
20 {
21 MYGUI_RTTI_DERIVED( ISubWidgetText )
22
23 public:
24 virtual ~ISubWidgetText() { }
25
27 virtual size_t getTextSelectionStart() const
28 {
29 return 0;
30 }
31
33 virtual size_t getTextSelectionEnd() const
34 {
35 return 0;
36 }
37
39 virtual void setTextSelection(size_t _start, size_t _end) { }
40
41 // интенсивность выделенного текста
42 virtual bool getSelectBackground() const
43 {
44 return true;
45 }
46
47 virtual void setSelectBackground(bool _normal) { }
48
49 // нужно ли инвертировать выделение
50 virtual bool getInvertSelected() const
51 {
52 return true;
53 }
54
55 virtual void setInvertSelected(bool _value) { }
56
57 // нужно ли показывать тень
58 virtual bool getShadow() const
59 {
60 return false;
61 }
62
63 virtual void setShadow(bool _value) { }
64
65 // управление видимостью курсора
66 virtual bool isVisibleCursor() const
67 {
68 return false;
69 }
70
71 virtual void setVisibleCursor(bool _value) { }
72
73 // управление положением курсора
74 virtual size_t getCursorPosition() const
75 {
76 return 0;
77 }
78
79 virtual void setCursorPosition(size_t _index) { }
80
81 virtual void setWordWrap(bool _value) { }
82
83 // возвращает положение курсора по произвольному положению
84 // позиция абсолютная, без учета смещений
85 virtual size_t getCursorPosition(const IntPoint& _point) /*const*/
86 {
87 return 0;
88 }
89
90 // возвращает положение курсора в обсолютных координатах
91 virtual IntCoord getCursorCoord(size_t _position) /*const*/
92 {
93 return IntCoord();
94 }
95
96 // возвращает положение курсора в обсолютных координатах
97 IntPoint getCursorPoint(size_t _position) /*const*/
98 {
99 const IntCoord& coord = getCursorCoord(_position);
100 return IntPoint(coord.left + coord.width / 2, coord.top + coord.height / 2);
101 }
102
103 // возвращает положение курсора в обсолютных координатах
104 IntRect getCursorRect(size_t _position) /*const*/
105 {
106 const IntCoord& coord = getCursorCoord(_position);
107 return IntRect(coord.left, coord.top, coord.left + coord.width, coord.top + coord.height);
108 }
109
110 // возвращает размер текста в пикселях
111 virtual IntSize getTextSize() /*const*/
112 {
113 return IntSize();
114 }
115
116 // устанавливает смещение текста в пикселях
117 virtual void setViewOffset(const IntPoint& _point) { }
118 virtual IntPoint getViewOffset() const
119 {
120 return IntPoint();
121 }
122
123 virtual void setCaption(const UString& _value) { }
124 virtual const UString& getCaption() const
125 {
126 return Constants::getEmptyUString();
127 }
128
129 virtual void setTextColour(const Colour& _value) { }
130 virtual const Colour& getTextColour() const
131 {
132 return Colour::Zero;
133 }
134
135 virtual void setFontName(const std::string& _value) { }
136 virtual const std::string& getFontName() const
137 {
138 return Constants::getEmptyString();
139 }
140
141 virtual void setFontHeight(int _value) { }
142 virtual int getFontHeight() const
143 {
144 return 0;
145 }
146
147 virtual void setTextAlign(Align _value) { }
148 virtual Align getTextAlign() const
149 {
150 return Align::Default;
151 }
152
153 virtual void setShiftText(bool _value) { }
154
155 virtual void setShadowColour(const Colour& _value) { }
156 virtual const Colour& getShadowColour() const
157 {
158 return Colour::Zero;
159 }
160
161 };
162
163 } // namespace MyGUI
164
165 #endif // MYGUI_I_SUB_WIDGET_TEXT_H_
MyGUI::ISubWidgetText::setVisibleCursor
virtual void setVisibleCursor(bool _value)
Definition: MyGUI_ISubWidgetText.h:71
MyGUI::ISubWidgetText
Definition: MyGUI_ISubWidgetText.h:18
MyGUI_Constants.h
MyGUI::IntCoord
types::TCoord< int > IntCoord
Definition: MyGUI_Types.h:35
MyGUI::ISubWidgetText::setFontHeight
virtual void setFontHeight(int _value)
Definition: MyGUI_ISubWidgetText.h:141
MyGUI::types::TCoord::left
T left
Definition: MyGUI_TCoord.h:22
MyGUI::ISubWidgetText::setShiftText
virtual void setShiftText(bool _value)
Definition: MyGUI_ISubWidgetText.h:153
MyGUI::ISubWidgetText::getCursorPoint
IntPoint getCursorPoint(size_t _position)
Definition: MyGUI_ISubWidgetText.h:97
MyGUI::types::TCoord::top
T top
Definition: MyGUI_TCoord.h:23
MyGUI::ISubWidgetText::isVisibleCursor
virtual bool isVisibleCursor() const
Definition: MyGUI_ISubWidgetText.h:66
MyGUI::types::TRect< int >
MyGUI::ISubWidgetText::setShadow
virtual void setShadow(bool _value)
Definition: MyGUI_ISubWidgetText.h:63
MyGUI::ISubWidgetText::getCursorCoord
virtual IntCoord getCursorCoord(size_t _position)
Definition: MyGUI_ISubWidgetText.h:91
MyGUI::ISubWidgetText::setFontName
virtual void setFontName(const std::string &_value)
Definition: MyGUI_ISubWidgetText.h:135
MyGUI::ISubWidgetText::getViewOffset
virtual IntPoint getViewOffset() const
Definition: MyGUI_ISubWidgetText.h:118
MyGUI::ISubWidgetText::setTextSelection
virtual void setTextSelection(size_t _start, size_t _end)
Definition: MyGUI_ISubWidgetText.h:39
MyGUI::types::TPoint< int >
MyGUI::ISubWidgetText::getCaption
virtual const UString & getCaption() const
Definition: MyGUI_ISubWidgetText.h:124
MyGUI::IntSize
types::TSize< int > IntSize
Definition: MyGUI_Types.h:29
MyGUI::ISubWidgetText::getCursorPosition
virtual size_t getCursorPosition(const IntPoint &_point)
Definition: MyGUI_ISubWidgetText.h:85
MyGUI::Align
Definition: MyGUI_Align.h:19
MyGUI::ISubWidgetText::getSelectBackground
virtual bool getSelectBackground() const
Definition: MyGUI_ISubWidgetText.h:42
MyGUI::ISubWidgetText::getTextAlign
virtual Align getTextAlign() const
Definition: MyGUI_ISubWidgetText.h:148
MyGUI::ISubWidgetText::getTextSize
virtual IntSize getTextSize()
Definition: MyGUI_ISubWidgetText.h:111
MyGUI::UString
A UTF-16 string with implicit conversion to/from std::string and std::wstring.
Definition: MyGUI_UString.h:168
MyGUI::Align::Default
Definition: MyGUI_Align.h:36
MyGUI::ISubWidgetText::setTextColour
virtual void setTextColour(const Colour &_value)
Definition: MyGUI_ISubWidgetText.h:129
MyGUI::IntPoint
types::TPoint< int > IntPoint
Definition: MyGUI_Types.h:26
MyGUI::ISubWidgetText::getCursorPosition
virtual size_t getCursorPosition() const
Definition: MyGUI_ISubWidgetText.h:74
MyGUI_Prerequest.h
MyGUI::ISubWidgetText::setShadowColour
virtual void setShadowColour(const Colour &_value)
Definition: MyGUI_ISubWidgetText.h:155
MyGUI_ISubWidget.h
MyGUI::ISubWidgetText::setSelectBackground
virtual void setSelectBackground(bool _normal)
Definition: MyGUI_ISubWidgetText.h:47
MyGUI::Constants::getEmptyString
static const std::string & getEmptyString()
Definition: MyGUI_Constants.h:24
MyGUI::ISubWidgetText::getShadowColour
virtual const Colour & getShadowColour() const
Definition: MyGUI_ISubWidgetText.h:156
MyGUI::ISubWidgetText::getCursorRect
IntRect getCursorRect(size_t _position)
Definition: MyGUI_ISubWidgetText.h:104
MyGUI::ISubWidgetText::getTextColour
virtual const Colour & getTextColour() const
Definition: MyGUI_ISubWidgetText.h:130
MYGUI_RTTI_DERIVED
#define MYGUI_RTTI_DERIVED(DerivedType)
Definition: MyGUI_RTTI.h:65
MyGUI::ISubWidgetText::~ISubWidgetText
virtual ~ISubWidgetText()
Definition: MyGUI_ISubWidgetText.h:24
MyGUI::types::TSize< int >
MyGUI::ISubWidgetText::getFontName
virtual const std::string & getFontName() const
Definition: MyGUI_ISubWidgetText.h:136
MyGUI::ISubWidgetText::setCaption
virtual void setCaption(const UString &_value)
Definition: MyGUI_ISubWidgetText.h:123
MyGUI::ISubWidgetText::setTextAlign
virtual void setTextAlign(Align _value)
Definition: MyGUI_ISubWidgetText.h:147
MyGUI::ISubWidgetText::setViewOffset
virtual void setViewOffset(const IntPoint &_point)
Definition: MyGUI_ISubWidgetText.h:117
MyGUI::ISubWidgetText::getTextSelectionEnd
virtual size_t getTextSelectionEnd() const
Definition: MyGUI_ISubWidgetText.h:33
MyGUI::Colour
Definition: MyGUI_Colour.h:16
MyGUI::ISubWidgetText::setInvertSelected
virtual void setInvertSelected(bool _value)
Definition: MyGUI_ISubWidgetText.h:55
MyGUI::types::TCoord::width
T width
Definition: MyGUI_TCoord.h:24
MyGUI::ISubWidgetText::getTextSelectionStart
virtual size_t getTextSelectionStart() const
Definition: MyGUI_ISubWidgetText.h:27
MYGUI_EXPORT
#define MYGUI_EXPORT
Definition: MyGUI_Platform.h:103
MyGUI::Constants::getEmptyUString
static const UString & getEmptyUString()
Definition: MyGUI_Constants.h:20
MyGUI::ISubWidgetText::setCursorPosition
virtual void setCursorPosition(size_t _index)
Definition: MyGUI_ISubWidgetText.h:79
MyGUI::ISubWidgetText::getInvertSelected
virtual bool getInvertSelected() const
Definition: MyGUI_ISubWidgetText.h:50
MyGUI::ISubWidgetText::setWordWrap
virtual void setWordWrap(bool _value)
Definition: MyGUI_ISubWidgetText.h:81
MyGUI_Colour.h
MyGUI::types::TCoord< int >
MyGUI::IntRect
types::TRect< int > IntRect
Definition: MyGUI_Types.h:32
MyGUI::ISubWidgetText::getShadow
virtual bool getShadow() const
Definition: MyGUI_ISubWidgetText.h:58
MyGUI::ISubWidgetText::getFontHeight
virtual int getFontHeight() const
Definition: MyGUI_ISubWidgetText.h:142
MyGUI::types::TCoord::height
T height
Definition: MyGUI_TCoord.h:25
MyGUI
Definition: MyGUI_ActionController.h:14
MyGUI::Colour::Zero
static const Colour Zero
Definition: MyGUI_Colour.h:54
MyGUI::ISubWidget
Definition: MyGUI_ISubWidget.h:24