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