zeus::TSettingsManager::TUserData Class Reference

#include <SettingsManager.h>

Inheritance diagram for zeus::TSettingsManager::TUserData:

List of all members.

Public Member Functions
	TUserData ()
virtual	~TUserData ()
Retval	commit ()
void	getPropertyNamesByNameSpace (const IString &rNameSpace, IStringList &rList) const
void	getPropertyNamesByNameSpace (const wchar_t *pNameSpace, IStringList &rList) const
Retval	readBool (const IString &rKey, bool &rValue, bool bDefault=false)
Retval	readInt (const IString &rKey, Int &rValue, Int iDefault=0)
Retval	readUint (const IString &rKey, Uint &rValue, Uint uiDefault=0)
Retval	readFloat (const IString &rKey, Float &rValue, Float fDefault=0.0)
Retval	readString (const IString &rKey, IString &rValue, TString strDefault=L"")
Retval	readBool (const wchar_t *pKey, bool &rValue, bool bDefault=false)
Retval	readInt (const wchar_t *pKey, Int &rValue, Int iDefault=0)
Retval	readUint (const wchar_t *pKey, Uint &rValue, Uint uiDefault=0)
Retval	readFloat (const wchar_t *pKey, Float &rValue, Float fDefault=0.0)
Retval	readString (const wchar_t *pKey, IString &rValue, TString strDefault=L"")
Retval	writeBool (const IString &rKey, bool bValue)
Retval	writeInt (const IString &rKey, Int iValue)
Retval	writeUint (const IString &rKey, Uint uiValue)
Retval	writeFloat (const IString &rKey, Float fValue)
Retval	writeString (const IString &rKey, const IString &rValue)
Retval	writeBool (const wchar_t *pKey, bool bValue)
Retval	writeInt (const wchar_t *pKey, Int iValue)
Retval	writeUint (const wchar_t *pKey, Uint uiValue)
Retval	writeFloat (const wchar_t *pKey, Float fValue)
Retval	writeString (const wchar_t *pKey, const IString &rValue)
Retval	getUserDataNode (const IString &rName, IXMLNode *&rpNode)
void	setDocument (NAMESPACE_Zeus::IXMLDocument &rDocument)
void	releaseDocument ()

---

Detailed Description

Sub class to read user data

---

Constructor & Destructor Documentation

TSettingsManager::TUserData::TUserData

(

)

Creates the user data object

TSettingsManager::TUserData::~TUserData

(

)

[virtual]

Destroys the user data object

---

Member Function Documentation

Retval TSettingsManager::TUserData::commit

(

)

stores the data back to the XML file

void TSettingsManager::TUserData::getPropertyNamesByNameSpace	(	const IString &	rNameSpace,
		IStringList &	rList
	)		const

Returns the list of user settings starting with a given namespace

Parameters:

rNameSpace	: Name space of the requested settings
rList	: return parameter of the setting keys starting with the given namespace

void zeus::TSettingsManager::TUserData::getPropertyNamesByNameSpace	(	const wchar_t *	pNameSpace,
		IStringList &	rList
	)		const [inline]

Returns the list of user settings starting with a given namespace

Retval TSettingsManager::TUserData::getUserDataNode	(	const IString &	rName,
		IXMLNode *&	rpNode
	)

Returns the user data node

Retval zeus::TSettingsManager::TUserData::readBool	(	const IString &	rKey,
		bool &	rValue,
		bool	bDefault = false
	)		[inline]

reads a bool value out of the xml document

Parameters:

rKey	: Key to read
rValue	: return parameter
bDefault	: Default value

Return values:

RET_NOERROR	: Value assigned
RET_REQUEST_FAILED	: Could not assign value (default assigned)

Retval zeus::TSettingsManager::TUserData::readBool	(	const wchar_t *	pKey,
		bool &	rValue,
		bool	bDefault = false
	)		[inline]

Retval zeus::TSettingsManager::TUserData::readFloat	(	const wchar_t *	pKey,
		Float &	rValue,
		Float	fDefault = 0.0
	)		[inline]

Retval zeus::TSettingsManager::TUserData::readFloat	(	const IString &	rKey,
		Float &	rValue,
		Float	fDefault = 0.0
	)		[inline]

reads a float value out of the xml document

Parameters:

rKey	: Key to read
rValue	: return parameter
fDefault	: Default value

Return values:

RET_NOERROR	: Value assigned
RET_REQUEST_FAILED	: Could not assign value (default assigned)

Retval zeus::TSettingsManager::TUserData::readInt	(	const IString &	rKey,
		Int &	rValue,
		Int	iDefault = 0
	)		[inline]

reads an integer value out of the xml document

Parameters:

rKey	: Key to read
rValue	: return parameter
iDefault	: Default value

Return values:

RET_NOERROR	: Value assigned
RET_REQUEST_FAILED	: Could not assign value (default assigned)

Retval zeus::TSettingsManager::TUserData::readInt	(	const wchar_t *	pKey,
		Int &	rValue,
		Int	iDefault = 0
	)		[inline]

Retval TSettingsManager::TUserData::readString	(	const IString &	rKey,
		IString &	rValue,
		TString	strDefault = L""
	)

reads a string value out of the xml document

Parameters:

rKey	: Key to read
rValue	: return parameter
strDefault	: Default value

Return values:

RET_NOERROR	: Value assigned
RET_REQUEST_FAILED	: Could not assign value (default assigned)

Retval zeus::TSettingsManager::TUserData::readString	(	const wchar_t *	pKey,
		IString &	rValue,
		TString	strDefault = L""
	)		[inline]

Retval zeus::TSettingsManager::TUserData::readUint	(	const wchar_t *	pKey,
		Uint &	rValue,
		Uint	uiDefault = 0
	)		[inline]

Retval zeus::TSettingsManager::TUserData::readUint	(	const IString &	rKey,
		Uint &	rValue,
		Uint	uiDefault = 0
	)		[inline]

reads an unsigned integer value out of the xml document

Parameters:

rKey	: Key to read
rValue	: return parameter
uiDefault	: Default value

Return values:

RET_NOERROR	: Value assigned
RET_REQUEST_FAILED	: Could not assign value (default assigned)

void TSettingsManager::TUserData::releaseDocument

(

)

Releases the document

void TSettingsManager::TUserData::setDocument

(

NAMESPACE_Zeus::IXMLDocument &

rDocument )

sets a new XML document to the

Retval zeus::TSettingsManager::TUserData::writeBool	(	const wchar_t *	pKey,
		bool	bValue
	)		[inline]

Retval zeus::TSettingsManager::TUserData::writeBool	(	const IString &	rKey,
		bool	bValue
	)		[inline]

writes a bool value to the xml document

Parameters:

rKey	: Key to read
bValue	: Value to set

Return values:

RET_NOERROR	: Value set
RET_REQUEST_FAILED	: Could not set value

Retval zeus::TSettingsManager::TUserData::writeFloat	(	const IString &	rKey,
		Float	fValue
	)		[inline]

writes a float value to the xml document

Parameters:

rKey	: Key to read
fValue	: Value to set

Return values:

RET_NOERROR	: Value set
RET_REQUEST_FAILED	: Could not set value

Retval zeus::TSettingsManager::TUserData::writeFloat	(	const wchar_t *	pKey,
		Float	fValue
	)		[inline]

Retval zeus::TSettingsManager::TUserData::writeInt	(	const IString &	rKey,
		Int	iValue
	)		[inline]

writes an integer value to the xml document

Parameters:

rKey	: Key to read
iValue	: Value to set

Return values:

RET_NOERROR	: Value set
RET_REQUEST_FAILED	: Could not set value

Retval zeus::TSettingsManager::TUserData::writeInt	(	const wchar_t *	pKey,
		Int	iValue
	)		[inline]

Retval TSettingsManager::TUserData::writeString	(	const IString &	rKey,
		const IString &	rValue
	)

writes a string value to the xml document

Parameters:

rKey	: Key to read
rValue	: Value to set

Return values:

RET_NOERROR	: Value set
RET_REQUEST_FAILED	: Could not set value

Retval zeus::TSettingsManager::TUserData::writeString	(	const wchar_t *	pKey,
		const IString &	rValue
	)		[inline]

Retval zeus::TSettingsManager::TUserData::writeUint	(	const IString &	rKey,
		Uint	uiValue
	)		[inline]

writes an unsigned integer value to the xml document

Parameters:

rKey	: Key to read
uiValue	: Value to set

Return values:

RET_NOERROR	: Value set
RET_REQUEST_FAILED	: Could not set value

Retval zeus::TSettingsManager::TUserData::writeUint	(	const wchar_t *	pKey,
		Uint	uiValue
	)		[inline]

---

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

• SettingsManager.h
• SettingsManager.cpp