CEGUI::WindowProperties::Font Class Reference

Property to access window Font setting. More...

Inheritance diagram for CEGUI::WindowProperties::Font:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::WindowProperties::Font:

Collaboration graph
[legend]

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


Detailed Description

Property to access window Font setting.

This property offers access to the current Font setting for the window.

Usage:
  • Name: Font
  • Format: "[text]".
Where:
  • [text] is the name of the Font to assign for this window. The Font specified must already be loaded.

Member Function Documentation

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

References CEGUI::PropertySet::getProperty().

bool CEGUI::WindowProperties::Font::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::Font::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.

References CEGUI::String::empty().


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