A singleton for managing application settings applied to the whole system (all users). More...
#include <SystemApplicationSettings.h>
Public Types | |
typedef ObjectLevelLockingPolicy < ::boost::lock_guard < ::boost::recursive_mutex > > | LockRead |
typedef ObjectLevelLockingPolicy < ::boost::lock_guard < ::boost::recursive_mutex > > | LockWrite |
typedef volatile ApplicationSettings | VolatileType |
Public Member Functions | |
void | changed () |
This method can be used by clients to inform manually that the internal state has changed. More... | |
const boost::property_tree::ptree & | getAllSettings () const |
It return a reading reference to the internal settings. More... | |
boost::property_tree::ptree & | getAllSettings () |
It return a reference to the internal settings. More... | |
std::string | getValue (const std::string &key) |
It returns the value for a given key or empty. More... | |
void | load () |
It tries to find a default config file based on system macros and default condigurations. More... | |
void | load (const std::string &fileName) |
It loads the setting from the given file. More... | |
void | setValue (const std::string &key, const std::string &value) |
It stores the value according to the key. More... | |
void | update () |
It updates the application settings. More... | |
Static Public Member Functions | |
static T & | getInstance () |
It returns a reference to the singleton instance. More... | |
Protected Member Functions | |
SystemApplicationSettings () | |
It initializes the singleton. More... | |
~SystemApplicationSettings () | |
Destructor. More... | |
Protected Attributes | |
bool | m_dirty |
A dirty bit to indicate wheter the clients have made changes in the settings since the last update. More... | |
std::string | m_file |
The settings file name. More... | |
boost::property_tree::ptree | m_settings |
This will keep our settings in memory. More... | |
Friends | |
class | Singleton< SystemApplicationSettings > |
A singleton for managing application settings applied to the whole system (all users).
This singleton can be used to keep the application configuration.
It will look for an application configuration file as follows:
Definition at line 53 of file SystemApplicationSettings.h.
|
inherited |
Definition at line 205 of file ThreadingPolicies.h.
|
inherited |
Definition at line 206 of file ThreadingPolicies.h.
|
inherited |
Definition at line 204 of file ThreadingPolicies.h.
|
protected |
It initializes the singleton.
Definition at line 97 of file SystemApplicationSettings.cpp.
|
protected |
Destructor.
Definition at line 101 of file SystemApplicationSettings.cpp.
|
inlineinherited |
This method can be used by clients to inform manually that the internal state has changed.
This method is useful when accessing the internal settings structure.
Definition at line 236 of file ApplicationSettings.h.
References te::common::ApplicationSettings::m_dirty.
Referenced by te::qt::af::UpdateUserSettings().
|
inlineinherited |
It return a reading reference to the internal settings.
Definition at line 243 of file ApplicationSettings.h.
References te::common::ApplicationSettings::m_settings.
Referenced by te::qt::af::ApplicationController::initializeProjectMenus(), te::qt::af::UserPlugins::load(), and te::qt::af::UpdateUserSettings().
|
inlineinherited |
It return a reference to the internal settings.
Definition at line 248 of file ApplicationSettings.h.
References te::common::ApplicationSettings::m_settings.
|
inlinestaticinherited |
It returns a reference to the singleton instance.
Definition at line 120 of file Singleton.h.
Referenced by BinaryLogicOpReader(), BinaryLogicOpWriter(), te::map::AbstractLayerRenderer::buildChart(), te::common::TaskProgress::cancel(), te::qt::widgets::SegmenterWizard::execute(), te::qt::widgets::Module::initialize(), te::qt::af::ApplicationController::initialize(), te::qt::af::ApplicationController::initializePlugins(), te::common::UserApplicationSettings::load(), te::qt::af::ApplicationPlugins::load(), te::qt::af::BaseApplication::makeDialog(), te::vp::IntersectionDialog::onOkPushButtonClicked(), te::vp::BufferDialog::onOkPushButtonClicked(), te::vp::AggregationDialog::onOkPushButtonClicked(), te::qt::af::BaseApplication::onStopDrawTriggered(), te::serialize::ReadFilter(), te::common::TaskProgress::setCurrentStep(), te::common::TaskProgress::setMessage(), te::color::ColorSchemeCatalog::setName(), te::common::TaskProgress::setTotalSteps(), te::common::TaskProgress::TaskProgress(), UnaryLogicOpReader(), UnaryLogicOpWriter(), and te::common::TaskProgress::~TaskProgress().
|
inlineinherited |
It returns the value for a given key or empty.
key | The key used to identify the searched value. |
Definition at line 189 of file ApplicationSettings.h.
References te::common::ApplicationSettings::m_settings.
Referenced by te::qt::af::ApplicationController::initialize(), and te::qt::af::SaveDataSourcesFile().
void te::common::SystemApplicationSettings::load | ( | ) |
It tries to find a default config file based on system macros and default condigurations.
Definition at line 38 of file SystemApplicationSettings.cpp.
References te::common::Singleton< OSSettingsDir >::getInstance(), te::common::OSSettingsDir::getSystemSettingsPath(), TERRALIB_CONFIG_DIR, TERRALIB_DIR, TERRALIB_DIR_ENVVAR, TERRALIB_SYSTEM_SETTINGS_FILE, and TR_COMMON.
void te::common::SystemApplicationSettings::load | ( | const std::string & | fileName | ) |
It loads the setting from the given file.
fileName | It must be the full path to the settings file. |
Definition at line 92 of file SystemApplicationSettings.cpp.
References te::common::ApplicationSettings::load().
|
inlineinherited |
It stores the value according to the key.
key | The key used to identify the given value. The key must follow the same rules as XML elements and they can be subclassified using a dot notation: setValue(key.subkey.subsubkey, value). |
value | The value to be stored, any valid string. |
Definition at line 181 of file ApplicationSettings.h.
References te::common::ApplicationSettings::m_dirty, and te::common::ApplicationSettings::m_settings.
|
inlineinherited |
It updates the application settings.
Definition at line 215 of file ApplicationSettings.h.
References te::common::ApplicationSettings::m_dirty, te::common::ApplicationSettings::m_file, and te::common::ApplicationSettings::m_settings.
Referenced by te::common::ApplicationSettings::~ApplicationSettings().
|
friend |
Definition at line 56 of file SystemApplicationSettings.h.
|
protectedinherited |
A dirty bit to indicate wheter the clients have made changes in the settings since the last update.
Definition at line 167 of file ApplicationSettings.h.
Referenced by te::common::ApplicationSettings::changed(), te::common::ApplicationSettings::load(), te::common::ApplicationSettings::setValue(), and te::common::ApplicationSettings::update().
|
protectedinherited |
The settings file name.
Definition at line 166 of file ApplicationSettings.h.
Referenced by te::common::ApplicationSettings::load(), and te::common::ApplicationSettings::update().
|
protectedinherited |
This will keep our settings in memory.
Definition at line 165 of file ApplicationSettings.h.
Referenced by te::common::ApplicationSettings::getAllSettings(), te::common::ApplicationSettings::getValue(), te::common::ApplicationSettings::load(), te::common::ApplicationSettings::setValue(), and te::common::ApplicationSettings::update().