CEGUI::FalagardEditbox Class Reference

Editbox class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardEditbox:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 FalagardEditbox (const String &type)
 Constructor.
colour getUnselectedTextColour () const
 return the colour to be used for rendering Editbox text oustside of the selected region.
colour getSelectedTextColour () const
 return the colour to be used for rendering Editbox text falling within the selected region.
colour getOptionalPropertyColour (const String &propertyName) const
 Return a colour object fetched from the named property if it exists, else a default colour (black).
void render ()
 Populate render cache.
size_t getTextIndexFromPosition (const Point &pt) const
 Return the text code point index that is rendered closest to screen position pt.

Public Attributes

float d_lastTextOffset
 x rendering offset used last time we drew the widget.

Static Public Attributes

static const utf8 TypeName [] = "Falagard/Editbox"
 type name for this widget.
static const String UnselectedTextColourPropertyName
 Name of property to access for unselected text colour.
static const String SelectedTextColourPropertyName
 Name of property to access for selected text colour.


Detailed Description

Editbox 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.

PropertyDefinitions (optional, defaults will be black):

Imagery Sections:


Member Function Documentation

colour CEGUI::FalagardEditbox::getOptionalPropertyColour ( const String propertyName  )  const

Return a colour object fetched from the named property if it exists, else a default colour (black).

Parameters:
propertyName String object holding the name of the property to be accessed if it exists.

References CEGUI::WindowRenderer::d_window, CEGUI::PropertySet::getProperty(), and CEGUI::PropertySet::isPropertyPresent().

Referenced by getSelectedTextColour(), and getUnselectedTextColour().

colour CEGUI::FalagardEditbox::getSelectedTextColour (  )  const

return the colour to be used for rendering Editbox text falling within the selected region.

Returns:
colour value describing the colour to be used.

References getOptionalPropertyColour(), and SelectedTextColourPropertyName.

Referenced by render().

size_t CEGUI::FalagardEditbox::getTextIndexFromPosition ( const Point pt  )  const [virtual]

Return the text code point index that is rendered closest to screen position pt.

Parameters:
pt Point object describing a position on the screen in pixels.
Returns:
Code point index into the text that is rendered closest to screen position pt.

Implements CEGUI::EditboxWindowRenderer.

References d_lastTextOffset, CEGUI::WindowRenderer::d_window, CEGUI::Vector2::d_x, CEGUI::Font::getCharAtPixel(), CEGUI::Window::getFont(), CEGUI::Editbox::getMaskCodePoint(), CEGUI::Window::getText(), CEGUI::Editbox::isTextMasked(), CEGUI::String::length(), and CEGUI::CoordConverter::screenToWindowX().

colour CEGUI::FalagardEditbox::getUnselectedTextColour (  )  const

return the colour to be used for rendering Editbox text oustside of the selected region.

Returns:
colour value describing the colour to be used.

References getOptionalPropertyColour(), and UnselectedTextColourPropertyName.

Referenced by render().

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


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