Public Member Functions

CEGUI::FalagardStaticTextProperties::TextColours Class Reference

Property to access the text colours for the FalagardStaticText widget. More...

Inheritance diagram for CEGUI::FalagardStaticTextProperties::TextColours:
Collaboration diagram for CEGUI::FalagardStaticTextProperties::TextColours:

List of all members.

Public Member Functions

String get (const PropertyReceiver *receiver) const
 Return the current value of the Property as a String.
void set (PropertyReceiver *receiver, const String &value)
 Sets the value of the property.

Detailed Description

Property to access the text colours for the FalagardStaticText widget.

Usage:
  • Name: TextColours
  • Format: "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".
Where:
  • tl:[aarrggbb] is the top-left colour value specified as ARGB (hex).
  • tr:[aarrggbb] is the top-right colour value specified as ARGB (hex).
  • bl:[aarrggbb] is the bottom-left colour value specified as ARGB (hex).
  • br:[aarrggbb] is the bottom-right colour value specified as ARGB (hex).

Member Function Documentation

String CEGUI::FalagardStaticTextProperties::TextColours::get ( const PropertyReceiver receiver ) const [virtual]

Return the current value of the Property as a String.

Parameters:
receiverPointer to the target object.
Returns:
String object containing a textual representation of the current value of the Property

Implements CEGUI::Property.

void CEGUI::FalagardStaticTextProperties::TextColours::set ( PropertyReceiver receiver,
const String value 
) [virtual]

Sets the value of the property.

Parameters:
receiverPointer to the target object.
valueA String object that contains a textual representation of the new value to assign to the Property.
Returns:
Nothing.
Exceptions:
InvalidRequestExceptionThrown when the Property was unable to interpret the content of value.

Implements CEGUI::Property.