Inheritance diagram for CEGUI::StaticText:
Public Types | |
enum | HorzFormatting { LeftAligned, RightAligned, HorzCentred, HorzJustified, WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified } |
Enumeration of horizontal formatting options for static text widgets. More... | |
enum | VertFormatting { TopAligned, BottomAligned, VertCentred } |
Enumeration of vertical formatting options for a static text widgets. More... | |
Public Member Functions | |
StaticText (const String &type, const String &name) | |
Constructor for static text widgets. | |
virtual | ~StaticText (void) |
Destructor for static text widgets. | |
ColourRect | getTextColours (void) const |
Return a ColourRect object containing the colours used when rendering this widget. | |
HorzFormatting | getHorizontalFormatting (void) const |
Return the current horizontal formatting option set for this widget. | |
VertFormatting | getVerticalFormatting (void) const |
Return the current vertical formatting option set for this widget. | |
bool | isVerticalScrollbarEnabled (void) const |
Return whether the vertical scroll bar is set to be shown if needed. | |
bool | isHorizontalScrollbarEnabled (void) const |
Return whether the horizontal scroll bar is set to be shown if needed. | |
virtual Rect | getUnclippedInnerRect (void) const |
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering. | |
virtual void | initialise (void) |
Initialise the Window based object ready for use. | |
void | setTextColours (const ColourRect &colours) |
Sets the colours to be applied when rendering the text. | |
void | setTextColours (const colour &top_left_colour, const colour &top_right_colour, const colour &bottom_left_colour, const colour &bottom_right_colour) |
Sets the colours to be applied when rendering the text. | |
void | setTextColours (const colour &col) |
Sets the colour to be applied when rendering the text. | |
void | setFormatting (HorzFormatting h_fmt, VertFormatting v_fmt) |
Set the formatting required for the text. | |
void | setVerticalFormatting (VertFormatting v_fmt) |
Set the formatting required for the text. | |
void | setHorizontalFormatting (HorzFormatting h_fmt) |
Set the formatting required for the text. | |
void | setVerticalScrollbarEnabled (bool setting) |
Set whether the vertical scroll bar will be shown if needed. | |
void | setHorizontalScrollbarEnabled (bool setting) |
Set whether the horizontal scroll bar will be shown if needed. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
Protected Member Functions | |
virtual void | populateRenderCache () |
Update the rendering cache. | |
virtual void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
virtual void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
virtual void | onFontChanged (WindowEventArgs &e) |
Handler called when the window's font is changed. | |
virtual void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
virtual Rect | getTextRenderArea (void) const |
Return a Rect object describing, in un-clipped pixels, the window relative area that the text should be rendered in to. | |
void | configureScrollbars (void) |
display required integrated scroll bars according to current state of the edit box and update their values. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual Scrollbar * | createVertScrollbar (const String &name) const =0 |
create and return a pointer to a Scrollbar widget for use as vertical scroll bar | |
virtual Scrollbar * | createHorzScrollbar (const String &name) const =0 |
create and return a pointer to a Scrollbar widget for use as horizontal scroll bar | |
bool | handleScrollbarChange (const EventArgs &e) |
Protected Attributes | |
HorzFormatting | d_horzFormatting |
Horizontal formatting to be applied to the text. | |
VertFormatting | d_vertFormatting |
Vertical formatting to be applied to the text. | |
ColourRect | d_textCols |
Colours used when rendering the text. | |
Scrollbar * | d_vertScrollbar |
Widget used as vertical scrollbar;. | |
Scrollbar * | d_horzScrollbar |
Widget used as horizontal scrollbar;. | |
bool | d_enableVertScrollbar |
true if vertical scroll bar is enabled. | |
bool | d_enableHorzScrollbar |
true if horizontal scroll bar is enabled. |
|
|
Enumeration of vertical formatting options for a static text widgets.
|
|
create and return a pointer to a Scrollbar widget for use as horizontal scroll bar
|
|
create and return a pointer to a Scrollbar widget for use as vertical scroll bar
|
|
Return the current horizontal formatting option set for this widget.
|
|
Return a ColourRect object containing the colours used when rendering this widget.
|
|
Return a Rect object describing, in un-clipped pixels, the window relative area that the text should be rendered in to.
|
|
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
Reimplemented from CEGUI::Static. |
|
Return the current vertical formatting option set for this widget.
|
|
Initialise the Window based object ready for use.
Reimplemented from CEGUI::Window. |
|
Return whether the horizontal scroll bar is set to be shown if needed.
|
|
Return whether the vertical scroll bar is set to be shown if needed.
|
|
Handler called when the window's font is changed.
Reimplemented from CEGUI::Window. |
|
Handler called when the mouse wheel (z-axis) position changes within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's size changes.
Reimplemented from CEGUI::Static. |
|
Handler called when the window's text is changed.
Reimplemented from CEGUI::Window. |
|
Update the rendering cache. Populates the Window's RenderCache with imagery to be sent to the renderer. Reimplemented from CEGUI::Static. |
|
Set the formatting required for the text.
|
|
Set the formatting required for the text.
|
|
Set whether the horizontal scroll bar will be shown if needed.
|
|
Sets the colour to be applied when rendering the text.
|
|
Sets the colours to be applied when rendering the text.
|
|
Sets the colours to be applied when rendering the text.
|
|
Set the formatting required for the text.
|
|
Set whether the vertical scroll bar will be shown if needed.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Static. |