28 #ifndef _FalStaticText_h_
29 #define _FalStaticText_h_
31 #include "FalModule.h"
32 #include "FalStatic.h"
33 #include "FalStaticTextProperties.h"
34 #include "../../falagard/CEGUIFalEnums.h"
35 #include "../../CEGUIColourRect.h"
39 # pragma warning(push)
40 # pragma warning(disable : 4251)
75 static const utf8 TypeName[];
120 void setTextColours(
const ColourRect& colours);
150 void setVerticalScrollbarEnabled(
bool setting);
156 void setHorizontalScrollbarEnabled(
bool setting);
159 float getHorizontalTextExtent()
const;
162 float getVerticalTextExtent()
const;
168 void updateFormatting()
const;
170 void updateFormatting(
const Size& sz)
const;
173 void onLookNFeelAssigned();
174 void onLookNFeelUnassigned();
177 void renderScrolledText(
void);
178 void configureScrollbars(
void);
181 Rect getTextRenderArea(
void)
const;
182 Size getDocumentSize(
const Rect& renderArea)
const;
183 void setupStringFormatter()
const;
192 bool handleScrollbarChange(
const EventArgs& e);
215 typedef std::vector<Event::Connection> ConnectionList;
216 ConnectionList d_connections;
224 #if defined(_MSC_VER)
225 # pragma warning(pop)
228 #endif // end of guard _FalStaticText_h_
bool d_enableVertScrollbar
true if vertical scroll bar is enabled.
Definition: FalStaticText.h:209
bool d_enableHorzScrollbar
true if horizontal scroll bar is enabled.
Definition: FalStaticText.h:210
ColourRect d_textCols
Colours used when rendering the text.
Definition: FalStaticText.h:208
HorizontalTextFormatting d_horzFormatting
Horizontal formatting to be applied to the text.
Definition: FalStaticText.h:205
VerticalTextFormatting d_vertFormatting
Vertical formatting to be applied to the text.
Definition: FalStaticText.h:207
Base class used as the argument to all subscribers Event object.
Definition: CEGUIEventArgs.h:52
Class that holds the size (width & height) of something.
Definition: CEGUISize.h:43
Property to access the setting for enabling the vertical scroll bar.
Definition: FalStaticTextProperties.h:147
Class that holds details of colours for the four corners of a rectangle.
Definition: CEGUIColourRect.h:44
Property to access the text colours for the FalagardStaticText widget.
Definition: FalStaticTextProperties.h:62
HorizontalTextFormatting getHorizontalFormatting(void) const
Return the current horizontal formatting option set for this widget.
Definition: FalStaticText.h:108
HorizontalTextFormatting
Enumeration of possible values to indicate the horizontal formatting to be used for a text component...
Definition: CEGUIFalEnums.h:94
bool isVerticalScrollbarEnabled(void) const
Return whether the vertical scroll bar is set to be shown if needed.
Definition: FalStaticText.h:138
Property to access the vertical formatting mode setting.
Definition: FalStaticTextProperties.h:121
VerticalTextFormatting getVerticalFormatting(void) const
Return the current vertical formatting option set for this widget.
Definition: FalStaticText.h:114
ColourRect getTextColours(void) const
Return a ColourRect object containing the colours used when rendering this widget.
Definition: FalStaticText.h:102
bool isHorizontalScrollbarEnabled(void) const
Return whether the horizontal scroll bar is set to be shown if needed.
Definition: FalStaticText.h:144
FormattedRenderedString * d_formattedRenderedString
Class that renders RenderedString with some formatting.
Definition: FalStaticText.h:213
VerticalTextFormatting
Enumeration of possible values to indicate the vertical formatting to be used for a text component...
Definition: CEGUIFalEnums.h:83
Read-only property to access the current vertical extent of the formatted StaticText string...
Definition: FalStaticTextProperties.h:218
Static class for the FalagardBase module.
Definition: FalStatic.h:58
StaticText class for the FalagardBase module.
Definition: FalStaticText.h:72
bool d_formatValid
true when string formatting is up to date.
Definition: FalStaticText.h:219
static const String VertScrollbarNameSuffix
Widget name suffix for the vertical scrollbar component.
Definition: FalStaticText.h:80
Property to access the setting for enabling the horizontal scroll bar.
Definition: FalStaticTextProperties.h:173
Read-only property to access the current horizontal extent of the formatted StaticText string...
Definition: FalStaticTextProperties.h:195
static const String HorzScrollbarNameSuffix
Widget name suffix for the horizontal scrollbar component.
Definition: FalStaticText.h:81
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44
String class used within the GUI system.
Definition: CEGUIString.h:57
Property to access the horizontal formatting mode setting.
Definition: FalStaticTextProperties.h:94