class KRootProp

 KDE Configuration Management class. More...
Definition#include <krootprop.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Detailed Description

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

 KRootProp ()

Construct a KRootProp object.

~ KRootProp ()

Destructor.

Writes back any dirty configuration entries.

void  setProp (const QString& rProp="")

Specify the property in which keys will be searched.

QString  readEntry ( const QString& rKey, const char* pDefault = 0 )

[const]

Read the value of an entry specified by rKey in the current property

Parameters:
rKeyThe key to search for.
pDefaultA default value returned if the key was not found.

Returns: The value for this key or an empty string if no value was found.

int  readNumEntry ( const QString& rKey, int nDefault = 0 )

[const]

Read a numerical value.

Read the value of an entry specified by rKey in the current property and interpret it numerically.

Parameters:
rKeyThe key to search for.
nDefaultA default value returned if the key was not found.

Returns: The value for this key or 0 if no value was found.

QFont  readFontEntry ( const QString& rKey, const QFont* pDefault = 0 )

[const]

Read a QFont.

Read the value of an entry specified by rKey in the current property and interpret it as a font object.

Parameters:
rKeyThe key to search for.
pDefaultA default value returned if the key was not found.

Returns: The value for this key or a default font if no value was found.

QColor  readColorEntry ( const QString& rKey, const QColor* pDefault = 0 )

[const]

Read a QColor.

Read the value of an entry specified by rKey in the current property and interpret it as a color.

Parameters:
rKeyThe key to search for.
pDefaultA default value returned if the key was not found.

Returns: The value for this key or a default color if no value was found.

QString  writeEntry ( const QString& rKey, const QString& rValue )

writeEntry() overridden to accept a const char * argument.

This is stored to the current property when destroying the config object or when calling Sync().

Parameters:
rKeyThe key to write.
rValueThe value to write.

Returns: The old value for this key. If this key did not exist, a null string is returned.

QString  writeEntry ( const QString& rKey, int nValue )

Write the key value pair. Same as above, but write a numerical value.

Parameters:
rKeyThe key to write.
nValueThe value to write.

Returns: The old value for this key. If this key did not exist, a null string is returned.

QString  writeEntry ( const QString& rKey, const QFont& rFont )

Write the key value pair. Same as above, but write a font

Parameters:
rKeyThe key to write.
rValueThe value to write.

Returns: The old value for this key. If this key did not exist, a null string is returned.

QString  writeEntry ( const QString& rKey, const QColor& rColor )

Write the key value pair. Same as above, but write a color

Parameters:
rKeyThe key to write.
rValueThe value to write.

Returns: The old value for this key. If this key did not exist, a null string is returned.

void  sync ()

Flush the entry cache. Write back dirty configuration entries to the current property, This is called automatically from the destructor.