ConfigurationSettings Class Reference
[Services]

Contains settings specific to the user and application run that will be persisted between runs of the application. More...

#include <ConfigurationSettings.h>

Inheritance diagram for ConfigurationSettings:

Inheritance graph

List of all members.

Public Member Functions

virtual std::string getHome () const =0
virtual std::string getCreator () const =0
virtual std::string getProduct () const =0
virtual std::string getVersion () const =0
virtual std::string getBuildRevision () const =0
virtual std::string getUserName () const =0
virtual std::string getUserDocs () const =0
virtual std::string getOperatingSystemName () const =0
virtual std::string getArchitectureName () const =0
virtual bool isProductionRelease () const =0
virtual ReleaseType getReleaseType () const =0
virtual std::string getReleaseDescription () const =0
virtual std::string getPlugInPath () const =0
template<typename T>
bool setSetting (const std::string &key, const T &var, bool setIfSame=false)
virtual bool adoptSetting (const std::string &key, DataVariant &var, bool setIfSame=false)=0
template<typename T>
bool setTemporarySetting (const std::string &key, const T &var)
virtual bool adoptTemporarySetting (const std::string &key, DataVariant &var)=0
virtual const DataVariant & getSetting (const std::string &key) const =0
virtual bool isUserSetting (const std::string &key) const =0
virtual bool isTemporarySetting (const std::string &key) const =0
virtual bool isDefaultSetting (const std::string &key) const =0
virtual void deleteUserSetting (const std::string &key)=0
virtual void deleteTemporarySetting (const std::string &key)=0
virtual void copySetting (const std::string &key, DynamicObject *pObject) const =0
virtual bool serializeAsDefaults (const Filename *pFilename, const DynamicObject *pObject) const =0
virtual DynamicObject * deserialize (const Filename *pFilename) const =0

Static Public Member Functions

static const std::string & signalSettingModified ()
static const std::string & signalAboutToSave ()
static const Filename * getSettingExtensionFilesPath ()
static bool hasSettingExtensionFilesPath ()
static void setSettingExtensionFilesPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingExtensionFilesPathKey ()
static const Filename * getSettingExportPath ()
static bool hasSettingExportPath ()
static void setSettingExportPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingExportPathKey ()
static const Filename * getSettingImportPath ()
static bool hasSettingImportPath ()
static void setSettingImportPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingImportPathKey ()
static const Filename * getSettingSaveOpenSessionPath ()
static bool hasSettingSaveOpenSessionPath ()
static void setSettingSaveOpenSessionPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingSaveOpenSessionPathKey ()
static const Filename * getSettingInternalPath ()
static bool hasSettingInternalPath ()
static void setSettingInternalPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingInternalPathKey ()
static std::vector< Filename * > getSettingPathBookmarks ()
static bool hasSettingPathBookmarks ()
static void setSettingPathBookmarks (std::vector< Filename * > newValue, bool setIfSame=false)
static std::string getSettingPathBookmarksKey ()
static const Filename * getSettingMessageLogPath ()
static bool hasSettingMessageLogPath ()
static void setSettingMessageLogPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingMessageLogPathKey ()
static unsigned int getSettingNumberOfMruFiles ()
static bool hasSettingNumberOfMruFiles ()
static void setSettingNumberOfMruFiles (unsigned int newValue, bool setIfSame=false)
static std::string getSettingNumberOfMruFilesKey ()
static const Filename * getSettingSupportFilesPath ()
static bool hasSettingSupportFilesPath ()
static void setSettingSupportFilesPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingSupportFilesPathKey ()
static bool getSettingShowStatusBarCubeValue ()
static bool hasSettingShowStatusBarCubeValue ()
static void setSettingShowStatusBarCubeValue (bool newValue, bool setIfSame=false)
static std::string getSettingShowStatusBarCubeValueKey ()
static bool getSettingShowStatusBarElevationValue ()
static bool hasSettingShowStatusBarElevationValue ()
static void setSettingShowStatusBarElevationValue (bool newValue, bool setIfSame=false)
static std::string getSettingShowStatusBarElevationValueKey ()
static bool getSettingShowStatusBarGeoCoords ()
static bool hasSettingShowStatusBarGeoCoords ()
static void setSettingShowStatusBarGeoCoords (bool newValue, bool setIfSame=false)
static std::string getSettingShowStatusBarGeoCoordsKey ()
static bool getSettingShowStatusBarPixelCoords ()
static bool hasSettingShowStatusBarPixelCoords ()
static void setSettingShowStatusBarPixelCoords (bool newValue, bool setIfSame=false)
static std::string getSettingShowStatusBarPixelCoordsKey ()
static bool getSettingShowStatusBarResultValue ()
static bool hasSettingShowStatusBarResultValue ()
static void setSettingShowStatusBarResultValue (bool newValue, bool setIfSame=false)
static std::string getSettingShowStatusBarResultValueKey ()
static bool getSettingShowStatusBarRotationValue ()
static bool hasSettingShowStatusBarRotationValue ()
static void setSettingShowStatusBarRotationValue (bool newValue, bool setIfSame=false)
static std::string getSettingShowStatusBarRotationValueKey ()
static const Filename * getSettingTempPath ()
static bool hasSettingTempPath ()
static void setSettingTempPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingTempPathKey ()
static unsigned int getSettingThreadCount ()
static bool hasSettingThreadCount ()
static void setSettingThreadCount (unsigned int newValue, bool setIfSame=false)
static std::string getSettingThreadCountKey ()
static unsigned int getSettingUndoBufferSize ()
static bool hasSettingUndoBufferSize ()
static void setSettingUndoBufferSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingUndoBufferSizeKey ()
static const Filename * getSettingWizardPath ()
static bool hasSettingWizardPath ()
static void setSettingWizardPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingWizardPathKey ()
static const Filename * getSettingTextEditor ()
static bool hasSettingTextEditor ()
static void setSettingTextEditor (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingTextEditorKey ()
static std::string getSettingTextEditorArguments ()
static bool hasSettingTextEditorArguments ()
static void setSettingTextEditorArguments (std::string newValue, bool setIfSame=false)
static std::string getSettingTextEditorArgumentsKey ()
static const Filename * getSettingJvmLoaderLibraryPath ()
static bool hasSettingJvmLoaderLibraryPath ()
static void setSettingJvmLoaderLibraryPath (Filename *pNewValue, bool setIfSame=false)
static std::string getSettingJvmLoaderLibraryPathKey ()
static const Filename * getSettingPluginWorkingDirectory (const std::string &namespaceStr)
static bool hasSettingPluginWorkingDirectory (const std::string &namespaceStr)
static void setSettingPluginWorkingDirectory (const std::string &namespaceStr, Filename *pNewValue, bool setIfSame=false)
static std::string getSettingPluginWorkingDirectoryKey (const std::string &namespaceStr)
static bool getSettingAlternateMouseWheelZoom ()
static bool hasSettingAlternateMouseWheelZoom ()
static void setSettingAlternateMouseWheelZoom (bool newValue, bool setIfSame=false)
static std::string getSettingAlternateMouseWheelZoomKey ()
static unsigned int getSettingGpuTextureCacheSize ()
static bool hasSettingGpuTextureCacheSize ()
static void setSettingGpuTextureCacheSize (unsigned int newValue, bool setIfSame=false)
static std::string getSettingGpuTextureCacheSizeKey ()
static bool getSettingDisplayClassificationMarkings ()
static bool hasSettingDisplayClassificationMarkings ()
static void setSettingDisplayClassificationMarkings (bool newValue, bool setIfSame=false)
static std::string getSettingDisplayClassificationMarkingsKey ()

Protected Member Functions

virtual ~ConfigurationSettings ()

Detailed Description

Contains settings specific to the user and application run that will be persisted between runs of the application.

The configuration settings allow data values to be stored per-user and during an application run. Settings which are saved per-user and persist between application runs are called per-user settings. Settings which only exist during one application run are called per-session or temporary settings.

These settings are initialized on application startup. This is done by locating any .cfg files contained in getHome()/DefaultSettings and the directory defined by the AdditionalDefaultDir value of the deployment file. Please see Using deployment files to control the plug-in path, support files, default settings and user settings for more details. These .cfg files must follow the naming convention of "[LoadOrder]-[Name].cfg" where LoadOrder is an unsigned int and Name can be any text recognized by the file system. These .cfg's are then parsed according to the LoadOrder, with 1 reserved for the application and being the first .cfg that will be parsed. After these files are parsed, there is a .cfg file for the user that is running the application that will be parsed and created as per-user settings.

The directory that is used to store per-user settings can be controlled by a plug-in developer by creating a deployment file. See Using deployment files to control the plug-in path, support files, default settings and user settings for more details.

The configuration settings can also be used to allow the Studio to create PlugInArg objects prior to plug-in execution. If the plug-in args cannot be defined, the configuration setting are queried for specific values using the plug-in name for the Setting group name.

This subclass of Subject will notify upon the following conditions:

Definition at line 322 of file ConfigurationSettings.h.

Constructor & Destructor Documentation

virtual ConfigurationSettings::~ConfigurationSettings (  )  [protected, virtual]

This will be cleaned up during application close.

Plug-ins do not need to destroy it.

Definition at line 1810 of file ConfigurationSettings.h.

Member Function Documentation

static const std::string& ConfigurationSettings::signalSettingModified (  )  [static]

Emitted with any<std::string> when setSetting or setTemporarySetting is called.

The string will be the key of the setting that was modified.

Definition at line 329 of file ConfigurationSettings.h.

static const std::string& ConfigurationSettings::signalAboutToSave (  )  [static]

Emitted with no data just prior to save of the configuration settings to disk.

Definition at line 334 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingExtensionFilesPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 344 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingExtensionFilesPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 351 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingExtensionFilesPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 367 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingExtensionFilesPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 375 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingExportPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 384 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingExportPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 391 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingExportPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 407 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingExportPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 415 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingImportPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 424 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingImportPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 431 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingImportPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 447 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingImportPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 455 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingSaveOpenSessionPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 464 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingSaveOpenSessionPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 471 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingSaveOpenSessionPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 487 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingSaveOpenSessionPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 495 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingInternalPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 504 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingInternalPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 511 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingInternalPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 527 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingInternalPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 535 of file ConfigurationSettings.h.

static std::vector<Filename*> ConfigurationSettings::getSettingPathBookmarks (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 546 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingPathBookmarks (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 553 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingPathBookmarks ( std::vector< Filename * >  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 569 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingPathBookmarksKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 577 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingMessageLogPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 586 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingMessageLogPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 593 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingMessageLogPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 609 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingMessageLogPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 617 of file ConfigurationSettings.h.

static unsigned int ConfigurationSettings::getSettingNumberOfMruFiles (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 628 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingNumberOfMruFiles (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 635 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingNumberOfMruFiles ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 651 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingNumberOfMruFilesKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 659 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingSupportFilesPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 668 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingSupportFilesPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 675 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingSupportFilesPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 691 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingSupportFilesPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 699 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingShowStatusBarCubeValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 710 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingShowStatusBarCubeValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 717 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingShowStatusBarCubeValue ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 733 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingShowStatusBarCubeValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 741 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingShowStatusBarElevationValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 752 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingShowStatusBarElevationValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 759 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingShowStatusBarElevationValue ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 775 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingShowStatusBarElevationValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 783 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingShowStatusBarGeoCoords (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 794 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingShowStatusBarGeoCoords (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 801 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingShowStatusBarGeoCoords ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 817 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingShowStatusBarGeoCoordsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 825 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingShowStatusBarPixelCoords (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 836 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingShowStatusBarPixelCoords (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 843 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingShowStatusBarPixelCoords ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 859 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingShowStatusBarPixelCoordsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 867 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingShowStatusBarResultValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 878 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingShowStatusBarResultValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 885 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingShowStatusBarResultValue ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 901 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingShowStatusBarResultValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 909 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingShowStatusBarRotationValue (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 920 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingShowStatusBarRotationValue (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 927 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingShowStatusBarRotationValue ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 943 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingShowStatusBarRotationValueKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 951 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingTempPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 960 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingTempPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 967 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingTempPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 983 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingTempPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 991 of file ConfigurationSettings.h.

static unsigned int ConfigurationSettings::getSettingThreadCount (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1002 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingThreadCount (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1009 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingThreadCount ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1025 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingThreadCountKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1033 of file ConfigurationSettings.h.

static unsigned int ConfigurationSettings::getSettingUndoBufferSize (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1044 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingUndoBufferSize (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1051 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingUndoBufferSize ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1067 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingUndoBufferSizeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1075 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingWizardPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 1084 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingWizardPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1091 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingWizardPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 1107 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingWizardPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1115 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingTextEditor (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 1124 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingTextEditor (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1131 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingTextEditor ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 1147 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingTextEditorKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1155 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingTextEditorArguments (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1166 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingTextEditorArguments (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1173 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingTextEditorArguments ( std::string  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1189 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingTextEditorArgumentsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1197 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingJvmLoaderLibraryPath (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Returns:
the current value for this setting or NULL if not found.

Definition at line 1206 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingJvmLoaderLibraryPath (  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1213 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingJvmLoaderLibraryPath ( Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 1229 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingJvmLoaderLibraryPathKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1237 of file ConfigurationSettings.h.

static const Filename* ConfigurationSettings::getSettingPluginWorkingDirectory ( const std::string &  namespaceStr  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a NULL value will be returned.

Please see Settings Macros for more details

Parameters:
namespaceStr This string will be used to create a unique identifier for this particular setting so that it can be stored and retrieved from ConfigurationSettings.
Returns:
the current value for this setting or NULL if not found.

Definition at line 1251 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingPluginWorkingDirectory ( const std::string &  namespaceStr  )  [static]

Returns true if this setting exists in ConfigurationSettings.

It may still be NULL however.

Please see Settings Macros for more details

Parameters:
namespaceStr This string will be used to create a unique identifier for this particular setting so that it can be stored and retrieved from ConfigurationSettings.
Returns:
true if this setting exists, false otherwise.

Definition at line 1263 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingPluginWorkingDirectory ( const std::string &  namespaceStr,
Filename *  pNewValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
namespaceStr This string will be used to create a unique identifier for this particular setting so that it can be stored and retrieved from ConfigurationSettings.
pNewValue the new value for this setting. If NULL, the value will not be set.
setIfSame If true, the value will be set into ConfigurationSettings even if the pNewValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the pNewValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the pNewValue is unique to the user.

Definition at line 1283 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingPluginWorkingDirectoryKey ( const std::string &  namespaceStr  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Parameters:
namespaceStr This string will be used to create a unique identifier for this particular setting so that it can be stored and retrieved from ConfigurationSettings.
Returns:
the key used for this setting.

Definition at line 1296 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingAlternateMouseWheelZoom (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1307 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingAlternateMouseWheelZoom (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1314 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingAlternateMouseWheelZoom ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1330 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingAlternateMouseWheelZoomKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1338 of file ConfigurationSettings.h.

static unsigned int ConfigurationSettings::getSettingGpuTextureCacheSize (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1349 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingGpuTextureCacheSize (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1356 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingGpuTextureCacheSize ( unsigned int  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1372 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingGpuTextureCacheSizeKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1380 of file ConfigurationSettings.h.

static bool ConfigurationSettings::getSettingDisplayClassificationMarkings (  )  [static]

Returns the current value for this setting.

If this setting does not exist in ConfigurationSettings, a verification error will be logged to the message log and potentially a verification error message box will be displayed to the user.

Please see Settings Macros for more details

Returns:
the current value for this setting.

Definition at line 1391 of file ConfigurationSettings.h.

static bool ConfigurationSettings::hasSettingDisplayClassificationMarkings (  )  [static]

Returns true if this setting exists and has a value in ConfigurationSettings.

Please see Settings Macros for more details

Returns:
true if this setting exists, false otherwise.

Definition at line 1398 of file ConfigurationSettings.h.

static void ConfigurationSettings::setSettingDisplayClassificationMarkings ( bool  newValue,
bool  setIfSame = false 
) [static]

Changes the current value of this setting to the new value.

Please see Settings Macros for more details

Parameters:
newValue the new value for this setting.
setIfSame If true, the value will be set into ConfigurationSettings even if the newValue and existing value are the same. This has the side-effect of making the value a per-user setting and stored in the user's configuration file. If false, this value will only be set if the newValue and existing value are different. Therefore the value will only be stored in the user's configuration file if the newValue is unique to the user.

Definition at line 1414 of file ConfigurationSettings.h.

static std::string ConfigurationSettings::getSettingDisplayClassificationMarkingsKey (  )  [static]

Returns the key for this setting that could be passed to ConfigurationSettings::getSetting() or ConfigurationSettings::setSetting().

Please see Settings Macros for more details

Returns:
the key used for this setting.

Definition at line 1422 of file ConfigurationSettings.h.

virtual std::string ConfigurationSettings::getHome (  )  const [pure virtual]

Gets the root directory for the main application.

This method returns the fully qualified path for the base of the directory tree associated with the main application.

This path can be adjusted by a plug-in developer by creating a deployment file. See Using deployment files to control the plug-in path, support files, default settings and user settings for more details.

Returns:
Base folder for the main application.

virtual std::string ConfigurationSettings::getCreator (  )  const [pure virtual]

Gets the application creator.

Returns:
The application creator.

virtual std::string ConfigurationSettings::getProduct (  )  const [pure virtual]

Gets the application name.

Returns:
The application name.

virtual std::string ConfigurationSettings::getVersion (  )  const [pure virtual]

Gets the application version.

Returns:
The application version.

virtual std::string ConfigurationSettings::getBuildRevision (  )  const [pure virtual]

Gets the build revision of the application.

Returns:
The build revision.

virtual std::string ConfigurationSettings::getUserName (  )  const [pure virtual]

Gets the username of the user currently running the application.

Returns:
The username of the current user.

virtual std::string ConfigurationSettings::getUserDocs (  )  const [pure virtual]

Gets the path to the user's documents folder.

Returns:
The full path to the current user's documents folder. On Windows this is usually C:\Documents and Settings\username\My Documents\Opticks and on Solaris it is usually /export/home/username/Opticks.

virtual std::string ConfigurationSettings::getOperatingSystemName (  )  const [pure virtual]

Gets the operating system name.

Returns the general operating system name that the application was compiled against. (ie. "Solaris" or "Windows") This name should only be used within the context of the application and is not intended to be passed to any system api's or used to conditionally execute code, see AppConfig.h for that. This name is also not guaranteed to match any similiar operating system name returned by using system calls.

Returns:
The operating system name.

virtual std::string ConfigurationSettings::getArchitectureName (  )  const [pure virtual]

Gets the architecture name.

Returns the general architecture name that the application was compiled to work with. (ie. "x86-64", "Sparc64") This name should only be used within the context of the application and is not intended to be passed to any system api's or used to conditionally execute code, see AppConfig.h for that. This name is also not guaranteed to match any similiar architecture name returned by using system calls.

Returns:
The architecture name.

virtual bool ConfigurationSettings::isProductionRelease (  )  const [pure virtual]

Gets the production status.

Returns:
true if the application and all plug-ins are production.

virtual ReleaseType ConfigurationSettings::getReleaseType (  )  const [pure virtual]

Gets the release type.

Returns:
An enum describing the release type.

virtual std::string ConfigurationSettings::getReleaseDescription (  )  const [pure virtual]

Gets the release description.

Returns:
A string describing the release.

virtual std::string ConfigurationSettings::getPlugInPath (  )  const [pure virtual]

Gets the plug-in path.

This is the directory where plug-ins must be placed if they are to be loaded by the application.

This path can be adjusted by a plug-in developer by creating a deployment file. See Using deployment files to control the plug-in path, support files, default settings and user settings for more details.

Returns:
The plug-in path.

template<typename T>
bool ConfigurationSettings::setSetting ( const std::string &  key,
const T &  var,
bool  setIfSame = false 
)

Sets the given setting.

This method sets the given setting. If the setting already exists, the data is simply replaced. If the setting does not exist, it is created. This setting will be saved into the user's configuration file during application shutdown meaning the particular value set for this setting will be a per-user value. If the given setting was previously set with setTemporarySetting(), it will no longer be a temporary setting and will become a per-user setting.

This method is preferred to adoptSetting() unless you are passing an already constructed DataVariant in which case, adoptSetting() will be faster because it avoids a deep copy.

Parameters:
key The name of the setting. This key can have '/' in it, in which it will behave like DynamicObject::setAttributeByPath.
var The value of the setting. If this is invalid, no setting will be added or modified.
setIfSame If false, the setting will not be set if the new value of the setting is equal to the current value (ie. getSetting()) for the setting (ie. the value will not be serialized to the user's configuration file). If true, the setting will be set regardless of the current value (ie. it will be serialized to the user's configuration file).
Returns:
true if the setting was successfully set, and false otherwise.
See also:
DynamicObject::setAttribute, adoptSetting()

Definition at line 1583 of file ConfigurationSettings.h.

virtual bool ConfigurationSettings::adoptSetting ( const std::string &  key,
DataVariant &  var,
bool  setIfSame = false 
) [pure virtual]

Sets the given setting.

This method sets the given setting. If the setting already exists, the data is simply replaced. If the setting does not exist, it is created. This setting will be saved into the user's configuration file during application shutdown meaning the particular value set for this setting will be a per-user value. If the given setting was previously set with setTemporarySetting(), it will no longer be a temporary setting and will become a per-user setting.

This method should not be used; generally setSetting() is preferred. This method and setSetting() have identical performance characteristics and setSetting() is easier to call. This method is faster than setSetting() though if you have an already constructed DataVariant and is preferred to setSetting() in this case.

Parameters:
key The name of the setting. This key can have '/' in it, in which it will behave like DynamicObject::setAttributeByPath.
var The value of the setting. If this is invalid, no setting will be added or modified. On return, this will contain the value previously stored. If the value did not previously exist, then this will contain an invalid DataVariant.
setIfSame If false, the setting will not be set if the new value of the setting is equal to the current value (ie. getSetting()) for the setting (ie. the value will not be serialized to the user's configuration file). If true, the setting will be set regardless of the current value (ie. it will be serialized to the user's configuration file).
Returns:
true if the setting was successfully set, and false otherwise.
See also:
DynamicObject::adoptAttribute, setSetting()

template<typename T>
bool ConfigurationSettings::setTemporarySetting ( const std::string &  key,
const T &  var 
)

Sets the given setting for this session only.

Any value set using this method will only be valid while the application is running. The value set using this method will not be saved during a session save, and will not be restored during a session restore. If a plug-in sets a value using this method and needs the value saved/restored during session save/restore, it is the responsibility of the plug-in to save/restore the value during session save/restore.

This method is preferred to adoptTemporarySetting() unless you are passing an already constructed DataVariant in which case, adoptTemporarySetting() will be faster because it avoids a deep copy.

Parameters:
key The name of the setting. This key can have '/' in it, in which it will behave like DynamicObject::setAttributeByPath.
var The value of the setting. If this is invalid, no setting will be added or modified.
Returns:
true if the setting was successfully set, and false otherwise.

Definition at line 1654 of file ConfigurationSettings.h.

virtual bool ConfigurationSettings::adoptTemporarySetting ( const std::string &  key,
DataVariant &  var 
) [pure virtual]

Sets the given setting for this session only.

Any value set using this method will only be valid while the application is running. The value set using this method will not be saved during a session save, and will not be restored during a session restore. If a plug-in sets a value using this method and needs the value saved/restored during session save/restore, it is the responsibility of the plug-in to save/restore the value during session save/restore.

This method should not be used; generally setTemporarySetting() is preferred. This method and setTemporarySetting() have identical performance characteristics and setTemporarySetting() is easier to call. This method is faster than setTemporarySetting() though if you have an already constructed DataVariant and is preferred to setTemporarySetting() in this case.

Parameters:
key The name of the setting. This key can have '/' in it, in which it will behave like DynamicObject::setAttributeByPath.
var The value of the setting. If this is invalid, no setting will be added or modified. On return, this will contain the value previously stored. If the value did not previously exist, then this will contain an invalid DataVariant.
Returns:
true if the setting was successfully set, and false otherwise.

virtual const DataVariant& ConfigurationSettings::getSetting ( const std::string &  key  )  const [pure virtual]

Gets the current value for the given setting.

The value returned will be located in the following order: temporary setting, per-user setting and default setting.

See also:
setTemporarySetting(), setSetting()
Parameters:
key Name of the setting to be found. This key can have '/' in it, in which case it will behave like DynamicObject::getAttributeByPath.
Returns:
The setting in a DataVariant. If the setting was not found, an invalid DataVariant will be returned.

virtual bool ConfigurationSettings::isUserSetting ( const std::string &  key  )  const [pure virtual]

Queries whether a given setting has a per-user value defined.

Parameters:
key Name of the setting to be found. This key can have '/' in it, in which case it will behave like DynamicObject::getAttributeByPath.
Returns:
true if this particular setting has a per-user value set and does not have a per-session value set.

virtual bool ConfigurationSettings::isTemporarySetting ( const std::string &  key  )  const [pure virtual]

Queries whether a given setting has been set using setTemporarySetting().

Parameters:
key Name of the setting to be found. This key can have '/' in it, in which case it will behave like DynamicObject::getAttributeByPath.
Returns:
true if this particular setting has been set using setTemporarySetting().

virtual bool ConfigurationSettings::isDefaultSetting ( const std::string &  key  )  const [pure virtual]

Queries whether a given setting is the default value, i.e.

it has not been overridden by the user or by calling setTemporarySetting().

Parameters:
key Name of the setting to be found. This key can have '/' in it, in which case it will behave like DynamicObject::getAttributeByPath.
Returns:
true if this particular setting is the default value.

virtual void ConfigurationSettings::deleteUserSetting ( const std::string &  key  )  [pure virtual]

Removes a per-user setting.

See getSetting() for more details.

Parameters:
key Name of the setting to be deleted.

virtual void ConfigurationSettings::deleteTemporarySetting ( const std::string &  key  )  [pure virtual]

Removes a per-session temporary setting.

See getSetting() for more details.

Parameters:
key Name of the setting to be deleted.

virtual void ConfigurationSettings::copySetting ( const std::string &  key,
DynamicObject *  pObject 
) const [pure virtual]

Copies the value of the given setting into the provided DynamicObject.

This method is intended to be used when creating default files, so a plug-in developer can copy a setting into a DynamicObject which can be written to a defaults file using serializeAsDefaults().

Parameters:
key Name of the setting to copy into the DynamicObject.
pObject The DynamicObject that the setting should be copied into. It will be copied in, such that it can be retrieved by calling pObject->getAttributeByPath(group + "/" + key);

virtual bool ConfigurationSettings::serializeAsDefaults ( const Filename *  pFilename,
const DynamicObject *  pObject 
) const [pure virtual]

Saves the given DynamicObject values into a .cfg file that could be put into the AppHome/DefaultSettings directory and be used as defaults by the application.

Parameters:
pFilename The full path of the file where the dynamic object should be saved.
pObject The settings that should be saved into the file.
Returns:
true if the save was successful, otherwise false.

virtual DynamicObject* ConfigurationSettings::deserialize ( const Filename *  pFilename  )  const [pure virtual]

Loads the given settings from the file and return them as a DynamicObject.

The load settings are simply returned as a dynamic object, existing setting values are left unchanged.

Parameters:
pFilename the full path to the file containing the settings.
Returns:
A dynamic object containing the loaded settings or NULL if the settings could not be loaded.

Software Development Kit - Opticks 4.9.0 Build 16218