CGridListCtrlEx
Classes | Public Member Functions | Protected Attributes | List of all members
CViewConfigSectionDefault Class Reference

Abstract interface for persisting view configuration, that can use an in-memory default-configuration. More...

Inheritance diagram for CViewConfigSectionDefault:
CViewConfigSection CViewConfigSectionProfiles CViewConfigSectionWinApp

Classes

class  CViewConfigSectionLocal
 Inner class that stores the default configuration in memory. More...
 

Public Member Functions

 CViewConfigSectionDefault (const CString &strViewName)
 CViewConfigSectionDefault - Constructor. More...
 
virtual CViewConfigSectionGetDefaultConfig ()
 Retrieve the in memory default configuration. More...
 
virtual bool HasDefaultConfig () const
 Contains default configuration. More...
 
virtual void ResetConfigDefault ()
 Resets the current configuration by deleting it and restoring it from the in memory default configuration. More...
 
virtual CString GetSetting (const CString &strName, const CString &strDefval=_T("")) const
 Retrieves a setting value for the view. More...
 
- Public Member Functions inherited from CViewConfigSection
 CViewConfigSection (const CString &strViewName)
 CViewConfigSection - Constructor. More...
 
virtual ~CViewConfigSection ()
 CViewConfigSection - Destructor.
 
virtual bool GetBoolSetting (const CString &strName, bool bDefval=false) const
 Retrieves a bool setting value for the view. More...
 
virtual int GetIntSetting (const CString &strName, int nDefval=0) const
 Retrieves an integer setting value for the view. More...
 
virtual double GetFloatSetting (const CString &strName, double nDefval=0.0) const
 Retrieves a float setting value for the view. More...
 
virtual LOGFONT GetLogFontSetting (const CString &strName) const
 Retrieves a font setting value for the view. More...
 
virtual CRect GetRectSetting (const CString &strName, const CRect &rectDefval=CRect(0, 0, 0, 0)) const
 Retrieves a rectangle setting value for the view. More...
 
virtual COLORREF GetColorSetting (const CString &strName, const COLORREF colorDefval=RGB(0, 0, 0)) const
 Retrieves a color setting value for the view. More...
 
virtual void GetArraySetting (const CString &strName, CSimpleArray< CString > &values, const CString &strDelimiter=_T(", ")) const
 Retrieves a string-array setting value for the view. More...
 
virtual void GetArraySetting (const CString &strName, CSimpleArray< int > &values, const CString &strDelimiter=_T(", ")) const
 Retrieves a integer-array setting value for the view. More...
 
virtual void SetSetting (const CString &strName, const CString &strValue)
 Updates a setting value for the view. More...
 
virtual void SetBoolSetting (const CString &strName, bool bValue)
 Updates the value of a bool setting. More...
 
virtual void SetIntSetting (const CString &strName, int nValue)
 Updates the value of an integer setting. More...
 
virtual void SetFloatSetting (const CString &strName, double nValue, int nDecimals=6)
 Updates the value of a float setting. More...
 
virtual void SetArraySetting (const CString &strName, const CSimpleArray< CString > &values, const CString &strDelimiter=_T(", "))
 Updates the value of a string-array setting. More...
 
virtual void SetArraySetting (const CString &strName, const CSimpleArray< int > &values, const CString &strDelimiter=_T(", "))
 Updates the value of an integer-array setting. More...
 
virtual void SetLogFontSetting (const CString &strName, const LOGFONT &font)
 Updates the value of a font setting. More...
 
virtual void SetRectSetting (const CString &strName, const RECT &rect)
 Updates the value of a rectangle setting. More...
 
virtual void SetColorSetting (const CString &strName, COLORREF color)
 Updates the value of a color setting. More...
 
virtual void RemoveCurrentConfig ()
 Removes the current configuration.
 

Protected Attributes

CViewConfigSectionLocal m_DefaultConfig
 Default configuration stored in memory.
 
- Protected Attributes inherited from CViewConfigSection
CString m_ViewName
 Configuration name used when persisting the state (Translates into a section name)
 

Additional Inherited Members

- Protected Member Functions inherited from CViewConfigSection
virtual CString ReadSetting (const CString &strSection, const CString &strSetting, const CString &strDefval) const =0
 Pure virtual interface for reading setting from persisting layer.
 
virtual void WriteSetting (const CString &strSection, const CString &strSetting, const CString &strValue)=0
 Pure virtual interface for writing setting to persisting layer.
 
virtual void RemoveSection (const CString &strSection)=0
 Pure virtual interface for removing setting section from persisting layer.
 
virtual CString ConvertBoolSetting (bool bValue) const
 Converts a bool setting to a string value. More...
 
virtual CString ConvertIntSetting (int nValue) const
 Converts an integer setting to a string value. More...
 
virtual CString ConvertFloatSetting (double nValue, int nDecimals=6) const
 Converts a float setting to a string value. More...
 
virtual CString ConvertArraySetting (const CSimpleArray< CString > &values, const CString &strDelimiter=_T(", ")) const
 Converts a string-array setting value into a delimited string. More...
 
virtual CString ConvertArraySetting (const CSimpleArray< int > &values, const CString &strDelimiter=_T(", ")) const
 Converts an integer-array setting value into a delimited string. More...
 
virtual CString ConvertLogFontSetting (const LOGFONT &font) const
 Converts a font setting value into a delimited string. More...
 
virtual CString ConvertRectSetting (const RECT &rect) const
 Converts a rectangle setting value into a delimited string. More...
 
virtual CString ConvertColorSetting (COLORREF color) const
 Converts a color setting value into a delimited string. More...
 
virtual void SplitArraySetting (const CString &strArray, CSimpleArray< CString > &values, const CString &strDelimiter=_T(", ")) const
 Splits a delimited string into a string-array. More...
 
virtual const CString & GetSectionName () const
 Retrieves the current section name to store the settings. More...
 

Detailed Description

Abstract interface for persisting view configuration, that can use an in-memory default-configuration.

It will use the values in the default-config if nothing else can be found

Constructor & Destructor Documentation

CViewConfigSectionDefault::CViewConfigSectionDefault ( const CString &  strViewName)
explicit

CViewConfigSectionDefault - Constructor.

Parameters
strViewNameName to identify and persist the configuration

Member Function Documentation

CViewConfigSection & CViewConfigSectionDefault::GetDefaultConfig ( )
virtual

Retrieve the in memory default configuration.

Returns
Default configuration
CString CViewConfigSectionDefault::GetSetting ( const CString &  strName,
const CString &  strDefval = _T("") 
) const
virtual

Retrieves a setting value for the view.

If the value is not available then it returns the value from the default configuration.

Parameters
strNameName of setting
strDefvalDefault value to return if no value was found
Returns
Value of the setting

Reimplemented from CViewConfigSection.

bool CViewConfigSectionDefault::HasDefaultConfig ( ) const
virtual

Contains default configuration.

Returns
Default configuration available (true/false)
void CViewConfigSectionDefault::ResetConfigDefault ( )
virtual

Resets the current configuration by deleting it and restoring it from the in memory default configuration.