KSharedConfig Class Reference

`#include <kconfig.h>`

Inheritance diagram for KSharedConfig:

## Public Types

typedef KSharedPtr< KSharedConfig > | Ptr
Public Types inherited from KConfigBase
enum | ConfigState { NoAccess, ReadOnly, ReadWrite }

## Static Public Member Functions

static KSharedConfig::Ptr | openConfig (const QString &fileName, bool readOnly=false, bool bUseKDEGlobals=true)

## Friends

class | QValueList< KSharedConfig * >

## Additional Inherited Members

Public Member Functions inherited from KConfig
| KConfig (const QString &fileName=QString::null, bool bReadOnly=false, bool bUseKDEGlobals=true, const char *resType="config")
| KConfig (KConfigBackEnd *backEnd, bool bReadOnly=false)
virtual | ~KConfig ()
virtual void | rollback (bool bDeep=true)
virtual QStringList | groupList () const
virtual QMap< QString, QString > | entryMap (const QString &pGroup) const
virtual void | reparseConfiguration ()
void | setFileWriteMode (int mode)
void | setForceGlobal (bool force)
bool | forceGlobal () const
void | checkUpdate (const QString &id, const QString &updateFile)
KConfig * | copyTo (const QString &file, KConfig *config=0) const
KLockFile::Ptr | lockFile (bool bGlobal=false)
Public Member Functions inherited from KConfigBase
| KConfigBase ()
virtual | ~KConfigBase ()
void | setGroup (const QString &group)
void | setDesktopGroup ()
QString | group () const
bool | hasGroup (const QString &group) const
QString | locale () const
QString | readEntry (const QString &pKey, const QString &aDefault=QString::null) const
QString | readEntry (const char *pKey, const QString &aDefault=QString::null) const
QVariant | readPropertyEntry (const QString &pKey, QVariant::Type) const
QVariant | readPropertyEntry (const char *pKey, QVariant::Type) const
QVariant | readPropertyEntry (const QString &pKey, const QVariant &aDefault) const
QVariant | readPropertyEntry (const char *pKey, const QVariant &aDefault) const
int | readListEntry (const QString &pKey, QStrList &list, char sep= ',') const
int | readListEntry (const char *pKey, QStrList &list, char sep= ',') const
QStringList | readListEntry (const QString &pKey, char sep= ',') const
QStringList | readListEntry (const char *pKey, char sep= ',') const
QStringList | readListEntry (const char *pKey, const QStringList &aDefault, char sep= ',') const
QValueList< int > | readIntListEntry (const QString &pKey) const
QValueList< int > | readIntListEntry (const char *pKey) const
QString | readPathEntry (const QString &pKey, const QString &aDefault=QString::null) const
QString | readPathEntry (const char *pKey, const QString &aDefault=QString::null) const
QStringList | readPathListEntry (const QString &pKey, char sep= ',') const
QStringList | readPathListEntry (const char *pKey, char sep= ',') const
int | readNumEntry (const QString &pKey, int nDefault=0) const
int | readNumEntry (const char *pKey, int nDefault=0) const
unsigned int | readUnsignedNumEntry (const QString &pKey, unsigned int nDefault=0) const
unsigned int | readUnsignedNumEntry (const char *pKey, unsigned int nDefault=0) const
long | readLongNumEntry (const QString &pKey, long nDefault=0) const
long | readLongNumEntry (const char *pKey, long nDefault=0) const
unsigned long | readUnsignedLongNumEntry (const QString &pKey, unsigned long nDefault=0) const
unsigned long | readUnsignedLongNumEntry (const char *pKey, unsigned long nDefault=0) const
Q_INT64 | readNum64Entry (const QString &pKey, Q_INT64 nDefault=0) const
Q_INT64 | readNum64Entry (const char *pKey, Q_INT64 nDefault=0) const
Q_UINT64 | readUnsignedNum64Entry (const QString &pKey, Q_UINT64 nDefault=0) const
Q_UINT64 | readUnsignedNum64Entry (const char *pKey, Q_UINT64 nDefault=0) const
double | readDoubleNumEntry (const QString &pKey, double nDefault=0.0) const
double | readDoubleNumEntry (const char *pKey, double nDefault=0.0) const
QFont | readFontEntry (const QString &pKey, const QFont *pDefault=0L) const
QFont | readFontEntry (const char *pKey, const QFont *pDefault=0L) const
bool | readBoolEntry (const QString &pKey, bool bDefault=false) const
bool | readBoolEntry (const char *pKey, bool bDefault=false) const
QRect | readRectEntry (const QString &pKey, const QRect *pDefault=0L) const
QRect | readRectEntry (const char *pKey, const QRect *pDefault=0L) const
QPoint | readPointEntry (const QString &pKey, const QPoint *pDefault=0L) const
QPoint | readPointEntry (const char *pKey, const QPoint *pDefault=0L) const
QSize | readSizeEntry (const QString &pKey, const QSize *pDefault=0L) const
QSize | readSizeEntry (const char *pKey, const QSize *pDefault=0L) const
QColor | readColorEntry (const QString &pKey, const QColor *pDefault=0L) const
QColor | readColorEntry (const char *pKey, const QColor *pDefault=0L) const
QDateTime | readDateTimeEntry (const QString &pKey, const QDateTime *pDefault=0L) const
QDateTime | readDateTimeEntry (const char *pKey, const QDateTime *pDefault=0L) const
QString | readEntryUntranslated (const QString &pKey, const QString &aDefault=QString::null) const
QString | readEntryUntranslated (const char *pKey, const QString &aDefault=QString::null) const
void | writeEntry (const QString &pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QString &pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QVariant &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QStrList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QStrList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QValueList< int > &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const char *pValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, unsigned int nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, unsigned long nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, Q_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, Q_INT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, Q_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, Q_UINT64 nValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format= 'g', int precision=6, bool bNLS=false)
void | writeEntry (const char *pKey, double nValue, bool bPersistent=true, bool bGlobal=false, char format= 'g', int precision=6, bool bNLS=false)
void | writeEntry (const QString &pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, bool bValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QFont &rFont, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QColor &rColor, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QDateTime &rDateTime, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QRect &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QPoint &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const QString &pKey, const QSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writeEntry (const char *pKey, const QSize &rValue, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const QString &pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const char *pKey, const QString &path, bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const QString &pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | writePathEntry (const char *pKey, const QStringList &rValue, char sep= ',', bool bPersistent=true, bool bGlobal=false, bool bNLS=false)
void | deleteEntry (const QString &pKey, bool bNLS=false, bool bGlobal=false)
void | deleteEntry (const char *pKey, bool bNLS=false, bool bGlobal=false)
bool | deleteGroup (const QString &group, bool bDeep=true, bool bGlobal=false)
void | setDollarExpansion (bool _bExpand=true)
bool | isDollarExpansion () const
virtual void | sync ()
bool | isDirty () const
virtual void | setReadOnly (bool _ro)
bool | isReadOnly () const
bool | hasKey (const QString &key) const
bool | isImmutable () const
bool | groupIsImmutable (const QString &group) const
bool | entryIsImmutable (const QString &key) const
ConfigState | getConfigState () const
bool | checkConfigFilesWritable (bool warnUser)
void | setReadDefaults (bool b)
bool | readDefaults () const
void | revertToDefault (const QString &key)
bool | hasDefault (const QString &key) const
void | setGroup (const QCString &pGroup)
void | setGroup (const char *pGroup)
bool | hasGroup (const QCString &_pGroup) const
bool | hasGroup (const char *_pGroup) const
bool | hasKey (const char *pKey) const
Public Member Functions inherited from KShared
| KShared ()
| KShared (const KShared &)
KShared & | operator= (const KShared &)
void | _KShared_ref () const
void | _KShared_unref () const
int | _KShared_count () const
Protected Member Functions inherited from KConfig
virtual bool | internalHasGroup (const QCString &group) const
virtual KEntryMap | internalEntryMap (const QString &pGroup) const
virtual KEntryMap | internalEntryMap () const
virtual void | putData (const KEntryKey &_key, const KEntry &_data, bool _checkGroup=true)
virtual KEntry | lookupData (const KEntryKey &_key) const
virtual void | virtual_hook (int id, void *data)
Protected Member Functions inherited from KConfigBase
void | setLocale ()
virtual void | setDirty (bool _bDirty=true)
virtual void | parseConfigFiles ()
QCString | readEntryUtf8 (const char *pKey) const
Protected Attributes inherited from KConfig
KEntryMap | aEntryMap
Protected Attributes inherited from KConfigBase
KConfigBackEnd * | backEnd
QCString | mGroup
QCString | aLocaleString
bool | bDirty
bool | bLocaleInitialized
bool | bReadOnly
bool | bExpand

## Detailed Description

KConfig variant using shared memory.

KSharedConfig provides a reference counted, shared memory variant of KConfig.

Definition at line 273 of file kconfig.h.

## Member Function Documentation

KSharedConfig::Ptr KSharedConfig::openConfig | ( | const QString & | fileName,
|  | bool | readOnly = `false`,
|  | bool | bUseKDEGlobals = `true`
| ) |  |

static

Returns a ref-counted pointer to a shared read-write config object.

Parameters

  fileName | the name of the file to use for the configuration
  readOnly | set the config object's read-only status
  bUseKDEGlobals | Toggle reading the global KDE configuration file.

Definition at line 334 of file kconfig.cpp.

The documentation for this class was generated from the following files:

- kconfig.h
- kconfig.cpp

KDE Home | KDE Accessibility Home | Description of Access Keys