Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::PropertySet Class Reference

Class that contains a collection of Property objects. More...

#include <CEGUIPropertySet.h>

Inheritance diagram for CEGUI::PropertySet:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::PropertySet:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ConstBaseIterator<
PropertyRegistry > 
PropertyIterator

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 StringgetPropertyHelp (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.
PropertyIterator getIterator (void) const
 Return a PropertySet::PropertyIterator object to iterate over the available Properties.

Detailed Description

Class that contains a collection of Property objects.

Definition at line 48 of file CEGUIPropertySet.h.


Member Typedef Documentation

typedef ConstBaseIterator<PropertyRegistry> CEGUI::PropertySet::PropertyIterator
 

Definition at line 201 of file CEGUIPropertySet.h.


Constructor & Destructor Documentation

CEGUI::PropertySet::PropertySet void   )  [inline]
 

Constructs a new PropertySet object.

Definition at line 55 of file CEGUIPropertySet.h.

virtual CEGUI::PropertySet::~PropertySet void   )  [inline, virtual]
 

Destructor for PropertySet objects.

Definition at line 62 of file CEGUIPropertySet.h.


Member Function Documentation

void CEGUI::PropertySet::addProperty Property property  ) 
 

Adds a new Property to the PropertySet.

Parameters:
property Pointer to the Property object to be added to the PropertySet.
Returns:
Nothing.
Exceptions:
NullObjectException Thrown if property is NULL.
AlreadyExistsException Thrown if a Property with the same name as property already exists in the PropertySet

Definition at line 37 of file CEGUIPropertySet.cpp.

References CEGUI::Property::getName().

Referenced by CEGUI::Window::addStandardProperties(), CEGUI::TabControl::addTabControlProperties(), and CEGUI::WidgetLookFeel::initialiseWidget().

void CEGUI::PropertySet::clearProperties void   ) 
 

Removes all Property objects from the PropertySet.

Returns:
Nothing.

Definition at line 68 of file CEGUIPropertySet.cpp.

PropertySet::PropertyIterator CEGUI::PropertySet::getIterator void   )  const
 

Return a PropertySet::PropertyIterator object to iterate over the available Properties.

Definition at line 131 of file CEGUIPropertySet.cpp.

Referenced by CEGUI::Window::writePropertiesXML().

String CEGUI::PropertySet::getProperty const String name  )  const
 

Gets the current value of the specified Property.

Parameters:
name String containing the name of the Property who's value is to be returned.
Returns:
String object containing a textual representation of the requested Property.
Exceptions:
UnknownObjectException Thrown if no Property named name is in the PropertySet.

Definition at line 99 of file CEGUIPropertySet.cpp.

Referenced by CEGUI::FrameComponent::doBackgroundRender(), CEGUI::ComponentArea::getPixelRect(), CEGUI::PropertyDim::getValue_impl(), CEGUI::SectionSpecification::initColourRectForOverride(), CEGUI::FalagardComponentBase::initColoursRect(), CEGUI::ImagerySection::initMasterColourRect(), CEGUI::TextComponent::render_impl(), and CEGUI::ImageryComponent::render_impl().

String CEGUI::PropertySet::getPropertyDefault const String name  )  const
 

Returns the default value of a Property as a String.

Parameters:
name String containing the name of the Property who's default string is to be returned.
Returns:
String object containing a textual representation of the default value for this property.

Definition at line 156 of file CEGUIPropertySet.cpp.

const String & CEGUI::PropertySet::getPropertyHelp const String name  )  const
 

Return the help text for the specified Property.

Parameters:
name String holding the name of the Property who's help text is to be returned.
Returns:
String object containing the help text for the Property name.
Exceptions:
UnknownObjectException Thrown if no Property named name is in the PropertySet.

Definition at line 84 of file CEGUIPropertySet.cpp.

bool CEGUI::PropertySet::isPropertyDefault const String name  )  const
 

Returns whether a Property is at it's default value.

Parameters:
name String containing the name of the Property who's default state is to be tested.
Returns:
  • true if the property has it's default value.
  • false if the property has been modified from it's default value.

Definition at line 140 of file CEGUIPropertySet.cpp.

bool CEGUI::PropertySet::isPropertyPresent const String name  )  const
 

Checks to see if a Property with the given name is in the PropertySet.

Parameters:
name String containing the name of the Property to check for.
Returns:
true if a Property named name is in the PropertySet. false if no Property named name is in the PropertySet.

Definition at line 76 of file CEGUIPropertySet.cpp.

void CEGUI::PropertySet::removeProperty const String name  ) 
 

Removes a Property from the PropertySet.

Parameters:
name String containing the name of the Property to be removed. If Property name is not in the set, nothing happens.
Returns:
Nothing.

Definition at line 55 of file CEGUIPropertySet.cpp.

void CEGUI::PropertySet::setProperty const String name,
const String value
 

Sets the current value of a Property.

Parameters:
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
Returns:
Nothing
Exceptions:
UnknownObjectException Thrown if no Property named name is in the PropertySet.
InvalidRequestException Thrown when the Property was unable to interpret the content of value.

Definition at line 114 of file CEGUIPropertySet.cpp.

Referenced by CEGUI::PropertyInitialiser::apply(), CEGUI::GUILayout_xmlHandler::elementStart(), and CEGUI::WidgetLookFeel::initialiseWidget().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:06:44 2005 for Crazy Eddies GUI System by  doxygen 1.4.3