CFxSettings Class Reference

#include <FxSettings.h>

Public Types
enum	ValueType {   kRegNone , kRegInt32 , kRegInt64 , kRegDouble ,   kRegString , kRegBinaryData }

Public Member Functions
virtual	~CFxSettings ()
virtual bool	HasGroup (const CFxString &group)=0
virtual bool	HasKey (const CFxString &group, const CFxString &key)=0
virtual CFxStringArray	GetGroups (const CFxString &group)=0
virtual CFxStringArray	GetKeys (const CFxString &group)=0
virtual ValueType	GetType (const CFxString &group, const CFxString &key)=0
virtual OdResBufPtr	Read (const CFxString &group, const CFxString &key, ValueType defaultType)=0
virtual void	Write (const CFxString &group, const CFxString &key, OdResBufPtr value)=0
virtual void	RemoveKey (const CFxString &group, const CFxString &key)=0
virtual void	RemoveGroup (const CFxString &group)=0

Detailed Description

Description: Manages the settings. Library: DDKERNEL

Definition at line 34 of file FxSettings.h.

Member Enumeration Documentation

ValueType

enum CFxSettings::ValueType

Description:

Enumerator
kRegNone
kRegInt32
kRegInt64
kRegDouble
kRegString
kRegBinaryData

Definition at line 61 of file FxSettings.h.

Constructor & Destructor Documentation

~CFxSettings()

virtual CFxSettings::~CFxSettings ( )

inlinevirtual

Definition at line 38 of file FxSettings.h.

Member Function Documentation

GetGroups()

virtual CFxStringArray CFxSettings::GetGroups ( const CFxString &  group )

pure virtual

Description: Returns child groups for specified group.

GetKeys()

virtual CFxStringArray CFxSettings::GetKeys ( const CFxString &  group )

pure virtual

Description: Returns child keys for specified group.

GetType()

virtual ValueType CFxSettings::GetType ( const CFxString &  group, const CFxString &  key  )

pure virtual

Description: Returns kRegNone in case key does not exist.

HasGroup()

virtual bool CFxSettings::HasGroup ( const CFxString &  group )

pure virtual

Description: Returns true if specified group exists in the settings

HasKey()

virtual bool CFxSettings::HasKey ( const CFxString &  group, const CFxString &  key  )

pure virtual

Description:

Read()

virtual OdResBufPtr CFxSettings::Read ( const CFxString &  group, const CFxString &  key, ValueType  defaultType  )

pure virtual

Description: Return buffer is always not null. In case 'key' does not exist result buffer is set to default value according to 'defaultType' value. Parameter 'defaultType' must not be equal to kRegNone.

RemoveGroup()

virtual void CFxSettings::RemoveGroup ( const CFxString &  group )

pure virtual

Description: Removes group.

RemoveKey()

virtual void CFxSettings::RemoveKey ( const CFxString &  group, const CFxString &  key  )

pure virtual

Description: Removes key and all its sub-keys.

Write()

virtual void CFxSettings::Write ( const CFxString &  group, const CFxString &  key, OdResBufPtr  value  )

pure virtual

Description: Types of buffer 'value' are limited to corresponding types in 'ValueType' enum. In case type of invalid type nothing is written.

---

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

• FxSettings.h