MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
Mezzanine::ObjectSettingFile Class Reference

This class represents a file to be saved containing one or more OhjectSettingGroup's. More...

#include <objectsettings.h>

+ Collaboration diagram for Mezzanine::ObjectSettingFile:

Public Types

typedef
SaveGroupsContainer::const_iterator 
ConstSaveGroupsIterator
 Const Iterator type for ObjectSettingGroup instances stored by this class.
 
typedef std::vector
< ObjectSettingGroup * > 
SaveGroupsContainer
 Basic container type for ObjectSettingGroup storage by this class.
 
typedef
SaveGroupsContainer::iterator 
SaveGroupsIterator
 Iterator type for ObjectSettingGroup instances stored by this class.
 

Public Member Functions

 ObjectSettingFile (const String &FileName)
 Class constructor. More...
 
 ~ObjectSettingFile ()
 Class destructor.
 
void AddGroup (ObjectSettingGroup *Group)
 Adds a group to be saved to this file. More...
 
const StringGetFileName () const
 Gets the name of the file. More...
 
ObjectSettingGroupGetGroup (const String &Name) const
 Gets a group being saved to this file. More...
 
SaveGroupsContainerGetGroups ()
 Gets the container with the groups to be saved to this file. More...
 
Boolean GetNeedsSave () const
 Gets whether or not this file has been updated and needs to be saved. More...
 
void RemoveGroup (ObjectSettingGroup *Group)
 Removes a group from this file. More...
 
SaveGroupsIterator SaveGroupsBegin ()
 Gets an iterator to the first group in this file.
 
ConstSaveGroupsIterator SaveGroupsBegin () const
 Gets a const iterator to the first group in this file.
 
SaveGroupsIterator SaveGroupsEnd ()
 Gets an iterator to one-passed the last group in this file.
 
ConstSaveGroupsIterator SaveGroupsEnd () const
 Gets a const iterator to one-passed the last group in this file.
 
void SetNeedsSave (Boolean Save)
 Sets whether or not this file needs saving. More...
 

Protected Attributes

String File
 The name of the file the stored ObjectSettingGroup instances will be saved to. More...
 
Boolean NeedsSave
 Stores whether or not the settings have been updated and this file needs to be saved/refreshed. More...
 
SaveGroupsContainer SaveGroups
 A container of ObjectSettingGroup instances that will be saved to the file representing by this. More...
 

Detailed Description

This class represents a file to be saved containing one or more OhjectSettingGroup's.

Definition at line 261 of file objectsettings.h.

Constructor & Destructor Documentation

Mezzanine::ObjectSettingFile::ObjectSettingFile ( const String FileName)

Class constructor.

Parameters
FileNameThe name of the file the groups in this class will be saved to.

Definition at line 248 of file objectsettings.cpp.

Member Function Documentation

void Mezzanine::ObjectSettingFile::AddGroup ( ObjectSettingGroup Group)

Adds a group to be saved to this file.

Parameters
GroupThe group to be added to this file.

Definition at line 268 of file objectsettings.cpp.

const String & Mezzanine::ObjectSettingFile::GetFileName ( ) const

Gets the name of the file.

Returns
Returns a const reference to the name of this file.

Definition at line 259 of file objectsettings.cpp.

ObjectSettingGroup * Mezzanine::ObjectSettingFile::GetGroup ( const String Name) const

Gets a group being saved to this file.

Parameters
NameThe name of the group to get.
Returns
Returns a pointer to the named group in this file, or NULL if it does not exist in this file.

Definition at line 275 of file objectsettings.cpp.

ObjectSettingFile::SaveGroupsContainer & Mezzanine::ObjectSettingFile::GetGroups ( )

Gets the container with the groups to be saved to this file.

Returns
Returns a reference to the container containing all the groups that are to be saved to this file.

Definition at line 298 of file objectsettings.cpp.

Boolean Mezzanine::ObjectSettingFile::GetNeedsSave ( ) const

Gets whether or not this file has been updated and needs to be saved.

Returns
Returns true if this file needs to be saved, false otherwise.

Definition at line 265 of file objectsettings.cpp.

void Mezzanine::ObjectSettingFile::RemoveGroup ( ObjectSettingGroup Group)

Removes a group from this file.

Parameters
GroupThe group to be removed.

Definition at line 285 of file objectsettings.cpp.

void Mezzanine::ObjectSettingFile::SetNeedsSave ( Boolean  Save)

Sets whether or not this file needs saving.

Parameters
SaveWhetehr or not this file has been updated and needs to be saved.

Definition at line 262 of file objectsettings.cpp.

Member Data Documentation

String Mezzanine::ObjectSettingFile::File
protected

The name of the file the stored ObjectSettingGroup instances will be saved to.

Definition at line 276 of file objectsettings.h.

Boolean Mezzanine::ObjectSettingFile::NeedsSave
protected

Stores whether or not the settings have been updated and this file needs to be saved/refreshed.

Definition at line 279 of file objectsettings.h.

SaveGroupsContainer Mezzanine::ObjectSettingFile::SaveGroups
protected

A container of ObjectSettingGroup instances that will be saved to the file representing by this.

Definition at line 273 of file objectsettings.h.


The documentation for this class was generated from the following files: