makVrv::DtKeyMapSettingsBackup Class Reference

Backup for Keymap Settings. More...

Inheritance diagram for makVrv::DtKeyMapSettingsBackup:

Public Member Functions
	DtKeyMapSettingsBackup (DtKeyMapManager &man, const std::string &keyMap)
	CTOR. More...
virtual	~DtKeyMapSettingsBackup ()
	DTOR. More...
virtual void	restore (const DtSettingsBackup *from)
	Restore key map from backup. More...
virtual std::string	backupClassType () const
	Returns the key map name. More...
virtual std::string	backupName () const
	Returns the key map name. More...
virtual DtSettingsBackup *	create () const
	Create the keymap backup. More...
virtual void	write (boost::archive::xml_oarchive &ar)
	Write the key map backup. More...
virtual void	read (boost::archive::xml_iarchive &ar)
	Read the keymap backup. More...
const makArchives::DtKeyMapRecord &	restoredRecord () const
	Return the backup's restored record. More...
Public Member Functions inherited from makVrv::DtSettingsBackup
	DtSettingsBackup ()
	CTOR. More...
virtual	~DtSettingsBackup ()
	DTOR. More...
virtual bool	createAndWriteToBackupFile (const std::ostringstream &str, const std::string &path)
	Creates a backup file on the specified path and writes to that backup file given the string stream which contains the stored buffer. More...
virtual bool	createAndWriteToBackupFiles (const std::vector< std::ostringstream * > &str, const std::string &path, const std::vector< std::string > &fileNames)
const std::string &	backupFile () const
	Get the name of the backup file. More...
virtual bool	backupFileExists () const
	Returns true if the file can be restored from a local backup. More...
virtual bool	backupDirExists () const
	Returns true if the file can be restored from a local backup directory. More...
virtual bool	factoryFileExists () const
	Returns true if can be restored from factory. More...
virtual bool	factoryDirExists () const
	Returns true if can be restored from factory directory. More...
virtual void	backup ()
	Backs up settings to backup file. More...
virtual void	backupByDir ()
	Backs up settings to backup directory. More...
virtual void	deleteBackup ()
	If backup file exists, deletes it. More...
virtual void	restore (bool fromFactory=false)
	Restore all. More...
virtual void	getRestorableNames (NameList &names)
	Get the names of states restore will affect. More...
virtual void	restore (bool fromFactory, bool selectedOnly)
	Restore the state, either from the backup (default) or from the factory. More...
virtual void	restoreSelected (const DtSettingsBackup *)
	Called with the object that needs to be restored from. More...
virtual void	writeDir (std::vector< std::ostringstream * > &outStreamVec, std::vector< std::string > &fileNames)
	Support for writing settings to files in a directory. More...
virtual void	readIncremental (boost::archive::xml_iarchive &ar)
	Support for reading files from a directory by looping over files and incrementally adding their contents. More...
void	setManagerDestroyed (bool b)
	If true, will not signal destroyed. More...
virtual void	addRestoreWhenRestored (DtSettingsBackup *, const RestoreFlags &f=RestoreAll)
	Sets to restore the specified object when this object is restored. More...
const RestoreWhenRestored &	restoreWhenRestored () const
virtual void	cancelRestoreWhenRestored (DtSettingsBackup *, const RestoreFlags &f=RestoreAll)
	Cancels that the specified object should be restored when this one is restored. More...
void	setBackupsPath (const std::string &s)
const std::string &	backupsPath () const
void	setFactoryFile (const std::string &s)
const std::string &	factoryFile () const
void	setFactoryDir (const std::string &dir)
const std::string &	factoryDir () const
void	setBackupDir (const std::string &dir)
const std::string &	backupDir () const
Public Member Functions inherited from makVrv::DtBackupInterface
	DtBackupInterface ()
	Default CTOR. More...
virtual	~DtBackupInterface ()
	Default DTOR. More...

Protected Attributes
std::string	myKeyMap
makArchives::DtKeyMapRecord	myRestoredRecord
DtKeyMapManager &	myKeyMapManager
Protected Attributes inherited from makVrv::DtSettingsBackup
bool	myManagerDestroyed
RestoreWhenRestored	myRestoreWhenRestored
std::string	myBackupFile
std::string	myFactoryFile
std::string	myBackupsPath
std::string	myBackupDir
std::string	myFactoryDir

Additional Inherited Members
Public Types inherited from makVrv::DtSettingsBackup
enum	RestoreFlags { RestoreFromFactory = 0x00000001, RestoreFromLocal = 0x00000002, KeepRestoreFromLocal = 0x80000000, RestoreAll = RestoreFromFactory | RestoreFromLocal }
typedef std::map < DtSettingsBackup *, int >	RestoreWhenRestored
Public Types inherited from makVrv::DtBackupInterface
typedef std::vector< std::string >	NameList
Public Attributes inherited from makVrv::DtSettingsBackup
boost::signal< void(const DtSettingsBackup *)>	signal_destructing
	Called when destructing. More...
boost::signal< void(const DtSettingsBackup *)>	signal_backupCleared
boost::signal< void(const DtSettingsBackup *)>	signal_backedUp
boost::signal< void(const DtSettingsBackup *)>	signal_restored
Public Attributes inherited from makVrv::DtBackupInterface
boost::signal< void(DtBackupInterface *)>	signal_backupFileChanged
	This signal should be emitted when the backup file is created, written to, or destroyed. More...
Protected Member Functions inherited from makVrv::DtSettingsBackup
virtual bool	restore (bool fromFactory, std::vector< DtSettingsBackup * > &hasBeenRestored, bool selectedOnly)
	Restores from startup (false) or factory (true) file. More...

Detailed Description

Backup for Keymap Settings.

Constructor & Destructor Documentation

makVrv::DtKeyMapSettingsBackup::DtKeyMapSettingsBackup	(	DtKeyMapManager &	man,
		const std::string &	keyMap
	)

CTOR.

virtual makVrv::DtKeyMapSettingsBackup::~DtKeyMapSettingsBackup ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtKeyMapSettingsBackup::restore ( const DtSettingsBackup *  from )

virtual

Restore key map from backup.

Implements makVrv::DtSettingsBackup.

virtual std::string makVrv::DtKeyMapSettingsBackup::backupClassType ( ) const

inlinevirtual

Returns the key map name.

Implements makVrv::DtSettingsBackup.

virtual std::string makVrv::DtKeyMapSettingsBackup::backupName ( ) const

inlinevirtual

Returns the key map name.

Reimplemented from makVrv::DtSettingsBackup.

virtual DtSettingsBackup* makVrv::DtKeyMapSettingsBackup::create ( ) const

virtual

Create the keymap backup.

Implements makVrv::DtSettingsBackup.

virtual void makVrv::DtKeyMapSettingsBackup::write ( boost::archive::xml_oarchive &  ar )

virtual

Write the key map backup.

Implements makVrv::DtSettingsBackup.

virtual void makVrv::DtKeyMapSettingsBackup::read ( boost::archive::xml_iarchive &  ar )

virtual

Read the keymap backup.

Implements makVrv::DtSettingsBackup.

const makArchives::DtKeyMapRecord& makVrv::DtKeyMapSettingsBackup::restoredRecord ( ) const

inline

Return the backup's restored record.

Member Data Documentation

std::string makVrv::DtKeyMapSettingsBackup::myKeyMap

protected

makArchives::DtKeyMapRecord makVrv::DtKeyMapSettingsBackup::myRestoredRecord

protected

DtKeyMapManager& makVrv::DtKeyMapSettingsBackup::myKeyMapManager

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtKeyMapManager.h