Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUI::ScrollablePaneProperties::VertStepSize Class Reference

Property to access the step size for the vertical Scrollbar. More...

+ Inheritance diagram for CEGUI::ScrollablePaneProperties::VertStepSize:
+ Collaboration diagram for CEGUI::ScrollablePaneProperties::VertStepSize:

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.
- 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.
virtual ~Property (void)
 Destructor for Property objects.
const StringgetHelp (void) const
 Return a String that describes the purpose and usage of this Property.
const StringgetName (void) const
 Return a the name of this Property.
virtual bool isDefault (const PropertyReceiver *receiver) const
 Returns whether the property is at it's default value.
virtual String getDefault (const PropertyReceiver *receiver) const
 Returns the default value of the Property as a String.
virtual void writeXMLToStream (const PropertyReceiver *receiver, XMLSerializer &xml_stream) const
 Writes out an XML representation of this class to the given stream.
virtual void initialisePropertyReceiver (PropertyReceiver *receiver) const
 function to allow initialisation of a PropertyReceiver.

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 the step size for the vertical Scrollbar.

Usage:
Where:
  • [float] specifies the size of the increase/decrease button step for the vertical scrollbar (as a fraction of 1 page).

Member Function Documentation

String CEGUI::ScrollablePaneProperties::VertStepSize::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::ScrollablePaneProperties::VertStepSize::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.