Abstract interface for controlling persistence of state in a dialog. More...

Inheritance diagram for makVrv::DtPersistenceControlsInterface:

Public Member Functions
virtual	~DtPersistenceControlsInterface ()
	DTOR. More...

virtual void	queryImportFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Ask for a filename to import from fileFilter is the desired extension with no dot. More...

virtual void	queryMergeFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Ask for a filename to merge from fileFilter is the desired extension with no dot. More...

virtual void	queryExportFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Ask for a filename to export to fileFilter is the desired extension with no dot. More...

virtual std::string	queryExportFilePathString (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Ask for a filename to export to fileFilter is the desired extension with no dot. More...

virtual void	queryExportHierFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Ask for a filename to export the element definition hierarchy fileFilter is the desired extension with no dot. More...

virtual void	queryExportAllFilePaths (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Exports all hier and leaf files to their respective file locations. More...

virtual void	queryExportLeafFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)=0
	Ask for a filename to export the element definition leaves fileFilter is the desired extension with no dot. More...

virtual void	setSaveButtonShown (bool)=0
	Shows/hides save button. Default is hidden. More...

virtual void	setSeparatorShown (bool)=0
	Shows/hides horizontal separator. Default is shown. More...

virtual void	setMergeShown (bool)=0
	If true, shows merge button to allow merging of settings. More...

virtual void	setExportShown (bool)=0
	If true will export selected item(s) to a file. More...

virtual void	setImportShown (bool)=0
	If true will import settings. More...

virtual void	setExportEnabled (bool)=0
	Enable/diable export button. Default is enabled. More...

virtual void	setMergeEnabled (bool)=0
	If true, enabled merge button. More...

virtual void	setSaveDefaultsEnabled (bool)=0
	If true, enabled merge button. More...

virtual void	setImportEnabled (bool)=0
	If true will enable import settings. More...

virtual void	setExportSelectedEnabled (bool)=0
	Sets whether or not export selected is enabled. More...

virtual void	setBackupRestoreEnabled (bool)=0
	Sets whether or not the restore from backup button is enabled. More...

virtual void	setFactoryRestoreEnabled (bool)=0
	Sets whether or not the restore from factory button is enabled. More...

virtual void	setBackup (DtBackupInterface *backup, bool showFactoryButton)=0
	Sets the backup object that will be used to restore from. More...

virtual void	disableAllButtons (bool)=0
	Quick way to disable/enable all buttons. More...

virtual void	activateSaveDefaults ()=0
	Click the save defaults button (usually prompting on page exit) More...

virtual int	activateRememberToExport (bool &dontShowAgain)
	Remind user to export (usually prompting on page exit) with a checkbox allow user to not show it again dontShowAgain whether the user checked the "dont show again". More...

virtual bool	showImportLeavesFirstBox ()
	show the messabge box to remind the user to import leave before import hireachy(for entity,unit,tactical graphics) More...

Public Attributes
boost::signalslib::signal< void()>	signal_saveDefaults
	Signal emitted when the user wants to save to a default file. More...

boost::signalslib::signal< void()>	signal_restoreDefaults
	Signal emitted when the user wants to load the default file. More...

boost::signalslib::signal< void()>	signal_restoreFactoryDefaults
	Signal emitted when the user wants to load the factory settings file. More...

boost::signalslib::signal< void()>	signal_defaultsAboutToBeRestored
	Signal emitted right before the defaults are about to be restored to the settings backup object. More...

boost::signalslib::signal< void()>	signal_defaultsRestored
	Signal emitted when the defaults have been restored via the settings backup object. More...

boost::signalslib::signal< void()>	signal_factoryDefaultsAboutToBeRestored
	Signal emitted when factory is about to be restored via the settings backup object. More...

boost::signalslib::signal< void()>	signal_factoryDefaultsRestored
	Signal emitted when factory has been restored via the settings backup object. More...

boost::signalslib::signal< void()>	signal_export
	Signal emitted when the user wants to export to a file. More...

boost::signalslib::signal< void()>	signal_import
	Signal emitted when the user wants to import. More...

boost::signalslib::signal< void()>	signal_exportSelected
	Signal emitted when the user wants to export selected item(s) to a file. More...

boost::signalslib::signal< void()>	signal_exportHier
	Signal emitted when the user wants to export an element definition hierarchy to a file. More...

boost::signalslib::signal< void()>	signal_saveAll
	Signal emitted when the user wants to export all item(s) More...

boost::signalslib::signal< void()>	signal_reload
	Reloads all hier and leaf files in editor. More...

boost::signalslib::signal< void()>	signal_exportLeaves
	Signal emitted when the user wants to export element definition leaves to a file. More...

boost::signalslib::signal< void()>	signal_exportSelectedLeaves
	Signal emitted when the user wants to export selected element definition leaves to a file. More...

boost::signalslib::signal< void()>	signal_merge
	Signal emitted when the user wants to merge. More...

boost::signalslib::signal < void(const std::string &)>	signal_importFilenameChosen
	Signal emitted when the user has chosen a filename to import from. More...

boost::signalslib::signal < void(const std::string &)>	signal_mergeFilenameChosen
	Signal emitted when the user has chosen a filename to merge from. More...

boost::signalslib::signal < void(const std::string &)>	signal_exportFilenameChosen
	Signal emitted when the user has chosen a filename to export to. More...

boost::signalslib::signal < void(const std::string &)>	signal_exportHierFilenameChosen
	Signal emitted when the user has chosen a filename to export the hierarchy element definitions to. More...

boost::signalslib::signal < void(const std::string &)>	signal_exportAllFilenamesChosen
	Signal emitted when the user has chosen a filename to export. More...

boost::signalslib::signal < void(const std::string &)>	signal_exportLeafFilenameChosen
	Signal emitted when the user has chosen a filename to export the leaf element definitions to. More...

Detailed Description

Abstract interface for controlling persistence of state in a dialog.

Constructor & Destructor Documentation

virtual makVrv::DtPersistenceControlsInterface::~DtPersistenceControlsInterface ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtPersistenceControlsInterface::queryImportFilePath	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Ask for a filename to import from fileFilter is the desired extension with no dot.

Implemented in makVrv::DtDefinitionPersistenceWidget, and makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::queryMergeFilePath	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Ask for a filename to merge from fileFilter is the desired extension with no dot.

Implemented in makVrv::DtDefinitionPersistenceWidget, and makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::queryExportFilePath	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Ask for a filename to export to fileFilter is the desired extension with no dot.

Implemented in makVrv::DtPersistenceToolbarWidget, and makVrv::DtDefinitionPersistenceWidget.

virtual std::string makVrv::DtPersistenceControlsInterface::queryExportFilePathString	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Ask for a filename to export to fileFilter is the desired extension with no dot.

Implemented in makVrv::DtPersistenceToolbarWidget, and makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceControlsInterface::queryExportHierFilePath	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Ask for a filename to export the element definition hierarchy fileFilter is the desired extension with no dot.

Implemented in makVrv::DtPersistenceToolbarWidget, and makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceControlsInterface::queryExportAllFilePaths	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Exports all hier and leaf files to their respective file locations.

Implemented in makVrv::DtPersistenceToolbarWidget, and makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceControlsInterface::queryExportLeafFilePath	(	DtDe &	de,
		const std::string &	importType,
		const std::string &	path,
		const std::string &	fileFilter
	)

pure virtual

Ask for a filename to export the element definition leaves fileFilter is the desired extension with no dot.

Implemented in makVrv::DtPersistenceToolbarWidget, and makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceControlsInterface::setSaveButtonShown ( bool )

pure virtual

Shows/hides save button. Default is hidden.

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setSeparatorShown ( bool )

pure virtual

Shows/hides horizontal separator. Default is shown.

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setMergeShown ( bool )

pure virtual

If true, shows merge button to allow merging of settings.

Merge will add or replace, not remove items. Default is hidden

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setExportShown ( bool )

pure virtual

If true will export selected item(s) to a file.

Default is hidden

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setImportShown ( bool )

pure virtual

If true will import settings.

Default is shown

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setExportEnabled ( bool )

pure virtual

Enable/diable export button. Default is enabled.

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setMergeEnabled ( bool )

pure virtual

If true, enabled merge button.

Merge will add or replace, not remove items. Default is enabled

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setSaveDefaultsEnabled ( bool )

pure virtual

If true, enabled merge button.

Merge will add or replace, not remove items. Default is enabled

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setImportEnabled ( bool )

pure virtual

If true will enable import settings.

Default is enabled

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setExportSelectedEnabled ( bool )

pure virtual

Sets whether or not export selected is enabled.

Default is false

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setBackupRestoreEnabled ( bool )

pure virtual

Sets whether or not the restore from backup button is enabled.

Initially disabled

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setFactoryRestoreEnabled ( bool )

pure virtual

Sets whether or not the restore from factory button is enabled.

Initially disabled

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::setBackup	(	DtBackupInterface *	backup,
		bool	showFactoryButton
	)

pure virtual

Sets the backup object that will be used to restore from.

If the object is NULL, and the restore buttons are pressed, the signal to restore factory and defaults will be sent. If the object is not NULL, the object will be restored by the toolbar and the defaults Restored and factoryDefaultsRestored signals will be sent showFactoryButton will hide the factory button when it is set to false.

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual void makVrv::DtPersistenceControlsInterface::disableAllButtons ( bool )

pure virtual

Quick way to disable/enable all buttons.

Implemented in makVrv::DtPersistenceToolbarWidget, and makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceControlsInterface::activateSaveDefaults ( )

pure virtual

Click the save defaults button (usually prompting on page exit)

Implemented in makVrv::DtPersistenceToolbarWidget.

virtual int makVrv::DtPersistenceControlsInterface::activateRememberToExport ( bool & dontShowAgain )

virtual

Remind user to export (usually prompting on page exit) with a checkbox allow user to not show it again dontShowAgain whether the user checked the "dont show again".

Returns: int QMessageBox::StandardButton

Reimplemented in makVrv::DtPersistenceToolbarWidget.

virtual bool makVrv::DtPersistenceControlsInterface::showImportLeavesFirstBox ( )

virtual

show the messabge box to remind the user to import leave before import hireachy(for entity,unit,tactical graphics)

Returns: whether user click the ok button, true means ok cliked,false means close

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

Member Data Documentation

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_saveDefaults

Signal emitted when the user wants to save to a default file.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_restoreDefaults

Signal emitted when the user wants to load the default file.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_restoreFactoryDefaults

Signal emitted when the user wants to load the factory settings file.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_defaultsAboutToBeRestored

Signal emitted right before the defaults are about to be restored to the settings backup object.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_defaultsRestored

Signal emitted when the defaults have been restored via the settings backup object.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_factoryDefaultsAboutToBeRestored

Signal emitted when factory is about to be restored via the settings backup object.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_factoryDefaultsRestored

Signal emitted when factory has been restored via the settings backup object.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_export

Signal emitted when the user wants to export to a file.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_import

Signal emitted when the user wants to import.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_exportSelected

Signal emitted when the user wants to export selected item(s) to a file.

boost::signalslib::signal<void()> makVrv::DtPersistenceControlsInterface::signal_exportHier

Signal emitted when the user wants to export an element definition hierarchy to a file.

boost::signalslib::signal<void()> makVrv::DtPersistenceControlsInterface::signal_saveAll

Signal emitted when the user wants to export all item(s)

to their respective files

boost::signalslib::signal<void()> makVrv::DtPersistenceControlsInterface::signal_reload

Reloads all hier and leaf files in editor.

boost::signalslib::signal<void()> makVrv::DtPersistenceControlsInterface::signal_exportLeaves

Signal emitted when the user wants to export element definition leaves to a file.

boost::signalslib::signal<void()> makVrv::DtPersistenceControlsInterface::signal_exportSelectedLeaves

Signal emitted when the user wants to export selected element definition leaves to a file.

boost::signalslib::signal<void ()> makVrv::DtPersistenceControlsInterface::signal_merge

Signal emitted when the user wants to merge.

boost::signalslib::signal<void (const std::string&)> makVrv::DtPersistenceControlsInterface::signal_importFilenameChosen

Signal emitted when the user has chosen a filename to import from.

boost::signalslib::signal<void (const std::string&)> makVrv::DtPersistenceControlsInterface::signal_mergeFilenameChosen

Signal emitted when the user has chosen a filename to merge from.

boost::signalslib::signal<void (const std::string&)> makVrv::DtPersistenceControlsInterface::signal_exportFilenameChosen

Signal emitted when the user has chosen a filename to export to.

boost::signalslib::signal<void(const std::string&)> makVrv::DtPersistenceControlsInterface::signal_exportHierFilenameChosen

Signal emitted when the user has chosen a filename to export the hierarchy element definitions to.

boost::signalslib::signal<void(const std::string&)> makVrv::DtPersistenceControlsInterface::signal_exportAllFilenamesChosen

Signal emitted when the user has chosen a filename to export.

all files

boost::signalslib::signal<void(const std::string&)> makVrv::DtPersistenceControlsInterface::signal_exportLeafFilenameChosen

Signal emitted when the user has chosen a filename to export the leaf element definitions to.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCoreQt/DtPersistenceControlsInterface.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation