The class that will contain information about various scenario settings. More...

Inheritance diagram for makVrf::DtVrfGuiSettingsManager:

Public Member Functions
	DtVrfGuiSettingsManager (makVrv::DtDe &)

virtual	~DtVrfGuiSettingsManager ()

virtual void	setHelpFile (const std::string &, bool save=false)
	Sets the help file to use when pressing the F1 key. More...

virtual std::string	helpFile () const

virtual void	setFromRecord (const DtVrfGuiSettingsRecord &rec)

virtual void	loadDefaultGuiSettings (bool loadOnlyFactorySettings=false)

virtual void	getRecord (DtVrfGuiSettingsRecord &rec) const

virtual void	setGrayOutHiddenItems (bool)
	If items are hidden, gray the icon out on any list view (except palette and info windows) that has that icon (default is true) More...

virtual bool	grayOutHiddenItems () const

virtual void	setOrganizeOverlaysByCategory (bool)
	Organize all objects that are created on overlays that represent their top level category on the overlays tab and list (default is true) More...

virtual bool	organizeOverlaysByCategory () const

virtual void	getSplitRecord (std::vector< DtVrfGuiSettingsRecord > &rec, std::vector< std::string > &fileNames)
	To support writing element definitions in folders as multiple files not implemented. More...

virtual void	addRecords (DtVrfGuiSettingsRecord &recs, DtVrfGuiSettingsRecord &combinedRec)
	To support writing element definitions in folders as multiple files not implemented. More...

virtual void	setAutoSave (bool)
	Set to false to not save on settings change. Default is true. More...

virtual bool	autoSave () const

virtual bool	zoomToScenarioExtentsOnLoad () const
	Access to gui record information. More...

virtual bool	useSimulationTimeForAdvancement () const

virtual bool	showOverlayBar () const

virtual void	setUseAdditionalWindowTitle (bool)
	Sets whether or not to use extended window title. More...

virtual bool	useAdditionalWindowTitle () const

virtual void	setAdditionalWindowTitle (const makVrv::DtUnicode &)
	Returns the additional window title. More...

virtual makVrv::DtUnicode	additionalWindowTitle () const

virtual void	setUseStartFreezePdus (bool)
	Sets whether or not to use DIS start/freeze PDUs or VRF start/stop PDUs. More...

virtual bool	useStartFreezePdus () const

virtual void	setAllowWindowsStyleNameEditing (bool)
	Sets whether or not to use windows style name editing for certain widgets in the gui. More...

virtual bool	allowWindowsStyleNameEditing () const

virtual void	setEditPressTime (double)
	The time delay before allowing the name edit (if enabled) to occur. Default is 1/2 second. More...

virtual double	editPressTime () const

virtual void	setSortTaskSetMenus (bool)
	Sets whether or not to sort the task/set menus. More...

virtual bool	sortTaskSetMenus () const

virtual void	setPromptBeforeAbandoningPlan (bool)
	Get/set whether or user will be prompted to abandon plan before assigning task. More...

virtual bool	promptBeforeAbandoningPlan () const

virtual void	setPromptBeforeInterruptingTask (bool)
	Get/set whether or user will be prompted to interrupt current task before assigning task. More...

virtual bool	promptBeforeInterruptingTask () const

virtual void	setUseDoubleClickToEndRouteCreation (bool)
	Get/set whether or user will use double click to end route/area creation. More...

virtual bool	useDoubleClickToEndRouteCreation () const

makVrv::DtRecordSettingsBackupInterface *	guiSettingsBackup ()

void	exportGuiSettings (const std::string &fileName)
	Exports the current cache settings to a file. More...

void	importGuiSettings (const std::string &fileName)
	Import the current cache settings from a file. More...

virtual void	setDisplayCorrelationWarningMessages (bool)
	Shows/does not show correlation warnings dialog. More...

virtual bool	displayCorrelationWarningMessages () const

virtual void	setDoNotShowSessionStartupDialog (bool, bool save=true, bool signal=true)
	Sets whether or not to show the startup session dialog. More...

bool	showSessionStartupDialog () const

virtual void	setStartupPreference (int)
	Preference on startup (new scenario or load scenario) More...

int	startupPreference () const

virtual void	setTimeScaleRange (double low, double high, bool save=true)
	Sets the low/hight range of timescale timer. More...

virtual void	getTimeScaleRange (double &low, double &high) const

virtual void	setUserDefinedSmoothing (bool)
	Sets whether or not the user or system is defining smoothing in performance options. More...

bool	userDefinedSmoothing () const

virtual void	setShowScenarioDescriptionDialog (bool b)
	Sets whether or not to show scenario description message box. More...

virtual bool	showScenarioDescriptionDialog () const

virtual void	setTimescaleButtonMode (bool)
	Set to true to show the timescale as buttons rather than a slider. More...

virtual bool	timescaleButtonMode ()

virtual void	setTimescaleButtons (const std::string &)
	Set the buttons to show on the timescale if in button mode. semi-colon delimited (i.e. "1;2;5;10;20") More...

virtual const std::string &	timescaleButtons () const

virtual void	saveSettingsAsDefault ()
	Saves if auto-save is turned on. More...

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...

virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtVrfGuiSettingsManager &	instance (makVrv::DtDe &de)
	Returns instance of the messager. More...

static void	registerInstance (makVrv::DtDe &de, DtVrfGuiSettingsManager *)

Public Attributes
boost::signals2::signal< void(const DtVrfGuiSettingsRecord &)>	signal_guiSettingsChanged
	Sent when gui settings have changed. More...

boost::signals2::signal< void(bool)>	signal_grayOutHiddenItemsChanged
	Signal sent when gray out has changed. More...

boost::signals2::signal< void(bool)>	signal_organizeOverlaysByCategoryChanged
	Signal sent when organizing by categories changes. More...

boost::signals2::signal< void(bool)>	signal_taskSetMenuSortChanged
	Sent when the sorting of task/set menus has changed. More...

boost::signals2::signal< void(bool)>	signal_allowWindowsStyleNameEditingChanged
	Signal sent when windows style name editing has changed. More...

boost::signals2::signal< void(bool)>	signal_editPressTimeChanged
	Signal sent when the edit press time has changed. More...

Protected Attributes
makVrv::DtDe &	myDe

DtVrfGuiSettingsRecord	myGuiSettings

makVrv::DtRecordSettingsBackupInterface *	myGuiSettingsBackup

Detailed Description

The class that will contain information about various scenario settings.

Constructor & Destructor Documentation

makVrf::DtVrfGuiSettingsManager::DtVrfGuiSettingsManager ( makVrv::DtDe & )

virtual makVrf::DtVrfGuiSettingsManager::~DtVrfGuiSettingsManager ( )

virtual

Member Function Documentation

static DtVrfGuiSettingsManager& makVrf::DtVrfGuiSettingsManager::instance ( makVrv::DtDe & de )

static

Returns instance of the messager.

static void makVrf::DtVrfGuiSettingsManager::registerInstance	(	makVrv::DtDe &	de,
		DtVrfGuiSettingsManager *
	)

static

virtual void makVrf::DtVrfGuiSettingsManager::setHelpFile	(	const std::string &	,
		bool	save = `false`
	)

virtual

Sets the help file to use when pressing the F1 key.

Note this will be a permanent change and will be using that file the next time the application is started if the save flag is true. By default is false

virtual std::string makVrf::DtVrfGuiSettingsManager::helpFile ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setFromRecord ( const DtVrfGuiSettingsRecord & rec )

virtual

virtual void makVrf::DtVrfGuiSettingsManager::loadDefaultGuiSettings ( bool loadOnlyFactorySettings = false )

virtual

virtual void makVrf::DtVrfGuiSettingsManager::getRecord ( DtVrfGuiSettingsRecord & rec ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setGrayOutHiddenItems ( bool )

virtual

If items are hidden, gray the icon out on any list view (except palette and info windows) that has that icon (default is true)

virtual bool makVrf::DtVrfGuiSettingsManager::grayOutHiddenItems ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setOrganizeOverlaysByCategory ( bool )

virtual

Organize all objects that are created on overlays that represent their top level category on the overlays tab and list (default is true)

virtual bool makVrf::DtVrfGuiSettingsManager::organizeOverlaysByCategory ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::getSplitRecord	(	std::vector< DtVrfGuiSettingsRecord > &	rec,
		std::vector< std::string > &	fileNames
	)

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtVrfGuiSettingsManager::addRecords	(	DtVrfGuiSettingsRecord &	recs,
		DtVrfGuiSettingsRecord &	combinedRec
	)

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtVrfGuiSettingsManager::setAutoSave ( bool )

virtual

Set to false to not save on settings change. Default is true.

virtual bool makVrf::DtVrfGuiSettingsManager::autoSave ( ) const

virtual

virtual bool makVrf::DtVrfGuiSettingsManager::zoomToScenarioExtentsOnLoad ( ) const

virtual

Access to gui record information.

To set, get record and then reset vis setFromRecord

virtual bool makVrf::DtVrfGuiSettingsManager::useSimulationTimeForAdvancement ( ) const

virtual

virtual bool makVrf::DtVrfGuiSettingsManager::showOverlayBar ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setUseAdditionalWindowTitle ( bool )

virtual

Sets whether or not to use extended window title.

The extended window title will be added to the end of the existing window title in parenthesis

virtual bool makVrf::DtVrfGuiSettingsManager::useAdditionalWindowTitle ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setAdditionalWindowTitle ( const makVrv::DtUnicode & )

virtual

Returns the additional window title.

virtual makVrv::DtUnicode makVrf::DtVrfGuiSettingsManager::additionalWindowTitle ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setUseStartFreezePdus ( bool )

virtual

Sets whether or not to use DIS start/freeze PDUs or VRF start/stop PDUs.

virtual bool makVrf::DtVrfGuiSettingsManager::useStartFreezePdus ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setAllowWindowsStyleNameEditing ( bool )

virtual

Sets whether or not to use windows style name editing for certain widgets in the gui.

virtual bool makVrf::DtVrfGuiSettingsManager::allowWindowsStyleNameEditing ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setEditPressTime ( double )

virtual

The time delay before allowing the name edit (if enabled) to occur. Default is 1/2 second.

virtual double makVrf::DtVrfGuiSettingsManager::editPressTime ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setSortTaskSetMenus ( bool )

virtual

Sets whether or not to sort the task/set menus.

virtual bool makVrf::DtVrfGuiSettingsManager::sortTaskSetMenus ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setPromptBeforeAbandoningPlan ( bool )

virtual

Get/set whether or user will be prompted to abandon plan before assigning task.

virtual bool makVrf::DtVrfGuiSettingsManager::promptBeforeAbandoningPlan ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setPromptBeforeInterruptingTask ( bool )

virtual

Get/set whether or user will be prompted to interrupt current task before assigning task.

virtual bool makVrf::DtVrfGuiSettingsManager::promptBeforeInterruptingTask ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setUseDoubleClickToEndRouteCreation ( bool )

virtual

Get/set whether or user will use double click to end route/area creation.

virtual bool makVrf::DtVrfGuiSettingsManager::useDoubleClickToEndRouteCreation ( ) const

virtual

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfGuiSettingsManager::guiSettingsBackup ( )

inline

void makVrf::DtVrfGuiSettingsManager::exportGuiSettings ( const std::string & fileName )

Exports the current cache settings to a file.

void makVrf::DtVrfGuiSettingsManager::importGuiSettings ( const std::string & fileName )

Import the current cache settings from a file.

virtual void makVrf::DtVrfGuiSettingsManager::setDisplayCorrelationWarningMessages ( bool )

virtual

Shows/does not show correlation warnings dialog.

virtual bool makVrf::DtVrfGuiSettingsManager::displayCorrelationWarningMessages ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setDoNotShowSessionStartupDialog	(	bool	,
		bool	save = `true`,
		bool	signal = `true`
	)

virtual

Sets whether or not to show the startup session dialog.

bool makVrf::DtVrfGuiSettingsManager::showSessionStartupDialog ( ) const

virtual void makVrf::DtVrfGuiSettingsManager::setStartupPreference ( int )

virtual

Preference on startup (new scenario or load scenario)

int makVrf::DtVrfGuiSettingsManager::startupPreference ( ) const

virtual void makVrf::DtVrfGuiSettingsManager::setTimeScaleRange	(	double	low,
		double	high,
		bool	save = `true`
	)

virtual

Sets the low/hight range of timescale timer.

virtual void makVrf::DtVrfGuiSettingsManager::getTimeScaleRange	(	double &	low,
		double &	high
	)		const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setUserDefinedSmoothing ( bool )

virtual

Sets whether or not the user or system is defining smoothing in performance options.

bool makVrf::DtVrfGuiSettingsManager::userDefinedSmoothing ( ) const

virtual void makVrf::DtVrfGuiSettingsManager::setShowScenarioDescriptionDialog ( bool b )

virtual

Sets whether or not to show scenario description message box.

virtual bool makVrf::DtVrfGuiSettingsManager::showScenarioDescriptionDialog ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setTimescaleButtonMode ( bool )

virtual

Set to true to show the timescale as buttons rather than a slider.

This will have no effect after the widget is created

virtual bool makVrf::DtVrfGuiSettingsManager::timescaleButtonMode ( )

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setTimescaleButtons ( const std::string & )

virtual

Set the buttons to show on the timescale if in button mode. semi-colon delimited (i.e. "1;2;5;10;20")

virtual const std::string& makVrf::DtVrfGuiSettingsManager::timescaleButtons ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::saveSettingsAsDefault ( )

virtual

Saves if auto-save is turned on.

Member Data Documentation

boost::signals2::signal<void (const DtVrfGuiSettingsRecord&)> makVrf::DtVrfGuiSettingsManager::signal_guiSettingsChanged

Sent when gui settings have changed.

boost::signals2::signal<void (bool)> makVrf::DtVrfGuiSettingsManager::signal_grayOutHiddenItemsChanged

Signal sent when gray out has changed.

boost::signals2::signal<void (bool)> makVrf::DtVrfGuiSettingsManager::signal_organizeOverlaysByCategoryChanged

Signal sent when organizing by categories changes.

boost::signals2::signal<void (bool)> makVrf::DtVrfGuiSettingsManager::signal_taskSetMenuSortChanged

Sent when the sorting of task/set menus has changed.

boost::signals2::signal<void (bool)> makVrf::DtVrfGuiSettingsManager::signal_allowWindowsStyleNameEditingChanged

Signal sent when windows style name editing has changed.

boost::signals2::signal<void (bool)> makVrf::DtVrfGuiSettingsManager::signal_editPressTimeChanged

Signal sent when the edit press time has changed.

makVrv::DtDe& makVrf::DtVrfGuiSettingsManager::myDe

protected

DtVrfGuiSettingsRecord makVrf::DtVrfGuiSettingsManager::myGuiSettings

protected

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfGuiSettingsManager::myGuiSettingsBackup

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfGuiCore/vrfGuiSettingsManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation