CEGUI::WindowProperties::AlwaysOnTop Class Reference

Property to access window "Always-On-Top" setting. More...

Inheritance diagram for CEGUI::WindowProperties::AlwaysOnTop:

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

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.


Detailed Description

Property to access window "Always-On-Top" setting.

This property offers access to the always on top / topmost setting for the window.

Usage:
Where [Text] is:
  • "True" to indicate the Window is always on top, and appears above all other non-always on top Windows.
  • "False" to indicate the Window is not always on top, and will appear below all other always on top Windows.

Member Function Documentation

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


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