Property to access the current carat index. More...

Inheritance diagram for CEGUI::EditboxProperties::CaratIndex:

Collaboration diagram for CEGUI::EditboxProperties::CaratIndex:

Public Member Functions
String	get (const PropertyReceiver *receiver) const
	Return the current value of the Property as a String. More...

void	set (PropertyReceiver *receiver, const String &value)
	Sets the value of the property. More...

Public Member Functions inherited from CEGUI::Property
	Property (const String &name, const String &help, const String &defaultValue="", bool writesXML=true)
	Creates a new Property object. More...

virtual	~Property (void)
	Destructor for Property objects.

const String &	getHelp (void) const
	Return a String that describes the purpose and usage of this Property. More...

const String &	getName (void) const
	Return a the name of this Property. More...

virtual bool	isDefault (const PropertyReceiver *receiver) const
	Returns whether the property is at it's default value. More...

virtual String	getDefault (const PropertyReceiver *receiver) const
	Returns the default value of the Property as a String. More...

virtual void	writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
	Writes out an XML representation of this class to the given stream. More...

virtual void	initialisePropertyReceiver (PropertyReceiver *receiver) const
	function to allow initialisation of a PropertyReceiver.

Additional Inherited Members
Protected Attributes inherited from CEGUI::Property
String	d_name
	String that stores the Property name.

String	d_help
	String that stores the Property help text.

String	d_default
	String that stores the Property default value string.

bool	d_writeXML
	Specifies whether writeXMLToStream should do anything for this property.

Detailed Description

Property to access the current carat index.

Usage:

Where:

Member Function Documentation

String CEGUI::EditboxProperties::CaratIndex::get ( const PropertyReceiver * receiver ) const

virtual

Return the current value of the Property as a String.

Parameters

receiver Pointer to the target object.

Returns: String object containing a textual representation of the current value of the Property

void CEGUI::EditboxProperties::CaratIndex::set	(	PropertyReceiver *	receiver,
		const String &	value
	)

virtual

Sets the value of the property.

Parameters

receiver	Pointer to the target object.
value	A String object that contains a textual representation of the new value to assign to the Property.

Exceptions

InvalidRequestException Thrown when the Property was unable to interpret the content of value.