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

Public constructors

new QSettingsnew(const QSettings_Format format,
const QSettings_Scope scope,
string organization)
Constructor QSettings::QSettings(QSettings::Format format, QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(const QSettings_Format format,
const QSettings_Scope scope,
string organization,
string application)
Constructor QSettings::QSettings(QSettings::Format format, QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(const QSettings_Format format,
const QSettings_Scope scope,
string organization,
string application,
QObject ptr parent)
Constructor QSettings::QSettings(QSettings::Format format, QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)
new QSettingsnewConstructor QSettings::QSettings(QObject *parent)
new QSettingsnew(QObject ptr parent)Constructor QSettings::QSettings(QObject *parent)
new QSettingsnew(string fileName,
const QSettings_Format format)
Constructor QSettings::QSettings(const QString &fileName, QSettings::Format format, QObject *parent)
new QSettingsnew(string fileName,
const QSettings_Format format,
QObject ptr parent)
Constructor QSettings::QSettings(const QString &fileName, QSettings::Format format, QObject *parent)
new QSettingsnew(string organization)Constructor QSettings::QSettings(const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(string organization,
string application)
Constructor QSettings::QSettings(const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(string organization,
string application,
QObject ptr parent)
Constructor QSettings::QSettings(const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(const QSettings_Scope scope,
string organization)
Constructor QSettings::QSettings(QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(const QSettings_Scope scope,
string organization,
string application)
Constructor QSettings::QSettings(QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)
new QSettingsnew(const QSettings_Scope scope,
string organization,
string application,
QObject ptr parent)
Constructor QSettings::QSettings(QSettings::Scope scope, const QString &organization, const QString &application, QObject *parent)

Public methods

[const]string[]allKeysMethod QStringList QSettings::allKeys()
[const]stringapplicationNameMethod QString QSettings::applicationName()
voidbeginGroup(string prefix)Method void QSettings::beginGroup(const QString &prefix)
intbeginReadArray(string prefix)Method int QSettings::beginReadArray(const QString &prefix)
voidbeginWriteArray(string prefix)Method void QSettings::beginWriteArray(const QString &prefix, int size)
voidbeginWriteArray(string prefix,
int size)
Method void QSettings::beginWriteArray(const QString &prefix, int size)
[const]string[]childGroupsMethod QStringList QSettings::childGroups()
[const]string[]childKeysMethod QStringList QSettings::childKeys()
voidclearMethod void QSettings::clear()
[const]boolcontains(string key)Method bool QSettings::contains(const QString &key)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QSettings::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
voidendArrayMethod void QSettings::endArray()
voidendGroupMethod void QSettings::endGroup()
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QSettings::eventFilter(QObject *, QEvent *)
[const]boolfallbacksEnabledMethod bool QSettings::fallbacksEnabled()
voidfallbacksEnabled=(bool b)Method void QSettings::setFallbacksEnabled(bool b)
[const]stringfileNameMethod QString QSettings::fileName()
[const]QSettings_FormatformatMethod QSettings::Format QSettings::format()
[const]stringgroupMethod QString QSettings::group()
[const]boolisWritableMethod bool QSettings::isWritable()
[const]boolisWritable?Method bool QSettings::isWritable()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]stringorganizationNameMethod QString QSettings::organizationName()
voidremove(string key)Method void QSettings::remove(const QString &key)
[const]QSettings_ScopescopeMethod QSettings::Scope QSettings::scope()
voidsetArrayIndex(int i)Method void QSettings::setArrayIndex(int i)
voidsetFallbacksEnabled(bool b)Method void QSettings::setFallbacksEnabled(bool b)
voidsetValue(string key,
const QVariant value)
Method void QSettings::setValue(const QString &key, const QVariant &value)
[const]QSettings_StatusstatusMethod QSettings::Status QSettings::status()
voidsyncMethod void QSettings::sync()
[const]QVariantvalue(string key)Method QVariant QSettings::value(const QString &key, const QVariant &defaultValue)
[const]QVariantvalue(string key,
const QVariant defaultValue)
Method QVariant QSettings::value(const QString &key, const QVariant &defaultValue)

Public static methods and constants

QSettings_StatusAccessErrorEnum constant enum QSettings::AccessError
QSettings_FormatCustomFormat1Enum constant enum QSettings::CustomFormat1
QSettings_FormatCustomFormat10Enum constant enum QSettings::CustomFormat10
QSettings_FormatCustomFormat11Enum constant enum QSettings::CustomFormat11
QSettings_FormatCustomFormat12Enum constant enum QSettings::CustomFormat12
QSettings_FormatCustomFormat13Enum constant enum QSettings::CustomFormat13
QSettings_FormatCustomFormat14Enum constant enum QSettings::CustomFormat14
QSettings_FormatCustomFormat15Enum constant enum QSettings::CustomFormat15
QSettings_FormatCustomFormat16Enum constant enum QSettings::CustomFormat16
QSettings_FormatCustomFormat2Enum constant enum QSettings::CustomFormat2
QSettings_FormatCustomFormat3Enum constant enum QSettings::CustomFormat3
QSettings_FormatCustomFormat4Enum constant enum QSettings::CustomFormat4
QSettings_FormatCustomFormat5Enum constant enum QSettings::CustomFormat5
QSettings_FormatCustomFormat6Enum constant enum QSettings::CustomFormat6
QSettings_FormatCustomFormat7Enum constant enum QSettings::CustomFormat7
QSettings_FormatCustomFormat8Enum constant enum QSettings::CustomFormat8
QSettings_FormatCustomFormat9Enum constant enum QSettings::CustomFormat9
QSettings_StatusFormatErrorEnum constant enum QSettings::FormatError
QSettings_FormatIniFormatEnum constant enum QSettings::IniFormat
QSettings_FormatInvalidFormatEnum constant enum QSettings::InvalidFormat
QSettings_FormatNativeFormatEnum constant enum QSettings::NativeFormat
QSettings_StatusNoErrorEnum constant enum QSettings::NoError
QSettings_ScopeSystemScopeEnum constant enum QSettings::SystemScope
QSettings_ScopeUserScopeEnum constant enum QSettings::UserScope
QSettings_FormatdefaultFormatStatic method QSettings::Format QSettings::defaultFormat()
voidsetDefaultFormat(const QSettings_Format format)Static method void QSettings::setDefaultFormat(QSettings::Format format)
voidsetPath(const QSettings_Format format,
const QSettings_Scope scope,
string path)
Static method void QSettings::setPath(QSettings::Format format, QSettings::Scope scope, const QString &path)
voidsetSystemIniPath(string dir)Static method void QSettings::setSystemIniPath(const QString &dir)
voidsetUserIniPath(string dir)Static method void QSettings::setUserIniPath(const QString &dir)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s)Static method QString QSettings::tr(const char *s, const char *c)
stringtr(string s,
string c)
Static method QString QSettings::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QSettings::tr(const char *s, const char *c, int n)
stringtrUtf8(string s)Static method QString QSettings::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c)
Static method QString QSettings::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QSettings::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QSettings::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QSettings::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QSettings::disconnectNotify(const char *signal)
[virtual]boolevent(QEvent ptr event)Virtual method bool QSettings::event(QEvent *event)
[const]intreceivers(string signal)Method int QSettings::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject * QSettings::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QSettings::timerEvent(QTimerEvent *)

Detailed description

[static] QSettings_Status AccessError

Description: Enum constant enum QSettings::AccessError

[static] QSettings_Format CustomFormat1

Description: Enum constant enum QSettings::CustomFormat1

[static] QSettings_Format CustomFormat10

Description: Enum constant enum QSettings::CustomFormat10

[static] QSettings_Format CustomFormat11

Description: Enum constant enum QSettings::CustomFormat11

[static] QSettings_Format CustomFormat12

Description: Enum constant enum QSettings::CustomFormat12

[static] QSettings_Format CustomFormat13

Description: Enum constant enum QSettings::CustomFormat13

[static] QSettings_Format CustomFormat14

Description: Enum constant enum QSettings::CustomFormat14

[static] QSettings_Format CustomFormat15

Description: Enum constant enum QSettings::CustomFormat15

[static] QSettings_Format CustomFormat16

Description: Enum constant enum QSettings::CustomFormat16

[static] QSettings_Format CustomFormat2

Description: Enum constant enum QSettings::CustomFormat2

[static] QSettings_Format CustomFormat3

Description: Enum constant enum QSettings::CustomFormat3

[static] QSettings_Format CustomFormat4

Description: Enum constant enum QSettings::CustomFormat4

[static] QSettings_Format CustomFormat5

Description: Enum constant enum QSettings::CustomFormat5

[static] QSettings_Format CustomFormat6

Description: Enum constant enum QSettings::CustomFormat6

[static] QSettings_Format CustomFormat7

Description: Enum constant enum QSettings::CustomFormat7

[static] QSettings_Format CustomFormat8

Description: Enum constant enum QSettings::CustomFormat8

[static] QSettings_Format CustomFormat9

Description: Enum constant enum QSettings::CustomFormat9

[static] QSettings_Status FormatError

Description: Enum constant enum QSettings::FormatError

[static] QSettings_Format IniFormat

Description: Enum constant enum QSettings::IniFormat

[static] QSettings_Format InvalidFormat

Description: Enum constant enum QSettings::InvalidFormat

[static] QSettings_Format NativeFormat

Description: Enum constant enum QSettings::NativeFormat

[static] QSettings_Status NoError

Description: Enum constant enum QSettings::NoError

[static] QSettings_Scope SystemScope

Description: Enum constant enum QSettings::SystemScope

[static] QSettings_Scope UserScope

Description: Enum constant enum QSettings::UserScope

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

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

void beginWriteArray(string prefix,int size)

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

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

void destroy

Description: Explicitly destroy the object

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

[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

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.

[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()

void fallbacksEnabled=(bool b)

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

[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 isWritable?

Description: Method bool QSettings::isWritable()

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

[static] new QSettings new(const QSettings_Format format,const QSettings_Scope scope,string organization)

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.

[static] new QSettings new(const QSettings_Format format,const QSettings_Scope scope,string organization,string application)

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.

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

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.

[static] new QSettings new

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

This method creates an object of class QSettings.

[static] new QSettings new(QObject ptr parent)

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

This method creates an object of class QSettings.

[static] new QSettings new(string fileName,const QSettings_Format format)

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

This method creates an object of class QSettings.

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

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

This method creates an object of class QSettings.

[static] new QSettings new(string organization)

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

This method creates an object of class QSettings.

[static] new QSettings new(string organization,string application)

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

This method creates an object of class QSettings.

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

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

This method creates an object of class QSettings.

[static] new QSettings new(const QSettings_Scope scope,string organization)

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

This method creates an object of class QSettings.

[static] new QSettings new(const QSettings_Scope scope,string organization,string application)

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

This method creates an object of class QSettings.

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

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

This method creates an object of class QSettings.

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

void setFallbacksEnabled(bool b)

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

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

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)

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)

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)

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)

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

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

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