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

The class that will contain information about various scenario settings.

Related Examples
Inheritance diagram for makVrf::DtVrfGuiSettingsManager:
Inheritance graph
[legend]

Public Member Functions

 DtVrfGuiSettingsManager (makVrv::DtDe &)
 
virtual ~DtVrfGuiSettingsManager ()
 
virtual void setHelpFile (const std::string &, bool save=false)
 
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)
 
virtual bool grayOutHiddenItems () const
 
virtual void setOrganizeOverlaysByCategory (bool)
 
virtual bool organizeOverlaysByCategory () const
 
virtual void getSplitRecord (std::vector< DtVrfGuiSettingsRecord > &rec, std::vector< std::string > &fileNames)
 
virtual void addRecords (DtVrfGuiSettingsRecord &recs, DtVrfGuiSettingsRecord &combinedRec)
 
virtual void setAutoSave (bool)
 
virtual bool autoSave () const
 
virtual bool zoomToScenarioExtentsOnLoad () const
 
virtual bool useSimulationTimeForAdvancement () const
 
virtual bool showOverlayBar () const
 
virtual bool showSimOperationsStatusBar () const
 
virtual void setUseAdditionalWindowTitle (bool)
 
virtual bool useAdditionalWindowTitle () const
 
void setCommandPanelShowIcons (bool)
 
bool commandPanelShowIcons () const
 
void setShowCommandPanelSmallIcons (bool)
 
bool showCommandPanelSmallIcons () const
 
virtual void setShowCommandPanelLargeIcons (bool)
 
virtual bool showCommandPanelLargeIcons () const
 
virtual void setAdditionalWindowTitle (const makVrv::DtUnicode &)
 
virtual makVrv::DtUnicode additionalWindowTitle () const
 
virtual void setUseStartFreezePdus (bool)
 
virtual bool useStartFreezePdus () const
 
virtual void setAllowWindowsStyleNameEditing (bool)
 
virtual bool allowWindowsStyleNameEditing () const
 
virtual void setEditPressTime (double)
 
virtual double editPressTime () const
 
virtual void setSortTaskSetMenus (bool)
 
virtual bool sortTaskSetMenus () const
 
virtual void setPromptBeforeAbandoningPlan (bool)
 
virtual bool promptBeforeAbandoningPlan () const
 
virtual void setPromptBeforeInterruptingTask (bool)
 
virtual bool promptBeforeInterruptingTask () const
 
virtual void setAskToCancelOperation (bool)
 
virtual bool askToCancelOperation () const
 
virtual void setUseDoubleClickToEndRouteCreation (bool)
 
virtual bool useDoubleClickToEndRouteCreation () const
 
virtual void setShowCountsOnObjectList (bool)
 
virtual bool showCountsOnObjectList () const
 
makVrv::DtRecordSettingsBackupInterface * guiSettingsBackup ()
 
void exportGuiSettings (const std::string &fileName)
 
void importGuiSettings (const std::string &fileName)
 
virtual void setDisplayCorrelationWarningMessages (bool)
 
virtual bool displayCorrelationWarningMessages () const
 
virtual void setDoNotShowSessionStartupDialog (bool, bool save=true, bool signal=true)
 
bool showSessionStartupDialog () const
 
virtual void setStartupPreference (int)
 
int startupPreference () const
 
virtual void setTimeScaleRange (double low, double high, bool save=true)
 
virtual void getTimeScaleRange (double &low, double &high) const
 
virtual void setUserDefinedSmoothing (bool)
 
bool userDefinedSmoothing () const
 
virtual void setShowScenarioDescriptionDialog (bool b)
 
virtual bool showScenarioDescriptionDialog () const
 
virtual void setTimescaleButtonMode (bool)
 
virtual bool timescaleButtonMode ()
 
virtual void setTimescaleButtons (const std::string &)
 
virtual const std::string & timescaleButtons () const
 
virtual void setOrientationStep (double)
 
virtual double orientationStep () const
 
virtual void setMovementStep (double)
 
virtual double movementStep () const
 
virtual void setForceForMenuItemTacticalGraphic (int)
 
virtual int forceForMenuItemTacticalGraphic () const
 
virtual void saveSettingsAsDefault ()
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

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

Public Attributes

boost::signals2::signal< void(const
DtVrfGuiSettingsRecord &)> 		signal_guiSettingsChanged
 
boost::signals2::signal< void(bool)> signal_grayOutHiddenItemsChanged
 
boost::signals2::signal< void(bool)> signal_organizeOverlaysByCategoryChanged
 
boost::signals2::signal< void(bool)> signal_taskSetMenuSortChanged
 
boost::signals2::signal< void(bool)> signal_allowWindowsStyleNameEditingChanged
 
boost::signals2::signal< void(bool)> signal_editPressTimeChanged
 
boost::signals2::signal< void(bool)> signal_showCountsOnObjectListChanged
 

Protected Attributes

makVrv::DtDe & myDe
 
DtVrfGuiSettingsRecord myGuiSettings
 
makVrv::DtRecordSettingsBackupInterface * myGuiSettingsBackup
 
int myForceForMenuItemTacticalGraphic
 

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 bool makVrf::DtVrfGuiSettingsManager::showSimOperationsStatusBar ( ) 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
void makVrf::DtVrfGuiSettingsManager::setCommandPanelShowIcons ( bool  )

If true, will show large icons by default.

bool makVrf::DtVrfGuiSettingsManager::commandPanelShowIcons ( ) const
void makVrf::DtVrfGuiSettingsManager::setShowCommandPanelSmallIcons ( bool  )

Whether or not to show small icons on command panel.

bool makVrf::DtVrfGuiSettingsManager::showCommandPanelSmallIcons ( ) const
virtual void makVrf::DtVrfGuiSettingsManager::setShowCommandPanelLargeIcons ( bool  )
virtual

Whether or not to show large icons on command panel.

virtual bool makVrf::DtVrfGuiSettingsManager::showCommandPanelLargeIcons ( ) 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::setAskToCancelOperation ( bool  )
virtual

Get/set whether the user will be prompted to cancel out of the current task/set/condition before creating a new one.

virtual bool makVrf::DtVrfGuiSettingsManager::askToCancelOperation ( ) 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
virtual void makVrf::DtVrfGuiSettingsManager::setShowCountsOnObjectList ( bool  )
virtual

Whether or not to show counts on the object list.

virtual bool makVrf::DtVrfGuiSettingsManager::showCountsOnObjectList ( ) 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::setOrientationStep ( double  )
virtual

In lock step mode when placing objects, the number of degrees to step with each movement.

virtual double makVrf::DtVrfGuiSettingsManager::orientationStep ( ) const
virtual
virtual void makVrf::DtVrfGuiSettingsManager::setMovementStep ( double  )
virtual

In lock step mode when placing objects, the number of meters to step with each mouse move (x, y, or z)

virtual double makVrf::DtVrfGuiSettingsManager::movementStep ( ) const
virtual
virtual void makVrf::DtVrfGuiSettingsManager::setForceForMenuItemTacticalGraphic ( int  )
virtual

This item is only valid for the current run. There are certain tactical graphic menu items (area, route, waypoint) that can be created from the right click menu. Typically those items would default to Neutral, however, if this is set to a force other than DtForceOther, this force will be used. Currently, this force is set automatically when a tactical graphic is greated from the create menu (point/multi-point) from the selected force in that dialog.

virtual int makVrf::DtVrfGuiSettingsManager::forceForMenuItemTacticalGraphic ( ) 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.

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

Signal sent when the show counts on object list have changed.

makVrv::DtDe& makVrf::DtVrfGuiSettingsManager::myDe
protected
DtVrfGuiSettingsRecord makVrf::DtVrfGuiSettingsManager::myGuiSettings
protected
makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfGuiSettingsManager::myGuiSettingsBackup
protected
int makVrf::DtVrfGuiSettingsManager::myForceForMenuItemTacticalGraphic
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)