Crazy Eddies GUI System  0.7.2
Public Member Functions | List of all members
CEGUI::WindowProperties::AlwaysOnTop Class Reference

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

+ Inheritance diagram for CEGUI::WindowProperties::AlwaysOnTop:
+ Collaboration diagram for CEGUI::WindowProperties::AlwaysOnTop:

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...
 
- 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 StringgetHelp (void) const
 Return a String that describes the purpose and usage of this Property. More...
 
const StringgetName (void) const
 Return a the name of this Property. More...
 
virtual bool isDefault (const PropertyReceiver *receiver) const
 Returns whether the property is at it's default value. 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 "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
receiverPointer 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
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.