Crazy Eddies GUI System
0.7.0
|
MultiLineEditbox class for the FalagardBase module. More...
Public Member Functions | |
FalagardMultiLineEditbox (const String &type) | |
Constructor. | |
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. More... | |
void | render () |
Populate render cache. More... | |
void | update (float elapsed) |
perform any time based updates for this WindowRenderer. | |
bool | isCaretBlinkEnabled () const |
return whether the blinking caret is enabled. | |
float | getCaretBlinkTimeout () const |
return the caret blink timeout period (only used if blink is enabled). | |
void | setCaretBlinkEnabled (bool enable) |
set whether the blinking caret is enabled. | |
void | setCaretBlinkTimeout (float seconds) |
set the caret blink timeout period (only used if blink is enabled). | |
Public Member Functions inherited from CEGUI::MultiLineEditboxWindowRenderer | |
MultiLineEditboxWindowRenderer (const String &name) | |
Constructor. | |
Public Member Functions inherited from CEGUI::WindowRenderer | |
WindowRenderer (const String &name, const String &class_name="Window") | |
Constructor. More... | |
virtual | ~WindowRenderer () |
Destructor. | |
const String & | getName () const |
Returns the factory type name of this window renderer. | |
Window * | getWindow () const |
Get the window this windowrenderer is attached to. | |
const String & | getClass () const |
Get the "minimum" Window class this renderer requires. | |
const WidgetLookFeel & | getLookNFeel () const |
Get the Look'N'Feel assigned to our window. | |
virtual Rect | getUnclippedInnerRect () const |
Get unclipped inner rectangle that our window should return from its member function with the same name. | |
virtual void | performChildWindowLayout () |
Method called to perform extended laying out of the window's attached child windows. | |
virtual void | getRenderingContext (RenderingContext &ctx) const |
update the RenderingContext as needed for our window. This is normally invoked via our window's member function with the same name. | |
Static Public Attributes | |
static const utf8 | TypeName [] |
static const String | UnselectedTextColourPropertyName |
Name of property to use to obtain unselected text rendering colour. More... | |
static const String | SelectedTextColourPropertyName |
Name of property to use to obtain selected text rendering colour. | |
static const String | ActiveSelectionColourPropertyName |
Name of property to use to obtain active selection rendering colour. | |
static const String | InactiveSelectionColourPropertyName |
Name of property to use to obtain inactive selection rendering colour. | |
static const float | DefaultCaretBlinkTimeout |
The default timeout (in seconds) used when blinking the caret. | |
Protected Member Functions | |
void | cacheEditboxBaseImagery () |
Perform rendering of the widget control frame and other 'static' areas. This method should not render the actual text. Note that the text will be rendered to layer 4 and the selection brush to layer 3, other layers can be used for rendering imagery behind and infront of the text & selection.. More... | |
void | cacheCaratImagery (const Rect &textArea) |
Render the carat. More... | |
void | cacheTextLines (const Rect &dest_area) |
Render text lines. | |
colour | getUnselectedTextColour () const |
return the colour to be used for rendering Editbox text oustside of the selected region. More... | |
colour | getActiveSelectionColour () const |
return the colour to be used for rendering the selection highlight when the editbox is active. More... | |
colour | getInactiveSelectionColour () const |
return the colour to be used for rendering the selection highlight when the editbox is inactive. More... | |
colour | getSelectedTextColour () const |
return the colour to be used for rendering Editbox text falling within the selected region. More... | |
colour | getOptionalPropertyColour (const String &propertyName) const |
Return a colour object fetched from the named property if it exists, else a default colour (black). More... | |
Protected Attributes | |
bool | d_blinkCaret |
true if the caret imagery should blink. | |
float | d_caretBlinkTimeout |
time-out in seconds used for blinking the caret. | |
float | d_caretBlinkElapsed |
current time elapsed since last caret blink state change. | |
bool | d_showCaret |
true if caret should be shown. | |
Static Protected Attributes | |
static FalagardMultiLineEditboxProperties::BlinkCaret | d_blinkCaretProperty |
static FalagardMultiLineEditboxProperties::BlinkCaretTimeout | d_blinkCaretTimeoutProperty |
Additional Inherited Members | |
Protected Types inherited from CEGUI::WindowRenderer | |
typedef std::vector< Property * > | PropertyList |
MultiLineEditbox class for the FalagardBase module.
This class requires LookNFeel to be assigned. The LookNFeel should provide the following:
States:
NamedAreas: TextArea - area where text, selection, and carat imagery will appear. TextAreaHScroll - TextArea when only horizontal scrollbar is visible. TextAreaVScroll - TextArea when only vertical scrollbar is visible. TextAreaHVScroll - TextArea when both horizontal and vertical scrollbar is visible.
PropertyDefinitions (optional, defaults will be black):
Imagery Sections:
Child Widgets: Scrollbar based widget with name suffix "__auto_vscrollbar__" Scrollbar based widget with name suffix "__auto_hscrollbar__"
|
protected |
Render the carat.
|
protected |
Perform rendering of the widget control frame and other 'static' areas. This method should not render the actual text. Note that the text will be rendered to layer 4 and the selection brush to layer 3, other layers can be used for rendering imagery behind and infront of the text & selection..
|
protected |
return the colour to be used for rendering the selection highlight when the editbox is active.
|
protected |
return the colour to be used for rendering the selection highlight when the editbox is inactive.
|
protected |
Return a colour object fetched from the named property if it exists, else a default colour (black).
propertyName | String object holding the name of the property to be accessed if it exists. |
|
protected |
return the colour to be used for rendering Editbox text falling within the selected region.
|
virtual |
Return a Rect object describing, in un-clipped pixels, the window relative area that the text should be rendered in to.
Implements CEGUI::MultiLineEditboxWindowRenderer.
|
protected |
return the colour to be used for rendering Editbox text oustside of the selected region.
|
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...
Implements CEGUI::WindowRenderer.
|
static |
Name of property to use to obtain unselected text rendering colour.
type name for this widget.