CSettingsHolder Class Reference

#include <SettingHolder.h>

Inheritance diagram for CSettingsHolder:

[legend]List of all members.

Public Member Functions
	CSettingsHolder (long SetMessage)
long	GetNumSettings ()
ISetting *	GetSetting (long SettingIndex)
virtual void	CreateSettings (LPCSTR IniSection)=0
void	ReadFromIni ()
void	WriteToIni (BOOL bOptimizeFileAccess)
void	AddSetting (ISetting *pSetting)
void	AddSetting (SETTING *pSetting, CSettingGroup *pGroup=NULL)
void	DisableOnChange ()
void	EnableOnChange ()
void	ClearSettingList (BOOL bDeleteSettings=TRUE, BOOL bWriteSettings=FALSE)
int	LoadSettingStructures (SETTING *pSetting, int StartNum, int Num, CSettingGroup *pGroup=NULL)
LONG	HandleSettingsMessage (HWND hWnd, UINT message, UINT wParam, LONG lParam, BOOL *bHandled)
CSettingGroup *	GetSettingsGroup (LPCSTR szDisplayName, DWORD Flags=0, BOOL IsActiveByDefault=FALSE)
Protected Member Functions
BOOL	RegisterMe ()
Protected Attributes
vector< ISetting * >	m_Settings
long	m_SetMessage
BOOL	m_pRegistered
string	m_SettingFlagsSection

---

Detailed Description

Base class for any class that needs acesss to a list of ISetting settings. The function CreateSettings should be overriden and then called in the constructor of the derived class.

---

Member Function Documentation

void CSettingsHolder::AddSetting (  ISetting *  pSetting  )

Add a settings to the list. Makes sure there are no duplicates.

void CSettingsHolder::DisableOnChange (   )

Disable all OnChange calls if a value of a setting is changed.

void CSettingsHolder::EnableOnChange (   )

Enable all OnChange calls

long CSettingsHolder::GetNumSettings (   )

Number of settings in the list.

ISetting * CSettingsHolder::GetSetting (  long  SettingIndex  )

Get setting at index SettingsIndex.

CSettingGroup * CSettingsHolder::GetSettingsGroup (  LPCSTR  szName, DWORD  Flags = 0, BOOL  IsActiveByDefault = FALSE )

Get/Create a root group from the settingsmaster. The SettingObject the group belongs to is the SettingHolder itself.

LONG CSettingsHolder::HandleSettingsMessage (  HWND  hWnd, UINT  message, UINT  wParam, LONG  lParam, BOOL *  bHandled )

Handles WM_xx_SETVALUE/WM_xx_GETVALUE/WM_xx_CHANGEVALUE window messages. Only if the message offset specified at initialization is not 0.

int CSettingsHolder::LoadSettingStructures (  SETTING *  pSetting, int  StartNum, int  Num, CSettingGroup *  pGroup = NULL )

Adds an array of SETTING structures to the SettingHolder. Optionally specify a default SettingGroup

void CSettingsHolder::ReadFromIni (   )

Reads alls settings of the list from the .ini file.

BOOL CSettingsHolder::RegisterMe (   )  [protected]

Registers the SettingsHolder to the SettingsMaster. The SettingsMaster receives source/input/format & channel change events and read&writes the proper settings from/to the SettingsHolders.

void CSettingsHolder::WriteToIni (  BOOL  bOptimizeFileAccess  )

Writes alls settings of the list to the .ini file.

---

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

• SettingHolder.h
• SettingHolder.cpp

---