VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes
makVrv::DtPersistenceToolbarWidget Class Reference
vrvCoreQt

A widget that displays a persistence GUI in some way Operations presented are import, export, save, and restore.

Inheritance diagram for makVrv::DtPersistenceToolbarWidget:
Inheritance graph
[legend]

Public Member Functions

 DtPersistenceToolbarWidget (DtDe &de, QWidget *p=0, Qt::WindowFlags f=0)
 
virtual ~DtPersistenceToolbarWidget ()
 
virtual void setPersistentStateName (const QString &name)
 
virtual void queryImportFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual void queryMergeFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual void queryExportFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual std::string queryExportFilePathString (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual void queryExportHierFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual void queryExportAllFilePaths (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual void queryExportLeafFilePath (DtDe &de, const std::string &importType, const std::string &path, const std::string &fileFilter)
 
virtual void setSaveButtonShown (bool shown)
 
virtual void setSeparatorShown (bool shown)
 
virtual void setMergeShown (bool shown)
 
virtual void setExportShown (bool)
 
virtual void setImportShown (bool)
 
virtual void setExportEnabled (bool)
 
virtual void setMergeEnabled (bool)
 
virtual void setImportEnabled (bool)
 
virtual void setExportSelectedEnabled (bool)
 
virtual void setBackupRestoreEnabled (bool shown)
 
virtual void setFactoryRestoreEnabled (bool shown)
 
virtual void setSaveDefaultsEnabled (bool b)
 
virtual void setBackup (DtBackupInterface *backup, bool showFactoryButton) override
 
virtual void disableAllButtons (bool)
 
virtual void activateSaveDefaults ()
 
virtual int activateRememberToExport (bool &dontShowAagin)
 
- Public Member Functions inherited from makVrv::DtPersistenceControlsInterface
virtual ~DtPersistenceControlsInterface ()
 
virtual bool showImportLeavesFirstBox ()
 

Protected Slots

virtual void on_myImportButton_clicked ()
 
virtual void on_myExportButton_clicked ()
 
virtual void on_myMergeButton_clicked ()
 
virtual void on_myExportSelectedButton_clicked ()
 
virtual void on_mySaveButton_clicked ()
 
virtual void on_mySaveAllButton_clicked ()
 
virtual void on_myRestoreButton_clicked ()
 
virtual void on_myRestoreFactoryButton_clicked ()
 

Protected Member Functions

virtual void backupFileChanged (const DtBackupInterface *)
 
virtual void rememberToExportDialog ()
 
std::string labelNameToExportDialogDisplayName (const std::string &name)
 
void setupGui ()
 
virtual QString willAlsoRestore (int) const
 

Protected Attributes

DtDe & myDe
 
DtBackupInterface * myBackup
 
QLabel * myLabel
 
QPushButton * myImportButton
 
QPushButton * myExportButton
 
QPushButton * myMergeButton
 
QPushButton * myExportSelectedButton
 
QPushButton * mySaveButton
 
QPushButton * mySaveAllButton
 
QPushButton * myRestoreButton
 
QPushButton * myRestoreFactoryButton
 
QFrame * mySeparator
 
QHBoxLayout * myButtonLayout
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtPersistenceControlsInterface
boost::signalslib::signal< void()> signal_saveDefaults
 
boost::signalslib::signal< void()> signal_restoreDefaults
 
boost::signalslib::signal< void()> signal_restoreFactoryDefaults
 
boost::signalslib::signal< void()> signal_defaultsAboutToBeRestored
 
boost::signalslib::signal< void()> signal_defaultsRestored
 
boost::signalslib::signal< void()> signal_factoryDefaultsAboutToBeRestored
 
boost::signalslib::signal< void()> signal_factoryDefaultsRestored
 
boost::signalslib::signal< void()> signal_export
 
boost::signalslib::signal< void()> signal_import
 
boost::signalslib::signal< void()> signal_exportSelected
 
boost::signalslib::signal< void()> signal_exportHier
 
boost::signalslib::signal< void()> signal_saveAll
 
boost::signalslib::signal< void()> signal_reload
 
boost::signalslib::signal< void()> signal_exportLeaves
 
boost::signalslib::signal< void()> signal_exportSelectedLeaves
 
boost::signalslib::signal< void()> signal_merge
 
boost::signalslib::signal
< void(const std::string &)> 		signal_importFilenameChosen
 
boost::signalslib::signal
< void(const std::string &)> 		signal_mergeFilenameChosen
 
boost::signalslib::signal
< void(const std::string &)> 		signal_exportFilenameChosen
 
boost::signalslib::signal
< void(const std::string &)> 		signal_exportHierFilenameChosen
 
boost::signalslib::signal
< void(const std::string &)> 		signal_exportAllFilenamesChosen
 
boost::signalslib::signal
< void(const std::string &)> 		signal_exportLeafFilenameChosen
 

Constructor & Destructor Documentation

makVrv::DtPersistenceToolbarWidget::DtPersistenceToolbarWidget ( DtDe &  de,
QWidget *  p = 0,
Qt::WindowFlags  f = 0 
)

CTOR.

virtual makVrv::DtPersistenceToolbarWidget::~DtPersistenceToolbarWidget ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtPersistenceToolbarWidget::setPersistentStateName ( const QString &  name)
virtual

Set the name of thing being saved.

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

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

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

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

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

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

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

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

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

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

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

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

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

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

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

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

Ask for a filename to export all element definitions.

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

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

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

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceToolbarWidget::setSaveButtonShown ( bool  shown)
virtual

Shows/hides save button. Default is hidden.

Implements makVrv::DtPersistenceControlsInterface.

virtual void makVrv::DtPersistenceToolbarWidget::setSeparatorShown ( bool  shown)
virtual

Shows/hides horizontal separator. Default is shown.

Implements makVrv::DtPersistenceControlsInterface.

virtual void makVrv::DtPersistenceToolbarWidget::setMergeShown ( bool  shown)
virtual

If true, shows merge button to allow merging of settings. Merge will add or replace, not remove items. is hidden.

Implements makVrv::DtPersistenceControlsInterface.

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

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

Implements makVrv::DtPersistenceControlsInterface.

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

If true will import settings. Default is shown.

Implements makVrv::DtPersistenceControlsInterface.

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

Sets whether or not export button is enabled. Initially enabled.

Implements makVrv::DtPersistenceControlsInterface.

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

Sets whether or not merge button is enabled. Merge will add or replace, not remove items. Initially disabled.

Implements makVrv::DtPersistenceControlsInterface.

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

Sets whether or not import button is enabled. Initially enabled.

Implements makVrv::DtPersistenceControlsInterface.

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

Sets whether or not export selected button is enabled. Initially disabled.

Implements makVrv::DtPersistenceControlsInterface.

virtual void makVrv::DtPersistenceToolbarWidget::setBackupRestoreEnabled ( bool  shown)
virtual

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

Implements makVrv::DtPersistenceControlsInterface.

virtual void makVrv::DtPersistenceToolbarWidget::setFactoryRestoreEnabled ( bool  shown)
virtual

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

Implements makVrv::DtPersistenceControlsInterface.

virtual void makVrv::DtPersistenceToolbarWidget::setSaveDefaultsEnabled ( bool  b)
virtual

Sets whether or not the save defaults button is enabled. Initially enabled.

Implements makVrv::DtPersistenceControlsInterface.

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

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 defaultsRestored and factoryDefaultsRestored signals will be sent When showFactoryButton is set to false then the factory restore button will be hidden. If the backup factory file/directory is missing and showFactoryButton is set to true then the factory button will be there but disabled.

Implements makVrv::DtPersistenceControlsInterface.

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

Quick way to disable/enable all buttons.

Implements makVrv::DtPersistenceControlsInterface.

Reimplemented in makVrv::DtDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceToolbarWidget::activateSaveDefaults ( )
virtual

Prompt to save (usually on exit from a page)

Implements makVrv::DtPersistenceControlsInterface.

virtual int makVrv::DtPersistenceToolbarWidget::activateRememberToExport ( bool &  dontShowAagin)
virtual

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

Returns
int QMessageBox::StandardButton

Reimplemented from makVrv::DtPersistenceControlsInterface.

Reimplemented in DtVrfDefinitionPersistenceWidget.

virtual void makVrv::DtPersistenceToolbarWidget::on_myImportButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtPersistenceToolbarWidget::on_myExportButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtPersistenceToolbarWidget::on_myMergeButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtPersistenceToolbarWidget::on_myExportSelectedButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtPersistenceToolbarWidget::on_mySaveButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtPersistenceToolbarWidget::on_mySaveAllButton_clicked ( )
protectedvirtualslot
virtual void makVrv::DtPersistenceToolbarWidget::on_myRestoreButton_clicked ( )
protectedvirtualslot

Reimplemented in makVrv::DtObserverModePersistenceWidget.

virtual void makVrv::DtPersistenceToolbarWidget::on_myRestoreFactoryButton_clicked ( )
protectedvirtualslot

Reimplemented in makVrv::DtObserverModePersistenceWidget.

virtual void makVrv::DtPersistenceToolbarWidget::backupFileChanged ( const DtBackupInterface *  )
protectedvirtual

Called from the backup manager when the status of restoring from backup or factory changes. Will enable/disable appropriate button.

virtual void makVrv::DtPersistenceToolbarWidget::rememberToExportDialog ( )
protectedvirtual

For the VRF style definitions, entity type mappings reminder user to export to keep their changes.

std::string makVrv::DtPersistenceToolbarWidget::labelNameToExportDialogDisplayName ( const std::string &  name)
protected

map label name to the name displayed in the rememberToExport dialog name

void makVrv::DtPersistenceToolbarWidget::setupGui ( )
protected
virtual QString makVrv::DtPersistenceToolbarWidget::willAlsoRestore ( int  ) const
protectedvirtual

If other items will be restored by either restoring local or factory, return text string which describes what will be restored.

Member Data Documentation

DtDe& makVrv::DtPersistenceToolbarWidget::myDe
protected
DtBackupInterface* makVrv::DtPersistenceToolbarWidget::myBackup
protected
QLabel* makVrv::DtPersistenceToolbarWidget::myLabel
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::myImportButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::myExportButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::myMergeButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::myExportSelectedButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::mySaveButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::mySaveAllButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::myRestoreButton
protected
QPushButton* makVrv::DtPersistenceToolbarWidget::myRestoreFactoryButton
protected
QFrame* makVrv::DtPersistenceToolbarWidget::mySeparator
protected
QHBoxLayout* makVrv::DtPersistenceToolbarWidget::myButtonLayout
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)