QSettings Class Reference

     QSettings settings("MySoft", "Star Runner");

     QCoreApplication::setOrganizationName("MySoft");
     QCoreApplication::setOrganizationDomain("mysoft.com");
     QCoreApplication::setApplicationName("Star Runner");
     ...
     QSettings settings;

     settings.setValue("editor/wrapMargin", 68);

     int margin = settings.value("editor/wrapMargin").toInt();

     int margin = settings.value("editor/wrapMargin", 80).toInt();

 QSettings settings("MySoft", "Star Runner");
 QColor color = settings.value("DataPump/bgcolor").value<QColor>();

 QSettings settings("MySoft", "Star Runner");
 QColor color = palette().background().color();
 settings.setValue("DataPump/bgcolor", color);

     settings.setValue("mainwindow/size", win->size());
     settings.setValue("mainwindow/fullScreen", win->isFullScreen());
     settings.setValue("outputpanel/visible", panel->isVisible());

     settings.beginGroup("mainwindow");
     settings.setValue("size", win->size());
     settings.setValue("fullScreen", win->isFullScreen());
     settings.endGroup();

     settings.beginGroup("outputpanel");
     settings.setValue("visible", panel->isVisible());
     settings.endGroup();

     QSettings obj1("MySoft", "Star Runner");
     QSettings obj2("MySoft");
     QSettings obj3(QSettings::SystemScope, "MySoft", "Star Runner");
     QSettings obj4(QSettings::SystemScope, "MySoft");

     QSettings settings(QSettings::IniFormat, QSettings::UserScope,
                        "MySoft", "Star Runner");

 void MainWindow::writeSettings()
 {
     QSettings settings("Moose Soft", "Clipper");

     settings.beginGroup("MainWindow");
     settings.setValue("size", size());
     settings.setValue("pos", pos());
     settings.endGroup();
 }

 void MainWindow::readSettings()
 {
     QSettings settings("Moose Soft", "Clipper");

     settings.beginGroup("MainWindow");
     resize(settings.value("size", QSize(400, 400)).toSize());
     move(settings.value("pos", QPoint(200, 200)).toPoint());
     settings.endGroup();
 }

 MainWindow::MainWindow()
 {
     ...
     readSettings();
 }

 void MainWindow::closeEvent(QCloseEvent *event)
 {
     if (userReallyWantsToQuit()) {
         writeSettings();
         event->accept();
     } else {
         event->ignore();
     }
 }

 QSettings settings("/home/petra/misc/myapp.ini",
                    QSettings::IniFormat);

 QSettings settings("/Users/petra/misc/myapp.plist",
                    QSettings::NativeFormat);

 QSettings settings("HKEY_CURRENT_USER\\Software\\Microsoft\\Office",
                    QSettings::NativeFormat);

 settings.setValue("11.0/Outlook/Security/DontTrustInstalledFiles", 0);

 settings.setValue("HKEY_CURRENT_USER\\MySoft\\Star Runner\\Galaxy", "Milkyway");
 settings.setValue("HKEY_CURRENT_USER\\MySoft\\Star Runner\\Galaxy\\Sun", "OurStar");
 settings.value("HKEY_CURRENT_USER\\MySoft\\Star Runner\\Galaxy\\Default"); // returns "Milkyway"

 QSettings settings(QApplication::applicationDirPath() + "/MySoft.conf");

 #include <QSettings>
 #include <QDesktopServices>
 int main(int argc, char *argv[])
 {
 #ifdef Q_OS_SYMBIAN
     // Use QDesktopServices:storageLocation as QApplication is not yet created
     QSettings::setPath(
         QSettings::NativeFormat, QSettings::UserScope,
         QDesktopServices::storageLocation(QDesktopServices::DataLocation) + "/settings");
 #endif
     QApplication app(argc, argv);

     ...
 }

 bool myReadFunc(QIODevice &device, QSettings::SettingsMap &map);

 bool myWriteFunc(QIODevice &device, const QSettings::SettingsMap &map);

Member Function Documentation

QSettings::QSettings ( const QString & organization, const QString & application = QString(), QObject * parent = 0 )

Constructs a QSettings object for accessing settings of the application called application from the organization called organization, and with parent parent.

Example:

 QSettings settings("Moose Tech", "Facturo-Pro");

The scope is set to QSettings::UserScope, and the format is set to QSettings::NativeFormat (i.e. calling setDefaultFormat() before calling this constructor has no effect).

See also setDefaultFormat() and Fallback Mechanism.

QSettings::QSettings ( Scope scope, const QString & organization, const QString & application = QString(), QObject * parent = 0 )

Constructs a QSettings object for accessing settings of the application called application from the organization called organization, and with parent parent.

If scope is QSettings::UserScope, the QSettings object searches user-specific settings first, before it searches system-wide settings as a fallback. If scope is QSettings::SystemScope, the QSettings object ignores user-specific settings and provides access to system-wide settings.

The storage format is set to QSettings::NativeFormat (i.e. calling setDefaultFormat() before calling this constructor has no effect).

If no application name is given, the QSettings object will only access the organization-wide locations.

See also setDefaultFormat().

QSettings::QSettings ( Format format, Scope scope, const QString & organization, const QString & application = QString(), QObject * parent = 0 )

Constructs a QSettings object for accessing settings of the application called application from the organization called organization, and with parent parent.

If scope is QSettings::UserScope, the QSettings object searches user-specific settings first, before it searches system-wide settings as a fallback. If scope is QSettings::SystemScope, the QSettings object ignores user-specific settings and provides access to system-wide settings.

If format is QSettings::NativeFormat, the native API is used for storing settings. If format is QSettings::IniFormat, the INI format is used.

If no application name is given, the QSettings object will only access the organization-wide locations.

QSettings::QSettings ( const QString & fileName, Format format, QObject * parent = 0 )

Constructs a QSettings object for accessing the settings stored in the file called fileName, with parent parent. If the file doesn't already exist, it is created.

If format is QSettings::NativeFormat, the meaning of fileName depends on the platform. On Unix, fileName is the name of an INI file. On Mac OS X, fileName is the name of a .plist file. On Windows, fileName is a path in the system registry.

If format is QSettings::IniFormat, fileName is the name of an INI file.

Warning: This function is provided for convenience. It works well for accessing INI or .plist files generated by Qt, but might fail on some syntaxes found in such files originated by other programs. In particular, be aware of the following limitations:

• QSettings provides no way of reading INI "path" entries, i.e., entries with unescaped slash characters. (This is because these entries are ambiguous and cannot be resolved automatically.)
• In INI files, QSettings uses the @ character as a metacharacter in some contexts, to encode Qt-specific data types (e.g., @Rect), and might therefore misinterpret it when it occurs in pure INI files.

See also fileName().

QSettings::QSettings ( QObject * parent = 0 )

Constructs a QSettings object for accessing settings of the application and organization set previously with a call to QCoreApplication::setOrganizationName(), QCoreApplication::setOrganizationDomain(), and QCoreApplication::setApplicationName().

The scope is QSettings::UserScope and the format is defaultFormat() (QSettings::NativeFormat by default). Use setDefaultFormat() before calling this constructor to change the default format used by this constructor.

The code

 QSettings settings("Moose Soft", "Facturo-Pro");

is equivalent to

 QCoreApplication::setOrganizationName("Moose Soft");
 QCoreApplication::setApplicationName("Facturo-Pro");
 QSettings settings;

If QCoreApplication::setOrganizationName() and QCoreApplication::setApplicationName() has not been previously called, the QSettings object will not be able to read or write any settings, and status() will return AccessError.

On Mac OS X, if both a name and an Internet domain are specified for the organization, the domain is preferred over the name. On other platforms, the name is preferred over the domain.

See also QCoreApplication::setOrganizationName(), QCoreApplication::setOrganizationDomain(), QCoreApplication::setApplicationName(), and setDefaultFormat().

QSettings::~QSettings ()

Destroys the QSettings object.

Any unsaved changes will eventually be written to permanent storage.

See also sync().

QStringList QSettings::allKeys () const

Returns a list of all keys, including subkeys, that can be read using the QSettings object.

Example:

 QSettings settings;
 settings.setValue("fridge/color", Qt::white);
 settings.setValue("fridge/size", QSize(32, 96));
 settings.setValue("sofa", true);
 settings.setValue("tv", false);

 QStringList keys = settings.allKeys();
 // keys: ["fridge/color", "fridge/size", "sofa", "tv"]

If a group is set using beginGroup(), only the keys in the group are returned, without the group prefix:

 settings.beginGroup("fridge");
 keys = settings.allKeys();
 // keys: ["color", "size"]

See also childGroups() and childKeys().

QString QSettings::applicationName () const

Returns the application name used for storing the settings.

This function was introduced in Qt 4.4.

See also QCoreApplication::applicationName(), format(), scope(), and organizationName().

void QSettings::beginGroup ( const QString & prefix )

Appends prefix to the current group.

The current group is automatically prepended to all keys specified to QSettings. In addition, query functions such as childGroups(), childKeys(), and allKeys() are based on the group. By default, no group is set.

Groups are useful to avoid typing in the same setting paths over and over. For example:

 settings.beginGroup("mainwindow");
 settings.setValue("size", win->size());
 settings.setValue("fullScreen", win->isFullScreen());
 settings.endGroup();

 settings.beginGroup("outputpanel");
 settings.setValue("visible", panel->isVisible());
 settings.endGroup();

This will set the value of three settings:

• mainwindow/size
• mainwindow/fullScreen
• outputpanel/visible

Call endGroup() to reset the current group to what it was before the corresponding beginGroup() call. Groups can be nested.

See also endGroup() and group().

int QSettings::beginReadArray ( const QString & prefix )

Adds prefix to the current group and starts reading from an array. Returns the size of the array.

Example:

 struct Login {
     QString userName;
     QString password;
 };
 QList<Login> logins;
 ...

 QSettings settings;
 int size = settings.beginReadArray("logins");
 for (int i = 0; i < size; ++i) {
     settings.setArrayIndex(i);
     Login login;
     login.userName = settings.value("userName").toString();
     login.password = settings.value("password").toString();
     logins.append(login);
 }
 settings.endArray();

Use beginWriteArray() to write the array in the first place.

See also beginWriteArray(), endArray(), and setArrayIndex().

void QSettings::beginWriteArray ( const QString & prefix, int size = -1 )

Adds prefix to the current group and starts writing an array of size size. If size is -1 (the default), it is automatically determined based on the indexes of the entries written.

If you have many occurrences of a certain set of keys, you can use arrays to make your life easier. For example, let's suppose that you want to save a variable-length list of user names and passwords. You could then write:

 struct Login {
     QString userName;
     QString password;
 };
 QList<Login> logins;
 ...

 QSettings settings;
 settings.beginWriteArray("logins");
 for (int i = 0; i < logins.size(); ++i) {
     settings.setArrayIndex(i);
     settings.setValue("userName", list.at(i).userName);
     settings.setValue("password", list.at(i).password);
 }
 settings.endArray();

The generated keys will have the form

• logins/size
• logins/1/userName
• logins/1/password
• logins/2/userName
• logins/2/password
• logins/3/userName
• logins/3/password
• ...

To read back an array, use beginReadArray().

See also beginReadArray(), endArray(), and setArrayIndex().

QStringList QSettings::childGroups () const

Returns a list of all key top-level groups that contain keys that can be read using the QSettings object.

Example:

 QSettings settings;
 settings.setValue("fridge/color", Qt::white);
 settings.setValue("fridge/size", QSize(32, 96));
 settings.setValue("sofa", true);
 settings.setValue("tv", false);

 QStringList groups = settings.childGroups();
 // groups: ["fridge"]

If a group is set using beginGroup(), the first-level keys in that group are returned, without the group prefix.

 settings.beginGroup("fridge");
 groups = settings.childGroups();
 // groups: []

You can navigate through the entire setting hierarchy using childKeys() and childGroups() recursively.

See also childKeys() and allKeys().

QStringList QSettings::childKeys () const

Returns a list of all top-level keys that can be read using the QSettings object.

Example:

 QSettings settings;
 settings.setValue("fridge/color", Qt::white);
 settings.setValue("fridge/size", QSize(32, 96));
 settings.setValue("sofa", true);
 settings.setValue("tv", false);

 QStringList keys = settings.childKeys();
 // keys: ["sofa", "tv"]

If a group is set using beginGroup(), the top-level keys in that group are returned, without the group prefix:

 settings.beginGroup("fridge");
 keys = settings.childKeys();
 // keys: ["color", "size"]

You can navigate through the entire setting hierarchy using childKeys() and childGroups() recursively.

See also childGroups() and allKeys().

void QSettings::clear ()

Removes all entries in the primary location associated to this QSettings object.

Entries in fallback locations are not removed.

If you only want to remove the entries in the current group(), use remove("") instead.

See also remove() and setFallbacksEnabled().

bool QSettings::contains ( const QString & key ) const

Returns true if there exists a setting called key; returns false otherwise.

If a group is set using beginGroup(), key is taken to be relative to that group.

Note that the Windows registry and INI files use case-insensitive keys, whereas the Carbon Preferences API on Mac OS X uses case-sensitive keys. To avoid portability problems, see the Section and Key Syntax rules.

See also value() and setValue().

Format QSettings::defaultFormat () [static]

Returns default file format used for storing settings for the QSettings(QObject *) constructor. If no default format is set, QSettings::NativeFormat is used.

This function was introduced in Qt 4.4.

See also setDefaultFormat() and format().

void QSettings::endArray ()

Closes the array that was started using beginReadArray() or beginWriteArray().

See also beginReadArray() and beginWriteArray().

void QSettings::endGroup ()

Resets the group to what it was before the corresponding beginGroup() call.

Example:

 settings.beginGroup("alpha");
 // settings.group() == "alpha"

 settings.beginGroup("beta");
 // settings.group() == "alpha/beta"

 settings.endGroup();
 // settings.group() == "alpha"

 settings.endGroup();
 // settings.group() == ""

See also beginGroup() and group().

bool QSettings::event ( QEvent * event ) [virtual protected]

Reimplemented from QObject::event().

bool QSettings::fallbacksEnabled () const

Returns true if fallbacks are enabled; returns false otherwise.

By default, fallbacks are enabled.

See also setFallbacksEnabled().

QString QSettings::fileName () const

Returns the path where settings written using this QSettings object are stored.

On Windows, if the format is QSettings::NativeFormat, the return value is a system registry path, not a file path.

See also isWritable() and format().

Format QSettings::format () const

Returns the format used for storing the settings.

This function was introduced in Qt 4.4.

See also defaultFormat(), fileName(), scope(), organizationName(), and applicationName().

QString QSettings::group () const

Returns the current group.

See also beginGroup() and endGroup().

QTextCodec * QSettings::iniCodec () const

Returns the codec that is used for accessing INI files. By default, no codec is used, so a null pointer is returned.

This function was introduced in Qt 4.5.

See also setIniCodec().

bool QSettings::isWritable () const

Returns true if settings can be written using this QSettings object; returns false otherwise.

One reason why isWritable() might return false is if QSettings operates on a read-only file.

Warning: This function is not perfectly reliable, because the file permissions can change at any time.

See also fileName(), status(), and sync().

QString QSettings::organizationName () const

Returns the organization name used for storing the settings.

This function was introduced in Qt 4.4.

See also QCoreApplication::organizationName(), format(), scope(), and applicationName().

Format QSettings::registerFormat ( const QString & extension, ReadFunc readFunc, WriteFunc writeFunc, Qt::CaseSensitivity caseSensitivity = Qt::CaseSensitive ) [static]

Registers a custom storage format. On success, returns a special Format value that can then be passed to the QSettings constructor. On failure, returns InvalidFormat.

The extension is the file extension associated to the format (without the '.').

The readFunc and writeFunc parameters are pointers to functions that read and write a set of key/value pairs. The QIODevice parameter to the read and write functions is always opened in binary mode (i.e., without the QIODevice::Text flag).

The caseSensitivity parameter specifies whether keys are case sensitive or not. This makes a difference when looking up values using QSettings. The default is case sensitive.

By default, if you use one of the constructors that work in terms of an organization name and an application name, the file system locations used are the same as for IniFormat. Use setPath() to specify other locations.

Example:

 bool readXmlFile(QIODevice &device, QSettings::SettingsMap &map);
 bool writeXmlFile(QIODevice &device, const QSettings::SettingsMap &map);

 int main(int argc, char *argv[])
 {
     const QSettings::Format XmlFormat =
             QSettings::registerFormat("xml", readXmlFile, writeXmlFile);

     QSettings settings(XmlFormat, QSettings::UserScope, "MySoft",
                        "Star Runner");

     ...
 }

Note: This function is thread-safe.

This function was introduced in Qt 4.1.

See also setPath().

void QSettings::remove ( const QString & key )

Removes the setting key and any sub-settings of key.

Example:

 QSettings settings;
 settings.setValue("ape");
 settings.setValue("monkey", 1);
 settings.setValue("monkey/sea", 2);
 settings.setValue("monkey/doe", 4);

 settings.remove("monkey");
 QStringList keys = settings.allKeys();
 // keys: ["ape"]

Be aware that if one of the fallback locations contains a setting with the same key, that setting will be visible after calling remove().

If key is an empty string, all keys in the current group() are removed. For example:

 QSettings settings;
 settings.setValue("ape");
 settings.setValue("monkey", 1);
 settings.setValue("monkey/sea", 2);
 settings.setValue("monkey/doe", 4);

 settings.beginGroup("monkey");
 settings.remove("");
 settings.endGroup();

 QStringList keys = settings.allKeys();
 // keys: ["ape"]

Note that the Windows registry and INI files use case-insensitive keys, whereas the Carbon Preferences API on Mac OS X uses case-sensitive keys. To avoid portability problems, see the Section and Key Syntax rules.

See also setValue(), value(), and contains().

Scope QSettings::scope () const

Returns the scope used for storing the settings.

This function was introduced in Qt 4.4.

See also format(), organizationName(), and applicationName().

void QSettings::setArrayIndex ( int i )

Sets the current array index to i. Calls to functions such as setValue(), value(), remove(), and contains() will operate on the array entry at that index.

You must call beginReadArray() or beginWriteArray() before you can call this function.

void QSettings::setDefaultFormat ( Format format ) [static]

Sets the default file format to the given format, which is used for storing settings for the QSettings(QObject *) constructor.

If no default format is set, QSettings::NativeFormat is used. See the documentation for the QSettings constructor you are using to see if that constructor will ignore this function.

This function was introduced in Qt 4.4.

See also defaultFormat() and format().

void QSettings::setFallbacksEnabled ( bool b )

Sets whether fallbacks are enabled to b.

By default, fallbacks are enabled.

See also fallbacksEnabled().

void QSettings::setIniCodec ( QTextCodec * codec )

Sets the codec for accessing INI files (including .conf files on Unix) to codec. The codec is used for decoding any data that is read from the INI file, and for encoding any data that is written to the file. By default, no codec is used, and non-ASCII characters are encoded using standard INI escape sequences.

Warning: The codec must be set immediately after creating the QSettings object, before accessing any data.

This function was introduced in Qt 4.5.

See also iniCodec().

void QSettings::setIniCodec ( const char * codecName )

This is an overloaded function.

Sets the codec for accessing INI files (including .conf files on Unix) to the QTextCodec for the encoding specified by codecName. Common values for codecName include "ISO 8859-1", "UTF-8", and "UTF-16". If the encoding isn't recognized, nothing happens.

This function was introduced in Qt 4.5.

See also QTextCodec::codecForName().

void QSettings::setPath ( Format format, Scope scope, const QString & path ) [static]

Sets the path used for storing settings for the given format and scope, to path. The format can be a custom format.

The table below summarizes the default values:

Platform	Format	Scope	Path
Windows	IniFormat	UserScope	%APPDATA%
		SystemScope	%COMMON_APPDATA%
Unix	NativeFormat, IniFormat	UserScope	$HOME/.config
		SystemScope	/etc/xdg
Qt for Embedded Linux	NativeFormat, IniFormat	UserScope	$HOME/Settings
		SystemScope	/etc/xdg
Mac OS X	IniFormat	UserScope	$HOME/.config
		SystemScope	/etc/xdg
Symbian	NativeFormat, IniFormat	UserScope	c:/data/.config
		SystemScope	<drive>/private/<uid>

The default UserScope paths on Unix and Mac OS X ($HOME/.config or $HOME/Settings) can be overridden by the user by setting the XDG_CONFIG_HOME environment variable. The default SystemScope paths on Unix and Mac OS X (/etc/xdg) can be overridden when building the Qt library using the configure script's --sysconfdir flag (see QLibraryInfo for details).

Setting the NativeFormat paths on Windows and Mac OS X has no effect.

Warning: This function doesn't affect existing QSettings objects.

This function was introduced in Qt 4.1.

See also registerFormat().

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

Sets the value of setting key to value. If the key already exists, the previous value is overwritten.

Note that the Windows registry and INI files use case-insensitive keys, whereas the Carbon Preferences API on Mac OS X uses case-sensitive keys. To avoid portability problems, see the Section and Key Syntax rules.

Example:

 QSettings settings;
 settings.setValue("interval", 30);
 settings.value("interval").toInt();     // returns 30

 settings.setValue("interval", 6.55);
 settings.value("interval").toDouble();  // returns 6.55

See also value(), remove(), and contains().

Status QSettings::status () const

Returns a status code indicating the first error that was met by QSettings, or QSettings::NoError if no error occurred.

Be aware that QSettings delays performing some operations. For this reason, you might want to call sync() to ensure that the data stored in QSettings is written to disk before calling status().

See also sync().

void QSettings::sync ()

Writes any unsaved changes to permanent storage, and reloads any settings that have been changed in the meantime by another application.

This function is called automatically from QSettings's destructor and by the event loop at regular intervals, so you normally don't need to call it yourself.

See also status().

QVariant QSettings::value ( const QString & key, const QVariant & defaultValue = QVariant() ) const

Returns the value for setting key. If the setting doesn't exist, returns defaultValue.

If no default value is specified, a default QVariant is returned.

Note that the Windows registry and INI files use case-insensitive keys, whereas the Carbon Preferences API on Mac OS X uses case-sensitive keys. To avoid portability problems, see the Section and Key Syntax rules.

Example:

 QSettings settings;
 settings.setValue("animal/snake", 58);
 settings.value("animal/snake", 1024).toInt();   // returns 58
 settings.value("animal/zebra", 1024).toInt();   // returns 1024
 settings.value("animal/zebra").toInt();         // returns 0

See also setValue(), contains(), and remove().