CEGUI::FalagardStaticText Class Reference

StaticText class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardStaticText:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::FalagardStaticText:

Collaboration graph
[legend]

List of all members.

Public Types

enum  HorzFormatting {
  LeftAligned, RightAligned, HorzCentred, HorzJustified,
  WordWrapLeftAligned, WordWrapRightAligned, WordWrapCentred, WordWrapJustified
}
 Enumeration of horizontal formatting options for falagard static text widgets. More...
enum  VertFormatting { TopAligned, BottomAligned, VertCentred }
 Enumeration of vertical formatting options for a falagard static text widgets. More...

Public Member Functions

 FalagardStaticText (const String &type)
 Constructor.
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.
void setTextColours (const ColourRect &colours)
 Sets the colours to be applied when rendering the text.
void setVerticalFormatting (VertFormatting v_fmt)
 Set the vertical formatting required for the text.
void setHorizontalFormatting (HorzFormatting h_fmt)
 Set the horizontal formatting required for the text.
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.
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.
void render (void)
 Populate render cache.

Static Public Attributes

static const utf8 TypeName [] = "Falagard/StaticText"
 type name for this widget.
static const String VertScrollbarNameSuffix
 Widget name suffix for the vertical scrollbar component.
static const String HorzScrollbarNameSuffix
 Widget name suffix for the horizontal scrollbar component.

Protected Types

typedef std::vector
< Event::Connection
ConnectionList

Protected Member Functions

void onLookNFeelAssigned ()
 Handler called when a Look'N'Feel is assigned to our window.
void onLookNFeelUnassigned ()
 Handler called when a Look'N'Feel is removed/unassigned from our window.
void renderScrolledText (void)
void configureScrollbars (void)
ScrollbargetVertScrollbar (void) const
ScrollbargetHorzScrollbar (void) const
Rect getTextRenderArea (void) const
Size getDocumentSize (const Rect &renderArea) const
bool onTextChanged (const EventArgs &e)
bool onSized (const EventArgs &e)
bool onFontChanged (const EventArgs &e)
bool onMouseWheel (const EventArgs &e)
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.
bool d_enableVertScrollbar
 true if vertical scroll bar is enabled.
bool d_enableHorzScrollbar
 true if horizontal scroll bar is enabled.
ConnectionList d_connections

Static Protected Attributes

static
FalagardStaticTextProperties::TextColours 
d_textColoursProperty
static
FalagardStaticTextProperties::VertFormatting 
d_vertFormattingProperty
static
FalagardStaticTextProperties::HorzFormatting 
d_horzFormattingProperty
static
FalagardStaticTextProperties::VertScrollbar 
d_vertScrollbarProperty
static
FalagardStaticTextProperties::HorzScrollbar 
d_horzScrollbarProperty


Detailed Description

StaticText class for the FalagardBase module.

This class requires LookNFeel to be assigned. The LookNFeel should provide the following:

States:

Named Areas (missing areas will default to 'WithFrameTextRenderArea'): WithFrameTextRenderArea WithFrameTextRenderAreaHScroll WithFrameTextRenderAreaVScroll WithFrameTextRenderAreaHVScroll NoFrameTextRenderArea NoFrameTextRenderAreaHScroll NoFrameTextRenderAreaVScroll NoFrameTextRenderAreaHVScroll


Member Enumeration Documentation

Enumeration of horizontal formatting options for falagard static text widgets.

Enumerator:
LeftAligned  Text is output as a single line of text with the first character aligned with the left edge of the widget.
RightAligned  Text is output as a single line of text with the last character aligned with the right edge of the widget.
HorzCentred  Text is output as a single line of text horizontally centred within the widget.
HorzJustified  Text is output as a single line of text with the first and last characters aligned with the edges of the widget.
WordWrapLeftAligned  Text is output as multiple word-wrapped lines of text with the first character of each line aligned with the left edge of the widget.
WordWrapRightAligned  Text is output as multiple word-wrapped lines of text with the last character of each line aligned with the right edge of the widget.
WordWrapCentred  Text is output as multiple word-wrapped lines of text with each line horizontally centered within the widget.
WordWrapJustified  Text is output as multiple word-wrapped lines of text with the first and last characters of each line aligned with the edges of the widget.

Enumeration of vertical formatting options for a falagard static text widgets.

Enumerator:
TopAligned  Text is output with the top of first line of text aligned with the top edge of the widget.
BottomAligned  Text is output with the bottom of last line of text aligned with the bottom edge of the widget.
VertCentred  Text is output vertically centred within the widget.


Member Function Documentation

void CEGUI::FalagardStaticText::render ( void   )  [virtual]

Populate render cache.

This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API...

Reimplemented from CEGUI::FalagardStatic.


Generated on Thu Nov 27 20:34:46 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1