CEGUI::ProgressBarProperties::CurrentProgress Class Reference

Property to access the current progress of the progress bar. More...

Inheritance diagram for CEGUI::ProgressBarProperties::CurrentProgress:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::ProgressBarProperties::CurrentProgress:

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 the current progress of the progress bar.

Usage:
Where:
  • [float] is the current progress of the bar expressed as a value between 0 and 1.

Member Function Documentation

String CEGUI::ProgressBarProperties::CurrentProgress::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::ProgressBarProperties::CurrentProgress::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:34:57 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1