Common base class for all types of settings managers. More...

Inheritance diagram for makVrv::DtCommonBaseSettingsManager< RecordType >:

Public Member Functions
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk.
virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR.
virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled.
virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager.
virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager.
virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record.
virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record.
virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object.
virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const).
Setting Persistence Methods
virtual void	loadDefaults ()
	Initializes the settings and creates a backup.
virtual void	initializeBackup ()=0
	Creates a backup of the settings' current state (abstract).
virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk).
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk.
virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file.
virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file.
virtual void	setFromRecord (const RecordType &record)=0
	Set the current settings' state from the given record (abstract).
virtual void	getRecord (RecordType &record) const =0
	Store the current settings' state in the given record (abstract).
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Protected Attributes
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Detailed Description

template<typename RecordType>
class makVrv::DtCommonBaseSettingsManager< RecordType >

Common base class for all types of settings managers.

This class provides the interface for creating settings managers with the large portion of the persistence logic handled by either this base class or specialized base classes for different types of settings managers. This template class takes the settings record class as a template parameter in order to perform default record lookups and the common save/load and import/export functionality.

Constructor & Destructor Documentation

template<typename RecordType>

makVrv::DtCommonBaseSettingsManager< RecordType >::DtCommonBaseSettingsManager	(	DtDe &	de,
		const std::string &	name,
		const std::string &	displayName,
		const std::string &	ext
	)

inline

CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk.

template<typename RecordType>

virtual makVrv::DtCommonBaseSettingsManager< RecordType >::~DtCommonBaseSettingsManager ( )

inlinevirtual

Virtual DTOR.

Member Function Documentation

template<typename RecordType>

virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::autoSaveIfNecessary ( )

inlinevirtual

Saves the current settings as defaults if autosave is enabled.

This method is mainly provided to make creating setters for individual settings easier, by wrapping the if check in this method.

Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::importSettings().

template<typename RecordType>

virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::setAutoSave ( bool doit )

inlinevirtual

Sets whether autosave is enabled for the settings manager.

If autosave is enabled, the settings will be saved as they're changed.

Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().

template<typename RecordType>

virtual bool makVrv::DtCommonBaseSettingsManager< RecordType >::autoSave ( ) const

inlinevirtual

Gets whether autosave is enabled for the settings manager.

If autosave is enabled, the settings will be saved as they're changed.

Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::autoSaveIfNecessary(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().

template<typename RecordType>

virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::setUseDefaultSettingsRecord ( bool useit )

inlinevirtual

Sets whether setting initialization should check for a default record.

If set and a default record is present, the settings manager will use that record instead of the default settings file from disk to initialize the settings.

template<typename RecordType>

virtual bool makVrv::DtCommonBaseSettingsManager< RecordType >::useDefaultSettingsRecord ( ) const

inlinevirtual

Gets whether setting initialization should check for a default record.

If set and a default record is present, the settings manager will use that record instead of the default settings file from disk to initialize the settings.

template<typename RecordType>

virtual DtDeSettings* makVrv::DtCommonBaseSettingsManager< RecordType >::settings ( )

inlinevirtual

Accessor for the manager's DtDeSettings object.

Exceptions

DtCorruptedState if the settings can't be found.

template<typename RecordType>

virtual const DtDeSettings* makVrv::DtCommonBaseSettingsManager< RecordType >::settings ( ) const

inlinevirtual

Accessor for the manager's DtDeSettings object (const).

Exceptions

DtCorruptedState if the settings can't be found.

template<typename RecordType>

virtual DtSettingsBackup* makVrv::DtCommonBaseSettingsManager< RecordType >::settingsBackup ( )

inlinevirtual

Accessor for the manager's settings backup.

template<typename RecordType>

virtual const DtSettingsBackup* makVrv::DtCommonBaseSettingsManager< RecordType >::settingsBackup ( ) const

inlinevirtual

Accessor for the manager's settings backup (const).

template<typename RecordType>

virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::loadDefaults ( )

inlinevirtual

Initializes the settings and creates a backup.

If the useDefaultSettingsRecord is enabled and a default record exists, the record will be used to initialize the settings. Otherwise, settings will be initialized from the default (or factory) record on disk.

template<typename RecordType>

virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::initializeBackup ( )

pure virtual

Creates a backup of the settings' current state (abstract).