Public Member Functions

CEGUI::WindowProperties::UpdateMode Class Reference

Property to access the update mode setting for the window. More...

Inheritance diagram for CEGUI::WindowProperties::UpdateMode:
Collaboration diagram for CEGUI::WindowProperties::UpdateMode:

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 update mode setting for the window.

Usage:
Where [Text] is:
  • "Always" to indicate the update function should always be called.
  • "Never" to indicate the update function should never be called.
  • "Visible" to indicate the update function should only be called when the window is visible (i.e. State of Visible property set to True).

Member Function Documentation

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

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