Public Member Functions

CEGUI::MenuItemProperties::PopupOffset Class Reference

Property to specify an offset for the popup menu position. More...

Inheritance diagram for CEGUI::MenuItemProperties::PopupOffset:
Collaboration diagram for CEGUI::MenuItemProperties::PopupOffset:

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 specify an offset for the popup menu position.

Usage:
  • Name: PopupOffset
  • Format: "{{[xs],[xo]},{[ys],[yo]}}"
Where:
  • [xs] is a floating point value describing the relative scale value for the offset x-coordinate.
  • [xo] is a floating point value describing the absolute offset value for the offset x-coordinate.
  • [ys] is a floating point value describing the relative scale value for the offset y-coordinate.
  • [yo] is a floating point value describing the absolute offset value for the offset y-coordinate.

Member Function Documentation

String CEGUI::MenuItemProperties::PopupOffset::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::MenuItemProperties::PopupOffset::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.