KLayout Manual: Main Index » Class Index » API reference - Class QSettings

API reference - Class QSettings

Notation used in Ruby API documentation

Description: Binding of QSettings

Class hierarchy: QSettings » QObject

Sub-classes: Format, Scope, Status

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QSettings_Status ptr AccessError

Description: Enum constant QSettings::AccessError

[static,const] new QSettings_Format ptr CustomFormat1

Description: Enum constant QSettings::CustomFormat1

[static,const] new QSettings_Format ptr CustomFormat10

Description: Enum constant QSettings::CustomFormat10

[static,const] new QSettings_Format ptr CustomFormat11

Description: Enum constant QSettings::CustomFormat11

[static,const] new QSettings_Format ptr CustomFormat12

Description: Enum constant QSettings::CustomFormat12

[static,const] new QSettings_Format ptr CustomFormat13

Description: Enum constant QSettings::CustomFormat13

[static,const] new QSettings_Format ptr CustomFormat14

Description: Enum constant QSettings::CustomFormat14

[static,const] new QSettings_Format ptr CustomFormat15

Description: Enum constant QSettings::CustomFormat15

[static,const] new QSettings_Format ptr CustomFormat16

Description: Enum constant QSettings::CustomFormat16

[static,const] new QSettings_Format ptr CustomFormat2

Description: Enum constant QSettings::CustomFormat2

[static,const] new QSettings_Format ptr CustomFormat3

Description: Enum constant QSettings::CustomFormat3

[static,const] new QSettings_Format ptr CustomFormat4

Description: Enum constant QSettings::CustomFormat4

[static,const] new QSettings_Format ptr CustomFormat5

Description: Enum constant QSettings::CustomFormat5

[static,const] new QSettings_Format ptr CustomFormat6

Description: Enum constant QSettings::CustomFormat6

[static,const] new QSettings_Format ptr CustomFormat7

Description: Enum constant QSettings::CustomFormat7

[static,const] new QSettings_Format ptr CustomFormat8

Description: Enum constant QSettings::CustomFormat8

[static,const] new QSettings_Format ptr CustomFormat9

Description: Enum constant QSettings::CustomFormat9

[static,const] new QSettings_Status ptr FormatError

Description: Enum constant QSettings::FormatError

[static,const] new QSettings_Format ptr IniFormat

Description: Enum constant QSettings::IniFormat

[static,const] new QSettings_Format ptr InvalidFormat

Description: Enum constant QSettings::InvalidFormat

[static,const] new QSettings_Format ptr NativeFormat

Description: Enum constant QSettings::NativeFormat

[static,const] new QSettings_Status ptr NoError

Description: Enum constant QSettings::NoError

[static,const] new QSettings_Scope ptr SystemScope

Description: Enum constant QSettings::SystemScope

[static,const] new QSettings_Scope ptr UserScope

Description: Enum constant QSettings::UserScope

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.

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.

[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.

[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.

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.

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.

[const] string[] allKeys

Description: Method QStringList QSettings::allKeys()

[const] string applicationName

Description: Method QString QSettings::applicationName()

void beginGroup(string prefix)

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

int beginReadArray(string prefix)

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

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

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

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] string[] childGroups

Description: Method QStringList QSettings::childGroups()

[const] string[] childKeys

Description: Method QStringList QSettings::childKeys()

void clear

Description: Method void QSettings::clear()

[const] bool contains(string key)

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

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[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.

[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.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QSettings::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

void endArray

Description: Method void QSettings::endArray()

void endGroup

Description: Method void QSettings::endGroup()

[virtual] bool event(QEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[const] bool fallbacksEnabled

Description: Method bool QSettings::fallbacksEnabled()

Python specific notes:

The object exposes a readable attribute 'fallbacksEnabled'. This is the getter.

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.

[const] string fileName

Description: Method QString QSettings::fileName()

[const] QSettings_Format format

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

[const] string group

Description: Method QString QSettings::group()

[const] bool isWritable?

Description: Method bool QSettings::isWritable()

[const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

[static] new QSettings new(string organization,string application = QString(),QObject ptr parent = 0)

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

[static] new QSettings new(const QSettings_Scope scope,string organization,string application = QString(),QObject ptr parent = 0)

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

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

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

[static] new QSettings new(string fileName,const QSettings_Format format,QObject ptr parent = 0)

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

[static] new QSettings new(QObject ptr parent = 0)

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

[const] string organizationName

Description: Method QString QSettings::organizationName()

[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.

void remove(string key)

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

[const] QSettings_Scope scope

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

[const] QObject ptr sender

Description: Method QObject *QSettings::sender()

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

void setArrayIndex(int i)

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

[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.

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.

[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.

[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.

[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.

void setValue(string key,const QVariant value)

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] QSettings_Status status

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

void sync

Description: Method void QSettings::sync()

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.

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

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