API reference - Class QSettings

AccessError

Signature: [static,const] QSettings_Status AccessError

Description: Enum constant QSettings::AccessError

Python specific notes:
The object exposes a readable attribute 'AccessError'. This is the getter.

CustomFormat1

Signature: [static,const] QSettings_Format CustomFormat1

Description: Enum constant QSettings::CustomFormat1

Python specific notes:
The object exposes a readable attribute 'CustomFormat1'. This is the getter.

CustomFormat10

Signature: [static,const] QSettings_Format CustomFormat10

Description: Enum constant QSettings::CustomFormat10

Python specific notes:
The object exposes a readable attribute 'CustomFormat10'. This is the getter.

CustomFormat11

Signature: [static,const] QSettings_Format CustomFormat11

Description: Enum constant QSettings::CustomFormat11

Python specific notes:
The object exposes a readable attribute 'CustomFormat11'. This is the getter.

CustomFormat12

Signature: [static,const] QSettings_Format CustomFormat12

Description: Enum constant QSettings::CustomFormat12

Python specific notes:
The object exposes a readable attribute 'CustomFormat12'. This is the getter.

CustomFormat13

Signature: [static,const] QSettings_Format CustomFormat13

Description: Enum constant QSettings::CustomFormat13

Python specific notes:
The object exposes a readable attribute 'CustomFormat13'. This is the getter.

CustomFormat14

Signature: [static,const] QSettings_Format CustomFormat14

Description: Enum constant QSettings::CustomFormat14

Python specific notes:
The object exposes a readable attribute 'CustomFormat14'. This is the getter.

CustomFormat15

Signature: [static,const] QSettings_Format CustomFormat15

Description: Enum constant QSettings::CustomFormat15

Python specific notes:
The object exposes a readable attribute 'CustomFormat15'. This is the getter.

CustomFormat16

Signature: [static,const] QSettings_Format CustomFormat16

Description: Enum constant QSettings::CustomFormat16

Python specific notes:
The object exposes a readable attribute 'CustomFormat16'. This is the getter.

CustomFormat2

Signature: [static,const] QSettings_Format CustomFormat2

Description: Enum constant QSettings::CustomFormat2

Python specific notes:
The object exposes a readable attribute 'CustomFormat2'. This is the getter.

CustomFormat3

Signature: [static,const] QSettings_Format CustomFormat3

Description: Enum constant QSettings::CustomFormat3

Python specific notes:
The object exposes a readable attribute 'CustomFormat3'. This is the getter.

CustomFormat4

Signature: [static,const] QSettings_Format CustomFormat4

Description: Enum constant QSettings::CustomFormat4

Python specific notes:
The object exposes a readable attribute 'CustomFormat4'. This is the getter.

CustomFormat5

Signature: [static,const] QSettings_Format CustomFormat5

Description: Enum constant QSettings::CustomFormat5

Python specific notes:
The object exposes a readable attribute 'CustomFormat5'. This is the getter.

CustomFormat6

Signature: [static,const] QSettings_Format CustomFormat6

Description: Enum constant QSettings::CustomFormat6

Python specific notes:
The object exposes a readable attribute 'CustomFormat6'. This is the getter.

CustomFormat7

Signature: [static,const] QSettings_Format CustomFormat7

Description: Enum constant QSettings::CustomFormat7

Python specific notes:
The object exposes a readable attribute 'CustomFormat7'. This is the getter.

CustomFormat8

Signature: [static,const] QSettings_Format CustomFormat8

Description: Enum constant QSettings::CustomFormat8

Python specific notes:
The object exposes a readable attribute 'CustomFormat8'. This is the getter.

CustomFormat9

Signature: [static,const] QSettings_Format CustomFormat9

Description: Enum constant QSettings::CustomFormat9

Python specific notes:
The object exposes a readable attribute 'CustomFormat9'. This is the getter.

FormatError

Signature: [static,const] QSettings_Status FormatError

Description: Enum constant QSettings::FormatError

Python specific notes:
The object exposes a readable attribute 'FormatError'. This is the getter.

IniFormat

Signature: [static,const] QSettings_Format IniFormat

Description: Enum constant QSettings::IniFormat

Python specific notes:
The object exposes a readable attribute 'IniFormat'. This is the getter.

InvalidFormat

Signature: [static,const] QSettings_Format InvalidFormat

Description: Enum constant QSettings::InvalidFormat

Python specific notes:
The object exposes a readable attribute 'InvalidFormat'. This is the getter.

NativeFormat

Signature: [static,const] QSettings_Format NativeFormat

Description: Enum constant QSettings::NativeFormat

Python specific notes:
The object exposes a readable attribute 'NativeFormat'. This is the getter.

NoError

Signature: [static,const] QSettings_Status NoError

Description: Enum constant QSettings::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. This is the getter.

SystemScope

Signature: [static,const] QSettings_Scope SystemScope

Description: Enum constant QSettings::SystemScope

Python specific notes:
The object exposes a readable attribute 'SystemScope'. This is the getter.

UserScope

Signature: [static,const] QSettings_Scope UserScope

Description: Enum constant QSettings::UserScope

Python specific notes:
The object exposes a readable attribute 'UserScope'. This is the getter.

_const_cast

Signature: [const] QSettings ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

allKeys

Signature: [const] string[] allKeys

Description: Method QStringList QSettings::allKeys()

applicationName

Signature: [const] string applicationName

Description: Method QString QSettings::applicationName()

atomicSyncRequired

Signature: [const] bool atomicSyncRequired

Description: Method bool QSettings::isAtomicSyncRequired()

Python specific notes:
The object exposes a readable attribute 'atomicSyncRequired'. This is the getter.

atomicSyncRequired=

Signature: void atomicSyncRequired= (bool enable)

Description: Method void QSettings::setAtomicSyncRequired(bool enable)

Python specific notes:
The object exposes a writable attribute 'atomicSyncRequired'. This is the setter.

beginGroup

Signature: void beginGroup (string prefix)

Description: Method void QSettings::beginGroup(const QString &prefix)

beginReadArray

Signature: int beginReadArray (string prefix)

Description: Method int QSettings::beginReadArray(const QString &prefix)

beginWriteArray

Signature: void beginWriteArray (string prefix, int size = -1)

Description: Method void QSettings::beginWriteArray(const QString &prefix, int size)

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QSettings::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

childGroups

Signature: [const] string[] childGroups

Description: Method QStringList QSettings::childGroups()

childKeys

Signature: [const] string[] childKeys

Description: Method QStringList QSettings::childKeys()

clear

Signature: void clear

Description: Method void QSettings::clear()

contains

Signature: [const] bool contains (string key)

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

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QSettings::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

defaultFormat

Signature: [static] QSettings_Format defaultFormat

Description: Static method QSettings::Format QSettings::defaultFormat()

This method is static and can be called without an instance.

Python specific notes:
The object exposes a readable attribute 'defaultFormat'. This is the getter.

defaultFormat=

Signature: [static] void defaultFormat= (const QSettings_Format format)

Description: Static method void QSettings::setDefaultFormat(QSettings::Format format)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'defaultFormat'. This is the setter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QSettings::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSettings::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QSettings::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QSettings::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

endArray

Signature: void endArray

Description: Method void QSettings::endArray()

endGroup

Signature: void endGroup

Description: Method void QSettings::endGroup()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSettings::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QSettings::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

fallbacksEnabled

Signature: [const] bool fallbacksEnabled

Description: Method bool QSettings::fallbacksEnabled()

Python specific notes:
The object exposes a readable attribute 'fallbacksEnabled'. This is the getter.

fallbacksEnabled=

Signature: void fallbacksEnabled= (bool b)

Description: Method void QSettings::setFallbacksEnabled(bool b)

Python specific notes:
The object exposes a writable attribute 'fallbacksEnabled'. This is the setter.

fileName

Signature: [const] string fileName

Description: Method QString QSettings::fileName()

format

Signature: [const] QSettings_Format format

Description: Method QSettings::Format QSettings::format()

group

Signature: [const] string group

Description: Method QString QSettings::group()

isAtomicSyncRequired?

Signature: [const] bool isAtomicSyncRequired?

Description: Method bool QSettings::isAtomicSyncRequired()

Python specific notes:
The object exposes a readable attribute 'atomicSyncRequired'. This is the getter.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSettings::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

isWritable?

Signature: [const] bool isWritable?

Description: Method bool QSettings::isWritable()

new

(1) Signature: [static] new QSettings new (string organization, string application = QString(), QObject ptr parent = nullptr)

Description: Constructor QSettings::QSettings(const QString &organization, const QString &application, QObject *parent)

This method creates an object of class QSettings.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSettings new (const QSettings_Scope scope, string organization, string application = QString(), QObject ptr parent = nullptr)

Description: Constructor QSettings::QSettings(QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)

This method creates an object of class QSettings.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QSettings new (const QSettings_Format format, const QSettings_Scope scope, string organization, string application = QString(), QObject ptr parent = nullptr)

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

This method creates an object of class QSettings.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QSettings new (string fileName, const QSettings_Format format, QObject ptr parent = nullptr)

Description: Constructor QSettings::QSettings(const QString &fileName, QSettings::Format format, QObject *parent)

This method creates an object of class QSettings.

Python specific notes:
This method is the default initializer of the object.

(5) Signature: [static] new QSettings new (QObject ptr parent = nullptr)

Description: Constructor QSettings::QSettings(QObject *parent)

This method creates an object of class QSettings.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSettings::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

organizationName

Signature: [const] string organizationName

Description: Method QString QSettings::organizationName()

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSettings::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

remove

Signature: void remove (string key)

Description: Method void QSettings::remove(const QString &key)

scope

Signature: [const] QSettings_Scope scope

Description: Method QSettings::Scope QSettings::scope()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSettings::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSettings::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setArrayIndex

Signature: void setArrayIndex (int i)

Description: Method void QSettings::setArrayIndex(int i)

setAtomicSyncRequired

Signature: void setAtomicSyncRequired (bool enable)

Description: Method void QSettings::setAtomicSyncRequired(bool enable)

Python specific notes:
The object exposes a writable attribute 'atomicSyncRequired'. This is the setter.

setDefaultFormat

Signature: [static] void setDefaultFormat (const QSettings_Format format)

Description: Static method void QSettings::setDefaultFormat(QSettings::Format format)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'defaultFormat'. This is the setter.

setFallbacksEnabled

Signature: void setFallbacksEnabled (bool b)

Description: Method void QSettings::setFallbacksEnabled(bool b)

Python specific notes:
The object exposes a writable attribute 'fallbacksEnabled'. This is the setter.

setPath

Signature: [static] void setPath (const QSettings_Format format, const QSettings_Scope scope, string path)

Description: Static method void QSettings::setPath(QSettings::Format format, QSettings::Scope scope, const QString &path)

This method is static and can be called without an instance.

setSystemIniPath

Signature: [static] void setSystemIniPath (string dir)

Description: Static method void QSettings::setSystemIniPath(const QString &dir)

This method is static and can be called without an instance.

setUserIniPath

Signature: [static] void setUserIniPath (string dir)

Description: Static method void QSettings::setUserIniPath(const QString &dir)

This method is static and can be called without an instance.

setValue

Signature: void setValue (string key, variant value)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

status

Signature: [const] QSettings_Status status

Description: Method QSettings::Status QSettings::status()

sync

Signature: void sync

Description: Method void QSettings::sync()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QSettings::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QSettings::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QSettings::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

value

Signature: [const] variant value (string key, variant defaultValue = QVariant())

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