makVrv::DtApplicationSettingsManager Class Reference

Application Settings Manager Settings associated with the application that don't merit an additional settings file (one offs, primarily)

Inheritance diagram for makVrv::DtApplicationSettingsManager:

Public Member Functions
virtual	~DtApplicationSettingsManager ()
virtual void	setShowQuitDialogOnClose (bool show)
virtual bool	showQuitDialogOnClose () const
virtual void	setDarkModeEnabled (bool show)
virtual bool	darkModeEnabled () const
virtual void	setLightModeDarkModeIconsEnabled (bool show)
virtual bool	lightModeDarkModeIconsEnabled () const
virtual void	setDarkModeStyleSheetsPath (const std::string &darkModeStyleSheetsPath)
virtual std::string	darkModeStyleSheetsPath () const
virtual void	setLightModeStyleSheetsPath (const std::string &lightModeStyleSheetsPath)
virtual std::string	lightModeStyleSheetsPath () const
virtual std::string	currentStyleSheetsPath () const
virtual void	setPaperMapLayerTimeout (double val)
virtual double	paperMapLayerTimeout () const
Setters/getters for settings
virtual void	setViewControlEnabled (bool val)
virtual bool	viewControlEnabled () const
virtual void	setScreenCaptureFilePath (const DtUnicode &filePath)
virtual const DtUnicode &	screenCaptureFilePath () const
virtual void	setMouseHideEnabled (bool enabled)
virtual bool	mouseHideEnabled () const
virtual void	setMouseHideTime (float hideTime)
virtual float	mouseHideTime () const
Setting Persistence Methods
void	setFromRecord (const DtApplicationSettingsRecord &rec)
void	getRecord (DtApplicationSettingsRecord &rec) const
Public Member Functions inherited from makVrv::DtBaseSettingsManager< DtApplicationSettingsRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtBaseSettingsManager ()
virtual void	initializeBackup ()
virtual void	setFromRecord (const DtApplicationSettingsRecord &record)=0
virtual void	getRecord (DtApplicationSettingsRecord &record) const =0
virtual bool	applyFactoryOverrides (DtApplicationSettingsRecord &record) const =0
virtual bool	getOverriddenFactoryRecord (DtApplicationSettingsRecord &record) const
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< DtApplicationSettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtCommonBaseSettingsManager ()
virtual void	autoSaveIfNecessary ()
virtual void	setAutoSave (bool doit)
virtual bool	autoSave () const
virtual void	setUseDefaultSettingsRecord (bool useit)
virtual bool	useDefaultSettingsRecord () const
virtual DtDeSettings *	settings ()
virtual const DtDeSettings *	settings () const
virtual DtSettingsBackup *	settingsBackup ()
virtual const DtSettingsBackup *	settingsBackup () const
virtual void	loadDefaults ()
virtual void	saveDefaultSettings ()
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
virtual void	importSettings (const std::string &filePath)
virtual void	exportSettings (const std::string &filePath) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtApplicationSettingsManager &	instance (DtDe &de)

Public Attributes
Boost signals for changed settings
boost::signalslib::signal < void(bool)>	signal_viewControlEnabledSet
boost::signalslib::signal < void(DtUnicode)>	signal_screenCaptureFilePathChanged
boost::signalslib::signal < void(bool)>	signal_mouseHideEnabledChanged
boost::signalslib::signal < void(float)>	signal_mouseHideTimeChanged
boost::signalslib::signal < void(bool)>	signal_showQuitDialogOnCloseChanged
boost::signalslib::signal < void(bool)>	signal_darkModeEnabledChanged
boost::signalslib::signal < void(bool)>	signal_lightModeDarkModeIconsEnabledChanged
boost::signalslib::signal< void()>	signal_preCurrentStyleSheetsPathChanged
boost::signalslib::signal < void(const std::string &)>	signal_currentStyleSheetsPathChanged
boost::signalslib::signal< void()>	signal_postCurrentStyleSheetsPathChanged
boost::signalslib::signal < void(double)>	signal_paperMapLayerTimeoutChanged

Protected Member Functions
	DtApplicationSettingsManager (DtDe &)
virtual bool	applyFactoryOverrides (DtApplicationSettingsRecord &rec) const

Protected Attributes
bool	myViewControlEnabled
DtUnicode	myScreenCaptureFilePath
bool	myMouseHideEnabled
float	myMouseHideTime
bool	myShowQuitDialogOnClose
bool	myDarkModeEnabled
bool	myLightModeDarkModeIconsEnabled
double	myPaperMapLayerTimeout
std::string	myDarkModeStyleSheetsPath
std::string	myLightModeStyleSheetsPath
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< DtApplicationSettingsRecord >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSettingsManager< DtApplicationSettingsRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < DtApplicationSettingsRecord > , DtApplicationSettingsRecord >	RecordBackupType

Constructor & Destructor Documentation

virtual makVrv::DtApplicationSettingsManager::~DtApplicationSettingsManager ( )

virtual

DTOR.

makVrv::DtApplicationSettingsManager::DtApplicationSettingsManager ( DtDe &  )

protected

CTOR.

Member Function Documentation

static DtApplicationSettingsManager& makVrv::DtApplicationSettingsManager::instance ( DtDe &  de )

static

Get an instance of the settings manager.

virtual void makVrv::DtApplicationSettingsManager::setViewControlEnabled ( bool  val )

virtual

Set whether the mouse should be hidden when it hasn't moved for a specified period of time (default 3 seconds)

virtual bool makVrv::DtApplicationSettingsManager::viewControlEnabled ( ) const

virtual

Set whether the mouse should be hidden when it hasn't moved for a specified period of time (default 3 seconds)

virtual void makVrv::DtApplicationSettingsManager::setScreenCaptureFilePath ( const DtUnicode &  filePath )

virtual

Set whether the mouse should be hidden when it hasn't moved for a specified period of time (default 3 seconds)

virtual const DtUnicode& makVrv::DtApplicationSettingsManager::screenCaptureFilePath ( ) const

virtual

Set whether the mouse should be hidden when it hasn't moved for a specified period of time (default 3 seconds)

virtual void makVrv::DtApplicationSettingsManager::setMouseHideEnabled ( bool  enabled )

virtual

Set whether the mouse should be hidden when it hasn't moved for a specified period of time (default 3 seconds)

virtual bool makVrv::DtApplicationSettingsManager::mouseHideEnabled ( ) const

virtual

Set whether the mouse should be hidden when it hasn't moved for a specified period of time.

virtual void makVrv::DtApplicationSettingsManager::setMouseHideTime ( float  hideTime )

virtual

If mouse hide is enabled, set the amount of time to wait for absence of mouse motion.

virtual float makVrv::DtApplicationSettingsManager::mouseHideTime ( ) const

virtual

Set the amount of time to wait for absence of mouse motion.

virtual void makVrv::DtApplicationSettingsManager::setShowQuitDialogOnClose ( bool  show )

virtual

Set whether or not to show the quit dialog on close.

virtual bool makVrv::DtApplicationSettingsManager::showQuitDialogOnClose ( ) const

virtual

Get whether ot not to show the quit dialog on close.

virtual void makVrv::DtApplicationSettingsManager::setDarkModeEnabled ( bool  show )

virtual

Set whether or not dark mode is enabled for the application.

virtual bool makVrv::DtApplicationSettingsManager::darkModeEnabled ( ) const

virtual

Get whether or not dark mode is enabled for the application.

virtual void makVrv::DtApplicationSettingsManager::setLightModeDarkModeIconsEnabled ( bool  show )

virtual

Set whether or not light mode and dark mode icons are used for the application.

virtual bool makVrv::DtApplicationSettingsManager::lightModeDarkModeIconsEnabled ( ) const

virtual

Get whether or not light mode and dark mode icons are used for the application.

virtual void makVrv::DtApplicationSettingsManager::setDarkModeStyleSheetsPath ( const std::string &  darkModeStyleSheetsPath )

virtual

Set the path where the QSS files for Dark Mode are.

virtual std::string makVrv::DtApplicationSettingsManager::darkModeStyleSheetsPath ( ) const

virtual

Get the path where the QSS files for Dark Mode are.

virtual void makVrv::DtApplicationSettingsManager::setLightModeStyleSheetsPath ( const std::string &  lightModeStyleSheetsPath )

virtual

Set the path where the QSS files for Light Mode are.

virtual std::string makVrv::DtApplicationSettingsManager::lightModeStyleSheetsPath ( ) const

virtual

Get the path where the QSS files for Light Mode are.

virtual std::string makVrv::DtApplicationSettingsManager::currentStyleSheetsPath ( ) const

virtual

Get the path that contains the QSS files the application is currently using.

virtual void makVrv::DtApplicationSettingsManager::setPaperMapLayerTimeout ( double  val )

virtual

Set osgEarth layers timeout for paper map groups.

virtual double makVrv::DtApplicationSettingsManager::paperMapLayerTimeout ( ) const

virtual

Get osgEarth layers timeout for paper map groups.

void makVrv::DtApplicationSettingsManager::setFromRecord

(

const DtApplicationSettingsRecord &

rec

)

Set the current settings' state from the given record.

void makVrv::DtApplicationSettingsManager::getRecord

(

DtApplicationSettingsRecord &

rec

)

const

Store the current settings' state in the given record.

virtual bool makVrv::DtApplicationSettingsManager::applyFactoryOverrides ( DtApplicationSettingsRecord &  rec ) const

protectedvirtual

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction ( DtDe &  de, bool  allowedInSlave  )

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction ( DtDe &  de, ManagerClass *  mgr  )

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

boost::signalslib::signal<void ( bool )> makVrv::DtApplicationSettingsManager::signal_viewControlEnabledSet

Signal that indicates whether dark mode has been enabled or disabled.

boost::signalslib::signal<void(DtUnicode)> makVrv::DtApplicationSettingsManager::signal_screenCaptureFilePathChanged

Signal that indicates whether dark mode has been enabled or disabled.

boost::signalslib::signal<void(bool)> makVrv::DtApplicationSettingsManager::signal_mouseHideEnabledChanged

Signal that indicates whether dark mode has been enabled or disabled.

boost::signalslib::signal<void(float)> makVrv::DtApplicationSettingsManager::signal_mouseHideTimeChanged

Signal that indicates whether dark mode has been enabled or disabled.

boost::signalslib::signal<void(bool)> makVrv::DtApplicationSettingsManager::signal_showQuitDialogOnCloseChanged

Signal that indicates whether dark mode has been enabled or disabled.

boost::signalslib::signal<void(bool)> makVrv::DtApplicationSettingsManager::signal_darkModeEnabledChanged

Signal that indicates whether dark mode has been enabled or disabled.

boost::signalslib::signal<void(bool)> makVrv::DtApplicationSettingsManager::signal_lightModeDarkModeIconsEnabledChanged

Signal that indicates whether light/dark mode-specific icons have been enabled or disabled.

boost::signalslib::signal<void()> makVrv::DtApplicationSettingsManager::signal_preCurrentStyleSheetsPathChanged

Signal that indicates the application's stylesheet(s) will be changed This signal is used by some widgets to invalidate its custom properties that the widget retrieves from a stylesheet.

boost::signalslib::signal<void(const std::string&)> makVrv::DtApplicationSettingsManager::signal_currentStyleSheetsPathChanged

Signal that indicates the application's stylesheet(s) are changing to those present at the following path.

boost::signalslib::signal<void()> makVrv::DtApplicationSettingsManager::signal_postCurrentStyleSheetsPathChanged

Signal that indicates the application's stylesheet(s) have changed and been applied. This signal is used by some widgets to re-render its contents based on new custom properties that the widget retrieves from a stylesheet.

boost::signalslib::signal<void(double)> makVrv::DtApplicationSettingsManager::signal_paperMapLayerTimeoutChanged

Signal that indicates whether dark mode has been enabled or disabled.

bool makVrv::DtApplicationSettingsManager::myViewControlEnabled

protected

DtUnicode makVrv::DtApplicationSettingsManager::myScreenCaptureFilePath

protected

bool makVrv::DtApplicationSettingsManager::myMouseHideEnabled

protected

float makVrv::DtApplicationSettingsManager::myMouseHideTime

protected

bool makVrv::DtApplicationSettingsManager::myShowQuitDialogOnClose

protected

bool makVrv::DtApplicationSettingsManager::myDarkModeEnabled

protected

bool makVrv::DtApplicationSettingsManager::myLightModeDarkModeIconsEnabled

protected

double makVrv::DtApplicationSettingsManager::myPaperMapLayerTimeout

protected

std::string makVrv::DtApplicationSettingsManager::myDarkModeStyleSheetsPath

protected

std::string makVrv::DtApplicationSettingsManager::myLightModeStyleSheetsPath

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtApplicationSettingsManager.h