Settings Class Reference

Application-wide settings mechanism. More...

#include <settings.h>

Collaboration diagram for Settings:

Public Types
enum	Type { Portable, NonPortable }
	Describes possible types of loaded settings.

Public Member Functions
Type	type () const
	Type of used settings. More...
QVariant	value (const QString &section, const QString &key, const QVariant &default_value=QVariant())
	Getter/setter for settings values. More...
void	setValue (const QString &section, const QString &key, const QVariant &value)
	Sets new value into settings. More...
QSettings::Status	checkSettings ()
	Synchronizes settings. More...

Static Public Member Functions
static Settings *	setupSettings (QObject *parent)
	Creates settings file in correct location. More...

Detailed Description

Application-wide settings mechanism.

Definition at line 40 of file settings.h.

Member Function Documentation

QSettings::Status Settings::checkSettings

(

)

Synchronizes settings.

Returns

Returns state of settings.

Definition at line 50 of file settings.cpp.

                                        {
  qDebug("Syncing settings.");

  sync();
  return status();
}

Settings * Settings::setupSettings ( QObject *  parent )

static

Creates settings file in correct location.

Parameters

parent

Parent object.

Returns

Returns pointer to new settings.

Definition at line 57 of file settings.cpp.

                                                 {
  Settings *new_settings;

  // If settings file exists in executable file working directory
  // (in subdirectory APP_CFG_PATH), then use it (portable settings).
  // Otherwise use settings file stored in homePath();
  QString relative_path = QDir::separator() + QString(APP_CFG_PATH) +
                          QDir::separator() + QString(APP_CFG_FILE);

  QString app_path = qApp->applicationDirPath();
  QString app_path_file = app_path + relative_path;

  // Check if portable settings are available.
  if (QFile(app_path_file).exists()) {
    // Portable settings are available, use them.
    new_settings = new Settings(app_path_file, QSettings::IniFormat,
                                Settings::Portable, parent);

    qDebug("Initializing settings in '%s' (portable way).",
           qPrintable(QDir::toNativeSeparators(app_path_file)));
  }
  else {
    // Portable settings are NOT available, store them in
    // user's home directory.
    QString home_path = QDir::homePath() + QDir::separator() +
                        QString(APP_LOW_H_NAME);
    QString home_path_file = home_path + relative_path;

    new_settings = new Settings(home_path_file, QSettings::IniFormat,
                                Settings::NonPortable, parent);

    qDebug("Initializing settings in '%s' (non-portable way).",
           qPrintable(QDir::toNativeSeparators(home_path_file)));
  }

  return new_settings;
}

Here is the caller graph for this function:

void Settings::setValue ( const QString &  section, const QString &  key, const QVariant &  value  )

inline

Sets new value into settings.

Parameters

section	Section in the settings.
key	Key.
value	New value.

Definition at line 74 of file settings.h.

                                                {
      QSettings::setValue(QString("%1/%2").arg(section, key), value);
    }

Here is the caller graph for this function:

Type Settings::type ( ) const

inline

Type of used settings.

Returns

Returns type of used settings.

Definition at line 55 of file settings.h.

                             {
      return m_initializationStatus;
    }

QVariant Settings::value ( const QString &  section, const QString &  key, const QVariant &  default_value = QVariant()  )

inline

Getter/setter for settings values.

Parameters

section	Section in the settings.
key	Key of setting.
default_value	Default value to be used if no value exists for given key.

Returns

Returns found value, default value or empty variant value.

Definition at line 64 of file settings.h.

                                                                      {
      return QSettings::value(QString("%1/%2").arg(section, key), default_value);
    }

Here is the caller graph for this function:

---

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

• settings.h
• settings.cpp