CEGUI::FalagardEditbox Class Reference

Editbox class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardEditbox:

Collaboration diagram for CEGUI::FalagardEditbox:

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. 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...
void	render ()
	Populate render cache. More...
size_t	getTextIndexFromPosition (const Point &pt) const
	Return the text code point index that is rendered closest to screen position pt. More...
Public Member Functions inherited from CEGUI::EditboxWindowRenderer
	EditboxWindowRenderer (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 Rect	getPixelRect () const
	Get actual pixel rectangle our window is to 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.

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.

Additional Inherited Members
Protected Types inherited from CEGUI::WindowRenderer
typedef std::vector< Property * >	PropertyList
Protected Member Functions inherited from CEGUI::WindowRenderer
void	registerProperty (Property *property)
	Register a property class that will be properly managed by this window renderer. More...
virtual void	onAttach ()
	Handler called when this windowrenderer is attached to a window.
virtual void	onDetach ()
	Handler called when this windowrenderer is detached from its window.
virtual void	onLookNFeelAssigned ()
	Handler called when a Look'N'Feel is assigned to our window.
virtual void	onLookNFeelUnassigned ()
	Handler called when a Look'N'Feel is removed/unassigned from our window.
Protected Attributes inherited from CEGUI::WindowRenderer
Window *	d_window
	Pointer to the window this windowrenderer is assigned to.
const String	d_name
	Name of the factory type used to create this window renderer.
const String	d_class
	Name of the widget class that is the "minimum" requirement.
PropertyList	d_properties
	The list of properties that this windowrenderer will be handling.

Detailed Description

Editbox class for the FalagardBase module.

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

States:

• Enabled - Rendering for when the editbox is in enabled and is in read-write mode.
• ReadOnly - Rendering for when the editbox is in enabled and is in read-only mode.
• Disabled - Rendering for when the editbox is disabled.
• ActiveSelection - additional state rendered for text selection (the imagery in this section is rendered within the selection area.)
• InactiveSelection - additional state rendered for text selection (the imagery in this section is rendered within the selection area.)

NamedAreas: TextArea - area where text, selection, and carat imagery will appear.

PropertyDefinitions (optional, defaults will be black):

• NormalTextColour - property that accesses a colour value to be used to render normal unselected text.
• SelectedTextColour - property that accesses a colour value to be used to render selected text.

Imagery Sections:

• Carat

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::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

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.

References CEGUI::RenderCache::cacheText(), d_lastTextOffset, CEGUI::WindowRenderer::d_window, CEGUI::NamedArea::getArea(), CEGUI::ImagerySection::getBoundingRect(), CEGUI::Editbox::getCaratIndex(), CEGUI::Window::getEffectiveAlpha(), CEGUI::Window::getFont(), CEGUI::WidgetLookFeel::getImagerySection(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::Editbox::getMaskCodePoint(), CEGUI::WidgetLookFeel::getNamedArea(), CEGUI::ComponentArea::getPixelRect(), CEGUI::Window::getRenderCache(), getSelectedTextColour(), CEGUI::Editbox::getSelectionEndIndex(), CEGUI::Editbox::getSelectionLength(), CEGUI::Editbox::getSelectionStartIndex(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::getText(), getUnselectedTextColour(), CEGUI::Rect::getWidth(), CEGUI::Editbox::hasInputFocus(), CEGUI::String::insert(), CEGUI::Window::isDisabled(), CEGUI::Editbox::isReadOnly(), CEGUI::Editbox::isTextMasked(), CEGUI::LeftAligned, CEGUI::String::length(), CEGUI::ColourRect::modulateAlpha(), CEGUI::StateImagery::render(), CEGUI::ImagerySection::render(), CEGUI::ColourRect::setColours(), and CEGUI::String::substr().