 MezzanineEngine |
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
MezzanineEngine |
A class that store's a named set of settings for an object. More...
#include <objectsettings.h>
Inheritance diagram for Mezzanine::ObjectSettingSet: Collaboration diagram for Mezzanine::ObjectSettingSet:Public Types | |
| typedef SettingsMap::const_iterator | ConstSettingsIterator |
| Const Iterator type for settings stored by this class. | |
| typedef SettingsMap::iterator | SettingsIterator |
| Iterator type for settings stored by this class. | |
| typedef std::map< String, String > | SettingsMap |
| Basic container type for settings stored as name-value pairs in this class. | |
| Public Types inherited from Mezzanine::ObjectSettingSetContainer | |
|
typedef SubSetVector::const_iterator | ConstSubSetIterator |
| Const Iterator type for ObjectSettingSet instances stored by this class. | |
| typedef SubSetVector::iterator | SubSetIterator |
| Iterator type for ObjectSettingSet instances stored by this class. | |
|
typedef std::vector < ObjectSettingSet * > | SubSetVector |
| Basic container type for ObjectSettingSet storage by this class. | |
Public Member Functions | |
| ObjectSettingSet (const String &Name) | |
| Class constructor. More... | |
| virtual | ~ObjectSettingSet () |
| Class destructor. | |
| void | _MarkUpdated () |
| Marks this container and relevant parent containers as updated. More... | |
| ObjectSettingSetContainer * | GetParentSetOrGroup () const |
| Gets the Parent SettingsSet to this set. More... | |
| String | GetSettingValue (const String &SettingName) const |
| Gets a String representing the Value currently assigned to the existing setting. More... | |
| void | SetSettingValue (const String &SettingName, const String &StringValue) |
| Sets a setting in this set...of settings. More... | |
| SettingsIterator | SettingsBegin () |
| Gets an iterator to the first setting in this set. | |
| ConstSettingsIterator | SettingsBegin () const |
| Gets a const iterator to the first setting in this set. | |
| SettingsIterator | SettingsEnd () |
| Gets an iterator to one passed the last setting in this set. | |
| ConstSettingsIterator | SettingsEnd () const |
| Gets a const iterator to one passed the last setting in this set. | |
| Public Member Functions inherited from Mezzanine::ObjectSettingSetContainer | |
| ObjectSettingSetContainer (const String &Name) | |
| Class constructor. More... | |
| virtual | ~ObjectSettingSetContainer () |
| Class destructor. | |
| virtual void | AddChildObjectSettingSet (ObjectSettingSet *ToBeAdded) |
| Adds a SettingSet as a child of this container. More... | |
| virtual ObjectSettingSet * | CreateChildObjectSettingSet (const String &Name) |
| Creates a new SettingSet as a child of this container. More... | |
| void | DestroyAllObjectSettingSets () |
| Destroys all child Sub-Sets of this container. | |
| void | DestroyChildObjectSettingSet (const String &Name) |
| Destroys a Sub-Set of this container. More... | |
| ObjectSettingSet * | GetChildObjectSettingSet (const String &Name, UInt16 Which=0) const |
| Gets a Sub-Set of this container by name. More... | |
| ObjectSettingSet * | GetChildObjectSettingSet (const Whole &Index) const |
| Gets a Sub-Set of this container by index. More... | |
| ConstString & | GetName () const |
| Gets the name of this container. More... | |
| virtual void | RemoveChildObjectSettingSet (ObjectSettingSet *ToBeRemoved) |
| Removes a Sub-Set of this container. More... | |
| void | SetName (const String &Name) |
| Sets the name of this container. More... | |
| SubSetIterator | SubSetBegin () |
| Gets an iterator to the first subset of settings in this set. | |
| ConstSubSetIterator | SubSetBegin () const |
| Gets a const iterator to the first subset of settings in this set. | |
| SubSetIterator | SubSetEnd () |
| Gets an iterator to one passed the last subset of settings in this set. | |
| ConstSubSetIterator | SubSetEnd () const |
| Gets a const iterator to one passed the last subset of settings in this set. | |
Protected Attributes | |
| ObjectSettingSetContainer * | ParentSetOrGroup |
| A pointer to the parent container of this ObjectSettingSet. More... | |
| SettingsMap | Settings |
| A map container storing the settings owned by this set and their values. More... | |
| Protected Attributes inherited from Mezzanine::ObjectSettingSetContainer | |
| String | ContainerName |
| The name of this container. More... | |
| SubSetVector | SubSets |
| A container of ObjectSettingSet instances owned by this container. More... | |
Friends | |
| class | ObjectSettingSetContainer |
A class that store's a named set of settings for an object.
Definition at line 154 of file objectsettings.h.
| Mezzanine::ObjectSettingSet::ObjectSettingSet | ( | const String & | Name) |
Class constructor.
| Name | The name of this set. |
Definition at line 159 of file objectsettings.cpp.
|
virtual |
Marks this container and relevant parent containers as updated.
Implements Mezzanine::ObjectSettingSetContainer.
Definition at line 204 of file objectsettings.cpp.
| ObjectSettingSetContainer * Mezzanine::ObjectSettingSet::GetParentSetOrGroup | ( | ) | const |
Gets the Parent SettingsSet to this set.
Definition at line 170 of file objectsettings.cpp.
Gets a String representing the Value currently assigned to the existing setting.
| SettingName | The name of the setting desired. |
Definition at line 182 of file objectsettings.cpp.
| void Mezzanine::ObjectSettingSet::SetSettingValue | ( | const String & | SettingName, |
| const String & | StringValue | ||
| ) |
Sets a setting in this set...of settings.
| SettingName | The name of the new setting. |
| StringValue | A String containing the value to be given to this setting. |
Definition at line 176 of file objectsettings.cpp.
|
protected |
A pointer to the parent container of this ObjectSettingSet.
Definition at line 170 of file objectsettings.h.
|
protected |
A map container storing the settings owned by this set and their values.
Definition at line 167 of file objectsettings.h.
1.8.4