CEGUI::WindowProperties::MouseCursorImage Class Reference

Property to access window mouse cursor setting. More...

Inheritance diagram for CEGUI::WindowProperties::MouseCursorImage:

Collaboration diagram for CEGUI::WindowProperties::MouseCursorImage:

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...
bool	isDefault (const PropertyReceiver *receiver) const
	Returns whether the property is at it's default value. 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 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...

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 window mouse cursor setting.

    This property offers access to the current mouse cursor image for the window.

Usage:

• Name: MouseCursorImage
• Format: "set:[text] image:[text]".

Where:

• set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
• image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.

Member Function Documentation

String CEGUI::WindowProperties::MouseCursorImage::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

Implements CEGUI::Property.

bool CEGUI::WindowProperties::MouseCursorImage::isDefault ( const PropertyReceiver *  receiver ) const

virtual

Returns whether the property is at it's default value.

Parameters

receiver

Pointer to the target object.

Returns

• true if the property has it's default value.
• false if the property has been modified from it's default value.

Reimplemented from CEGUI::Property.

void CEGUI::WindowProperties::MouseCursorImage::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.

Returns

Nothing.

Exceptions

InvalidRequestException

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

Implements CEGUI::Property.