PyKDE - Python Bindings for KDE
class KConfigBase
Table of contents
Modules
tdecore Classes
All Classes
Module
tdecore
Class
KConfigBase
(
abstract
)
Inherits
QObject
enums
ConfigState
= {NoAccess, ReadOnly, ReadWrite }
methods
KConfigBase
()
returns
a KConfigBase instance
checkConfigFilesWritable
(warnUser)
returns
(bool)
In versions KDE 3.2.0 and above only
Argument
Type
Default
warnUser
bool
deleteEntry
(pKey, bNLS = 0, bGlobal = 0)
returns
nothing
Argument
Type
Default
pKey
QString
bNLS
bool
0
bGlobal
bool
0
deleteEntry
(pKey, bNLS = 0, bGlobal = 0)
returns
nothing
Argument
Type
Default
pKey
char
bNLS
bool
0
bGlobal
bool
0
deleteGroup
(group, bDeep = 1, bGlobal = 0)
returns
(bool)
Argument
Type
Default
group
QString
bDeep
bool
1
bGlobal
bool
0
entryIsImmutable
(key)
returns
(bool)
Argument
Type
Default
key
QString
entryMap
(group) = 0
returns
(QMap
)
pure virtual
Argument
Type
Default
group
QString
getConfigState
()
returns
(ConfigState)
group
()
returns
(QString)
groupIsImmutable
(group)
returns
(bool)
Argument
Type
Default
group
QString
groupList
() = 0
returns
(QStringList)
pure virtual
hasDefault
(key)
returns
(bool)
In versions KDE 3.2.0 and above only
Argument
Type
Default
key
QString
hasGroup
(group)
returns
(bool)
Argument
Type
Default
group
QString
hasGroup
(_pGroup)
returns
(bool)
Argument
Type
Default
_pGroup
QCString
hasGroup
(_pGroup)
returns
(bool)
Argument
Type
Default
_pGroup
char
hasKey
(key)
returns
(bool)
Argument
Type
Default
key
QString
hasKey
(pKey)
returns
(bool)
Argument
Type
Default
pKey
char
internalEntryMap
(pGroup) = 0
returns
(KEntryMap)
pure virtual
Argument
Type
Default
pGroup
QString
internalEntryMap
() = 0
returns
(KEntryMap)
pure virtual
internalHasGroup
(group) = 0
returns
(bool)
pure virtual
Argument
Type
Default
group
QCString
isDirty
()
returns
(bool)
isDollarExpansion
()
returns
(bool)
isImmutable
()
returns
(bool)
isReadOnly
()
returns
(bool)
locale
()
returns
(QString)
lookupData
(_key) = 0
returns
(KEntry)
pure virtual
Argument
Type
Default
_key
KEntryKey
parseConfigFiles
()
returns
nothing
putData
(_key, _data, _checkGroup = 1) = 0
returns
nothing
pure virtual
Argument
Type
Default
_key
KEntryKey
_data
KEntry
_checkGroup
bool
1
readBoolEntry
(pKey, bDefault = 0)
returns
(bool)
Argument
Type
Default
pKey
QString
bDefault
bool
0
readBoolEntry
(pKey, bDefault = 0)
returns
(bool)
Argument
Type
Default
pKey
char
bDefault
bool
0
readColorEntry
(pKey, pDefault = 0)
returns
(QColor)
Argument
Type
Default
pKey
QString
pDefault
QColor
0
readColorEntry
(pKey, pDefault = 0)
returns
(QColor)
Argument
Type
Default
pKey
char
pDefault
QColor
0
readDateTimeEntry
(pKey, pDefault = 0)
returns
(QDateTime)
Argument
Type
Default
pKey
QString
pDefault
QDateTime
0
readDateTimeEntry
(pKey, pDefault = 0)
returns
(QDateTime)
Argument
Type
Default
pKey
char
pDefault
QDateTime
0
readDefaults
()
returns
(bool)
In versions KDE 3.2.0 and above only
readDoubleNumEntry
(pKey, nDefault = 0.0)
returns
(double)
Argument
Type
Default
pKey
QString
nDefault
double
0.0
readDoubleNumEntry
(pKey, nDefault = 0.0)
returns
(double)
Argument
Type
Default
pKey
char
nDefault
double
0.0
readEntry
(pKey, aDefault = QString .null)
returns
(QString)
Argument
Type
Default
pKey
QString
aDefault
QString
QString .null
readEntry
(pKey, aDefault = QString .null)
returns
(QString)
Argument
Type
Default
pKey
char
aDefault
QString
QString .null
readEntryUntranslated
(pKey, aDefault = QString .null)
returns
(QString)
Argument
Type
Default
pKey
QString
aDefault
QString
QString .null
readEntryUntranslated
(pKey, aDefault = QString .null)
returns
(QString)
Argument
Type
Default
pKey
char
aDefault
QString
QString .null
readEntryUtf8
(pKey)
returns
(QCString)
Argument
Type
Default
pKey
char
readFontEntry
(pKey, pDefault = 0)
returns
(QFont)
Argument
Type
Default
pKey
QString
pDefault
QFont
0
readFontEntry
(pKey, pDefault = 0)
returns
(QFont)
Argument
Type
Default
pKey
char
pDefault
QFont
0
readIntListEntry
(pKey)
returns
(QValueList
)
Argument
Type
Default
pKey
QString
readIntListEntry
(pKey)
returns
(QValueList
)
Argument
Type
Default
pKey
char
readListEntry
(pKey, list, sep = ',')
returns
(int)
Argument
Type
Default
pKey
QString
list
QStrList
sep
char
','
readListEntry
(pKey, list, sep = ',')
returns
(int)
Argument
Type
Default
pKey
char
list
QStrList
sep
char
','
readListEntry
(pKey, sep = ',')
returns
(QStringList)
Argument
Type
Default
pKey
QString
sep
char
','
readListEntry
(pKey, sep = ',')
returns
(QStringList)
Argument
Type
Default
pKey
char
sep
char
','
readListEntry
(pKey, aDefault, sep = ',')
returns
(QStringList)
In versions KDE 3.3.0 and above only
Argument
Type
Default
pKey
char
aDefault
QStringList
sep
char
','
readLongNumEntry
(pKey, nDefault = 0)
returns
(long)
Argument
Type
Default
pKey
QString
nDefault
long
0
readLongNumEntry
(pKey, nDefault = 0)
returns
(long)
Argument
Type
Default
pKey
char
nDefault
long
0
readNum64Entry
(pKey, nDefault = 0)
returns
(longlong)
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
QString
nDefault
longlong
0
readNum64Entry
(pKey, nDefault = 0)
returns
(longlong)
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
char
nDefault
longlong
0
readNumEntry
(pKey, nDefault = 0)
returns
(int)
Argument
Type
Default
pKey
QString
nDefault
int
0
readNumEntry
(pKey, nDefault = 0)
returns
(int)
Argument
Type
Default
pKey
char
nDefault
int
0
readPathEntry
(pKey, aDefault = QString .null)
returns
(QString)
Argument
Type
Default
pKey
QString
aDefault
QString
QString .null
readPathEntry
(pKey, aDefault = QString .null)
returns
(QString)
Argument
Type
Default
pKey
char
aDefault
QString
QString .null
readPathListEntry
(pKey, sep = ',')
returns
(QStringList)
In versions KDE 3.1.3 and above only
Argument
Type
Default
pKey
QString
sep
char
','
readPathListEntry
(pKey, sep = ',')
returns
(QStringList)
In versions KDE 3.1.3 and above only
Argument
Type
Default
pKey
char
sep
char
','
readPointEntry
(pKey, pDefault = 0)
returns
(QPoint)
Argument
Type
Default
pKey
QString
pDefault
QPoint
0
readPointEntry
(pKey, pDefault = 0)
returns
(QPoint)
Argument
Type
Default
pKey
char
pDefault
QPoint
0
readPropertyEntry
(pKey, a0)
returns
(QVariant)
Argument
Type
Default
pKey
QString
a0
QVariant.Type
readPropertyEntry
(pKey, a0)
returns
(QVariant)
Argument
Type
Default
pKey
char
a0
QVariant.Type
readPropertyEntry
(pKey, aDefault)
returns
(QVariant)
Argument
Type
Default
pKey
QString
aDefault
QVariant
readPropertyEntry
(pKey, aDefault)
returns
(QVariant)
Argument
Type
Default
pKey
char
aDefault
QVariant
readRectEntry
(pKey, pDefault = 0)
returns
(QRect)
Argument
Type
Default
pKey
QString
pDefault
QRect
0
readRectEntry
(pKey, pDefault = 0)
returns
(QRect)
Argument
Type
Default
pKey
char
pDefault
QRect
0
readSizeEntry
(pKey, pDefault = 0)
returns
(QSize)
Argument
Type
Default
pKey
QString
pDefault
QSize
0
readSizeEntry
(pKey, pDefault = 0)
returns
(QSize)
Argument
Type
Default
pKey
char
pDefault
QSize
0
readUnsignedLongNumEntry
(pKey, nDefault = 0)
returns
(ulong)
Argument
Type
Default
pKey
QString
nDefault
ulong
0
readUnsignedLongNumEntry
(pKey, nDefault = 0)
returns
(ulong)
Argument
Type
Default
pKey
char
nDefault
ulong
0
readUnsignedNum64Entry
(pKey, nDefault = 0)
returns
(ulonglong)
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
QString
nDefault
ulonglong
0
readUnsignedNum64Entry
(pKey, nDefault = 0)
returns
(ulonglong)
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
char
nDefault
ulonglong
0
readUnsignedNumEntry
(pKey, nDefault = 0)
returns
(uint)
Argument
Type
Default
pKey
QString
nDefault
uint
0
readUnsignedNumEntry
(pKey, nDefault = 0)
returns
(uint)
Argument
Type
Default
pKey
char
nDefault
uint
0
reparseConfiguration
() = 0
returns
nothing
pure virtual
revertToDefault
(key)
returns
nothing
In versions KDE 3.2.0 and above only
Argument
Type
Default
key
QString
rollback
(bDeep = 1)
returns
nothing
Argument
Type
Default
bDeep
bool
1
setDesktopGroup
()
returns
nothing
setDirty
(_bDirty = 1)
returns
nothing
Argument
Type
Default
_bDirty
bool
1
setDollarExpansion
(_bExpand = 1)
returns
nothing
Argument
Type
Default
_bExpand
bool
1
setGroup
(group)
returns
nothing
Argument
Type
Default
group
QString
setGroup
(pGroup)
returns
nothing
Argument
Type
Default
pGroup
QCString
setGroup
(pGroup)
returns
nothing
Argument
Type
Default
pGroup
char
setLocale
()
returns
nothing
setReadDefaults
(b)
returns
nothing
In versions KDE 3.2.0 and above only
Argument
Type
Default
b
bool
setReadOnly
(_ro)
returns
nothing
Argument
Type
Default
_ro
bool
sync
()
returns
nothing
writeEntry
(pKey, pValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
pValue
QString
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, pValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
pValue
QString
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, pValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
pValue
char
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, pValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
pValue
char
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
nValue
int
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
nValue
int
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
QString
nValue
longlong
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
char
nValue
longlong
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
QString
nValue
ulonglong
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
In versions KDE 3.2.0 and above only
Argument
Type
Default
pKey
char
nValue
ulonglong
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, format = 'g', precision = 6, bNLS = 0)
Not Implemented
writeEntry
(pKey, nValue, bPersistent = 1, bGlobal = 0, format = 'g', precision = 6, bNLS = 0)
Not Implemented
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QVariant
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rFont, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rFont
QFont
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rFont, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rFont
QFont
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rColor, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rColor
QColor
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rColor, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rColor
QColor
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rDateTime, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rDateTime
QDateTime
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rDateTime, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rDateTime
QDateTime
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QRect
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QRect
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QPoint
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QPoint
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QVariant
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QSize
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QSize
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, sep = ',', bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QStrList
sep
char
','
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, sep = ',', bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QStrList
sep
char
','
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, sep = ',', bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QStringList
sep
char
','
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, sep = ',', bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QStringList
sep
char
','
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
rValue
QValueList
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writeEntry
(pKey, rValue, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
rValue
QValueList
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writePathEntry
(pKey, path, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
QString
path
QString
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writePathEntry
(pKey, path, bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
Argument
Type
Default
pKey
char
path
QString
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writePathEntry
(pKey, rValue, sep = ',', bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
In versions KDE 3.1.3 and above only
Argument
Type
Default
pKey
QString
rValue
QStringList
sep
char
','
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0
writePathEntry
(pKey, rValue, sep = ',', bPersistent = 1, bGlobal = 0, bNLS = 0)
returns
nothing
In versions KDE 3.1.3 and above only
Argument
Type
Default
pKey
char
rValue
QStringList
sep
char
','
bPersistent
bool
1
bGlobal
bool
0
bNLS
bool
0