KRootProp Class Reference
Access KDE desktop resources stored on the root window. More...
#include <krootprop.h>
Collaboration diagram for KRootProp:

Public Member Functions | |
KRootProp (const QString &rProp=QString::null) | |
Constructs a KRootProp object for the property rProp . | |
~KRootProp () | |
Destructs the KRootProp object. | |
void | setProp (const QString &rProp="") |
Sets the property in which keys will be searched. | |
QString | prop () const |
Returns the name of the property under which keys are searched. | |
void | destroy () |
Destroys the property completely. | |
QString | readEntry (const QString &rKey, const QString &pDefault=QString::null) const |
Reads the value of an entry specified by rKey in the current property. | |
int | readNumEntry (const QString &rKey, int nDefault=0) const |
Reads a numerical value. | |
QFont | readFontEntry (const QString &rKey, const QFont *pDefault=0) const |
Reads a QFont value. | |
QColor | readColorEntry (const QString &rKey, const QColor *pDefault=0) const |
Reads a QColor. | |
QString | writeEntry (const QString &rKey, const QString &rValue) |
Writes a (key/value) pair. | |
QString | writeEntry (const QString &rKey, int nValue) |
Writes the (key/value) pair. | |
QString | writeEntry (const QString &rKey, const QFont &rFont) |
Writes the (key/value) pair. | |
QString | writeEntry (const QString &rKey, const QColor &rColor) |
Writes the (key/value) pair. | |
QString | removeEntry (const QString &rKey) |
Removes an entry. | |
QStringList | listEntries () const |
Returns a list of all keys. | |
void | sync () |
Flushes the entry cache. |
Detailed Description
Access KDE desktop resources stored on the root window.A companion to the KConfig class.
The KRootProp class is used for reading and writing configuration entries to properties on the root window.
All configuration entries are of the form "key=value".
- See also:
- KConfig::KConfig
- Author:
- Mark Donohoe (donohe@kde.org)
- Version:
- Id
- krootprop.h,v 1.20 2002/09/19 20:05:11 tjansen Exp
Definition at line 45 of file krootprop.h.
Constructor & Destructor Documentation
|
Constructs a KRootProp object for the property
Definition at line 32 of file krootprop.cpp. References setProp(). |
|
Destructs the KRootProp object. Writes back any dirty configuration entries. Definition at line 39 of file krootprop.cpp. References QMap< QString, QString >::clear(), and sync(). |
Member Function Documentation
|
Sets the property in which keys will be searched.
Definition at line 71 of file krootprop.cpp. References QString::find(), QString::fromUtf8(), QMap< QString, QString >::insert(), KStdAccel::key(), QString::left(), QString::length(), QString::mid(), QString::remove(), QString::simplifyWhiteSpace(), and sync(). Referenced by KRootProp(). |
|
Returns the name of the property under which keys are searched.
Definition at line 141 of file krootprop.cpp. |
|
Destroys the property completely. I.e. all entries will be cleared and the property will be removed from the root window. Definition at line 146 of file krootprop.cpp. References QMap< QString, QString >::clear(). |
|
Reads the value of an entry specified by
Definition at line 156 of file krootprop.cpp. References QMap< QString, QString >::contains(). Referenced by readColorEntry(), readFontEntry(), and readNumEntry(). |
|
Reads a numerical value.
Reads the value of an entry specified by
Definition at line 165 of file krootprop.cpp. References QString::isNull(), readEntry(), and QString::toInt(). |
|
Reads a QFont value.
Reads the value of an entry specified by
Definition at line 181 of file krootprop.cpp. References QFont::fromString(), QString::isNull(), and readEntry(). |
|
Reads a QColor.
Reads the value of an entry specified by
Definition at line 201 of file krootprop.cpp. References QString::find(), QString::isNull(), QString::left(), QString::mid(), readEntry(), QColor::setNamedColor(), and QColor::setRgb(). |
|
Writes a (key/value) pair. This is stored to the current property when destroying the config object or when calling sync().
Definition at line 242 of file krootprop.cpp. References QMap< QString, QString >::contains(), QMap< QString, QString >::insert(), and QString::replace(). Referenced by writeEntry(). |
|
Writes the (key/value) pair. Same as above, but writes a numerical value.
Definition at line 256 of file krootprop.cpp. References QString::setNum(), and writeEntry(). |
|
Writes the (key/value) pair. Same as above, but writes a font.
Definition at line 265 of file krootprop.cpp. References QFont::toString(), and writeEntry(). |
|
Writes the (key/value) pair. Same as above, but writes a color.
Definition at line 270 of file krootprop.cpp. References QString::arg(), QColor::blue(), QColor::green(), QColor::red(), and writeEntry(). |
|
Removes an entry.
Definition at line 277 of file krootprop.cpp. References QMap< QString, QString >::contains(), and QString::remove(). |
|
Returns a list of all keys.
Definition at line 288 of file krootprop.cpp. References QMap< QString, QString >::begin(), and QMap< QString, QString >::end(). |
|
Flushes the entry cache. Writes back dirty configuration entries to the current property, This is called automatically from the destructor. Definition at line 45 of file krootprop.cpp. References QString::arg(), QMap< QString, QString >::begin(), QMap< QString, QString >::end(), QMap< QString, QString >::isEmpty(), QString::length(), and QString::utf8(). Referenced by setProp(), and ~KRootProp(). |
The documentation for this class was generated from the following files: