Inheritance diagram for CEGUI::PropertySet:
Public Types | |
typedef ConstBaseIterator< PropertyRegistry > | Iterator |
Public Member Functions | |
PropertySet (void) | |
Constructs a new PropertySet object. | |
virtual | ~PropertySet (void) |
Destructor for PropertySet objects. | |
void | addProperty (Property *property) |
Adds a new Property to the PropertySet. | |
void | removeProperty (const String &name) |
Removes a Property from the PropertySet. | |
void | clearProperties (void) |
Removes all Property objects from the PropertySet. | |
bool | isPropertyPresent (const String &name) const |
Checks to see if a Property with the given name is in the PropertySet. | |
const String & | getPropertyHelp (const String &name) const |
Return the help text for the specified Property. | |
String | getProperty (const String &name) const |
Gets the current value of the specified Property. | |
void | setProperty (const String &name, const String &value) |
Sets the current value of a Property. | |
bool | isPropertyDefault (const String &name) const |
Returns whether a Property is at it's default value. | |
String | getPropertyDefault (const String &name) const |
Returns the default value of a Property as a String. | |
Iterator | getIterator (void) const |
Return a PropertySet::Iterator object to iterate over the available Properties. |
void CEGUI::PropertySet::addProperty | ( | Property * | property | ) |
Adds a new Property to the PropertySet.
property | Pointer to the Property object to be added to the PropertySet. |
NullObjectException | Thrown if property is NULL. | |
AlreadyExistsException | Thrown if a Property with the same name as property already exists in the PropertySet |
void CEGUI::PropertySet::clearProperties | ( | void | ) |
Gets the current value of the specified Property.
UnknownObjectException | Thrown if no Property named name is in the PropertySet. |
Return the help text for the specified Property.
UnknownObjectException | Thrown if no Property named name is in the PropertySet. |
bool CEGUI::PropertySet::isPropertyDefault | ( | const String & | name | ) | const |
bool CEGUI::PropertySet::isPropertyPresent | ( | const String & | name | ) | const |
Checks to see if a Property with the given name is in the PropertySet.
void CEGUI::PropertySet::removeProperty | ( | const String & | name | ) |
Removes a Property from the PropertySet.
name | String containing the name of the Property to be removed. If Property name is not in the set, nothing happens. |
Sets the current value of a Property.
name | String containing the name of the Property who's value is to be set. | |
value | String containing a textual representation of the new value for the Property |
UnknownObjectException | Thrown if no Property named name is in the PropertySet. | |
InvalidRequestException | Thrown when the Property was unable to interpret the content of value. |