QSettings Class Reference

QSettings Class Reference
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions

#include <qsettings.h>

Class Description

Definition at line 73 of file qsettings.h.

+ Inheritance diagram for QSettings:

Public Types

enum  Status { NoError = 0, AccessError, FormatError }
 
enum  Format {
  NativeFormat, IniFormat, InvalidFormat = 16, CustomFormat1,
  CustomFormat2, CustomFormat3, CustomFormat4, CustomFormat5,
  CustomFormat6, CustomFormat7, CustomFormat8, CustomFormat9,
  CustomFormat10, CustomFormat11, CustomFormat12, CustomFormat13,
  CustomFormat14, CustomFormat15, CustomFormat16
}
 
enum  Scope { UserScope, SystemScope }
 
typedef QMap< QString, QVariant > SettingsMap
 
typedef bool(* ReadFunc) (QIODevice &device, SettingsMap &map)
 
typedef bool(* WriteFunc) (QIODevice &device, const SettingsMap &map)
 

Public Member Functions

 QSettings (const QString &organization, const QString &application=QString(), QObject *parent=0)
 
 QSettings (Scope scope, const QString &organization, const QString &application=QString(), QObject *parent=0)
 
 QSettings (Format format, Scope scope, const QString &organization, const QString &application=QString(), QObject *parent=0)
 
 QSettings (const QString &fileName, Format format, QObject *parent=0)
 
 QSettings (QObject *parent=0)
 
 ~QSettings ()
 
void clear ()
 
void sync ()
 
Status status () const
 
void beginGroup (const QString &prefix)
 
void endGroup ()
 
QString group () const
 
int beginReadArray (const QString &prefix)
 
void beginWriteArray (const QString &prefix, int size=-1)
 
void endArray ()
 
void setArrayIndex (int i)
 
QStringList allKeys () const
 
QStringList childKeys () const
 
QStringList childGroups () const
 
bool isWritable () const
 
void setValue (const QString &key, const QVariant &value)
 
QVariant value (const QString &key, const QVariant &defaultValue=QVariant()) const
 
void remove (const QString &key)
 
bool contains (const QString &key) const
 
void setFallbacksEnabled (bool b)
 
bool fallbacksEnabled () const
 
QString fileName () const
 
Format format () const
 
Scope scope () const
 
QString organizationName () const
 
QString applicationName () const
 
void setIniCodec (QTextCodec *codec)
 
void setIniCodec (const char *codecName)
 
QTextCodec * iniCodec () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=0)
 
virtual ~QObject ()
 
virtual bool eventFilter (QObject *, QEvent *)
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool b)
 
QThread * thread () const
 
void moveToThread (QThread *thread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
template<typename T >
T findChild (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
const QObjectList & children () const
 
void setParent (QObject *)
 
void installEventFilter (QObject *)
 
void removeEventFilter (QObject *)
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArray > dynamicPropertyNames () const
 
void setUserData (uint id, QObjectUserData *data)
 
QObjectUserData * userData (uint id) const
 
QObject * parent () const
 
bool inherits (const char *classname) const
 

Static Public Member Functions

static void setDefaultFormat (Format format)
 
static Format defaultFormat ()
 
static void setSystemIniPath (const QString &dir)
 
static void setUserIniPath (const QString &dir)
 
static void setPath (Format format, Scope scope, const QString &path)
 
static Format registerFormat (const QString &extension, ReadFunc readFunc, WriteFunc writeFunc, Qt::CaseSensitivity caseSensitivity=Qt::CaseSensitive)
 
- Static Public Member Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 

Protected Member Functions

bool event (QEvent *event)
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
virtual void timerEvent (QTimerEvent *)
 
virtual void childEvent (QChildEvent *)
 
virtual void customEvent (QEvent *)
 
virtual void connectNotify (const char *signal)
 
virtual void disconnectNotify (const char *signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Static Protected Attributes inherited from QObject
static const QMetaObject staticQtMetaObject
 
- Properties inherited from QObject
QString objectName
 

Member Typedef Documentation

typedef QMap<QString, QVariant> SettingsMap

Definition at line 190 of file qsettings.h.

typedef bool(* ReadFunc) (QIODevice &device, SettingsMap &map)

Definition at line 191 of file qsettings.h.

typedef bool(* WriteFunc) (QIODevice &device, const SettingsMap &map)

Definition at line 192 of file qsettings.h.

Member Enumeration Documentation

enum Status
Enumerator
NoError 
AccessError 
FormatError 

Definition at line 86 of file qsettings.h.

86  {
87  NoError = 0,
88  AccessError,
89  FormatError
90  };
enum Format
Enumerator
NativeFormat 
IniFormat 
InvalidFormat 
CustomFormat1 
CustomFormat2 
CustomFormat3 
CustomFormat4 
CustomFormat5 
CustomFormat6 
CustomFormat7 
CustomFormat8 
CustomFormat9 
CustomFormat10 
CustomFormat11 
CustomFormat12 
CustomFormat13 
CustomFormat14 
CustomFormat15 
CustomFormat16 

Definition at line 92 of file qsettings.h.

92  {
93  NativeFormat,
94  IniFormat,
95 
96  InvalidFormat = 16,
97  CustomFormat1,
98  CustomFormat2,
99  CustomFormat3,
100  CustomFormat4,
101  CustomFormat5,
102  CustomFormat6,
103  CustomFormat7,
104  CustomFormat8,
105  CustomFormat9,
106  CustomFormat10,
107  CustomFormat11,
108  CustomFormat12,
109  CustomFormat13,
110  CustomFormat14,
111  CustomFormat15,
112  CustomFormat16
113  };
enum Scope
Enumerator
UserScope 
SystemScope 

Definition at line 115 of file qsettings.h.

115  {
116  UserScope,
117  SystemScope
118 #ifdef QT3_SUPPORT
119  ,
120  User = UserScope,
121  Global = SystemScope
122 #endif
123  };

Constructor & Destructor Documentation

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

Member Function Documentation

void clear ( )
void sync ( )
Status status ( ) const
void beginGroup ( const QString &  prefix)
void endGroup ( )
QString group ( ) const
int beginReadArray ( const QString &  prefix)
void beginWriteArray ( const QString &  prefix,
int  size = -1 
)
void endArray ( )
void setArrayIndex ( int  i)
QStringList allKeys ( ) const
QStringList childKeys ( ) const
QStringList childGroups ( ) const
bool isWritable ( ) const
void setValue ( const QString &  key,
const QVariant &  value 
)
QVariant value ( const QString &  key,
const QVariant &  defaultValue = QVariant() 
) const
void remove ( const QString &  key)
bool contains ( const QString &  key) const
void setFallbacksEnabled ( bool  b)
bool fallbacksEnabled ( ) const
QString fileName ( ) const
Format format ( ) const
Scope scope ( ) const
QString organizationName ( ) const
QString applicationName ( ) const
void setIniCodec ( QTextCodec *  codec)
void setIniCodec ( const char *  codecName)
QTextCodec* iniCodec ( ) const
static void setDefaultFormat ( Format  format)
static
static Format defaultFormat ( )
static
static void setSystemIniPath ( const QString &  dir)
static
static void setUserIniPath ( const QString &  dir)
static
static void setPath ( Format  format,
Scope  scope,
const QString &  path 
)
static
static Format registerFormat ( const QString &  extension,
ReadFunc  readFunc,
WriteFunc  writeFunc,
Qt::CaseSensitivity  caseSensitivity = Qt::CaseSensitive 
)
static
bool event ( QEvent *  event)
protectedvirtual

Reimplemented from QObject.

The documentation for this class was generated from the following file:
Please send us your comment about this page