<HTML> <HEAD> <TITLE>class KRootProp</TITLE> <META NAME="Generator" CONTENT="KDOC "> </HEAD> <BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff"> <TABLE WIDTH="100%" BORDER="0"> <TR> <TD> <TABLE BORDER="0"> <TR><TD valign="top" align="left" cellspacing="10"> <h1>class KRootProp</h1> </TD> <TD valign="top" align="right" colspan="1"> Access KDE desktop resources stored on the root window. <small><A HREF="#longdesc">More...</A></small></TD></TR> </TABLE> <HR> <TABLE BORDER="0"> <TR><TH>Definition</TH><TD><code>#include <<A HREF="krootprop_h.html">krootprop.h</A>></code></TD></TR> <TR><TH><A HREF="full-list-KRootProp.html">List of all Methods</A></TH></TR> </TABLE> </TD> <TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR> <TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR> <TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR> <TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR> <TR><TD><small><A HREF="index.html">Index</A></small></TD></TR> </TABLE></TD></TR></TABLE> <h4>Public Methods</h4><ul><LI> <b><A HREF="#ref6">KRootProp</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rProp = QString::null ) </LI> <LI> <b><A HREF="#ref7">~KRootProp</A></b> () </LI> <LI>void <b><A HREF="#ref8">setProp</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rProp="") </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref9">prop</A></b> () const </LI> <LI>void <b><A HREF="#ref10">destroy</A></b> () </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref11">readEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& pDefault = QString::null ) const </LI> <LI>int <b><A HREF="#ref12">readNumEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, int nDefault = 0 ) const </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A> <b><A HREF="#ref13">readFontEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A>* pDefault = 0 ) const </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A> <b><A HREF="#ref14">readColorEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A>* pDefault = 0 ) const </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref15">writeEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rValue ) </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref16">writeEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, int nValue ) </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref17">writeEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A>& rFont ) </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref18">writeEntry</A></b> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A>& rColor ) </LI> <LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <b><A HREF="#ref19">removeEntry</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey) </LI> <LI><A HREF="#QStringList">QStringList</A> <b><A HREF="#ref20">listEntries</A></b> () const </LI> <LI>void <b><A HREF="#ref21">sync</A></b> () </LI> </ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p> Access KDE desktop resources stored on the root window. </p> <p> A companion to the <A HREF="KConfig.html">KConfig</A> class. </p> <p> The <A HREF="KRootProp.html#KRootProp">KRootProp</A> class is used for reading and writing configuration entries to properties on the root window. </p> <p> All configuration entries are of the form "key=value". </p> <p></p> <p><b>See also</b>: <A HREF="KConfig.html#KConfig">KConfig</A></p> <A NAME="KRootProp"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>KRootProp</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rProp = QString::null ) <br></td><td align="right"><h3><strong>KRootProp</strong></h3></td></tr></table><p></p><p> Construct a <A HREF="KRootProp.html#KRootProp">KRootProp</A> object for the property <code>rProp</code>. </p> <p></p> <A NAME="~KRootProp"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~KRootProp</strong> () <br></td><td align="right"><h3><strong>~KRootProp</strong></h3></td></tr></table><p></p><p> Destructor. </p> <p> Writes back any dirty configuration entries. </p> <A NAME="setProp"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setProp</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rProp="") <br></td><td align="right"><h3><strong>setProp</strong></h3></td></tr></table><p></p><p> Specify the property in which keys will be searched. </p> <p></p> <A NAME="prop"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>prop</strong> () <br></td><td align="right"><h3><strong>prop</strong></h3></td></tr></table><p> <small>[const]</small></p><p> Retrieve the name of the property under which keys are searched. </p> <A NAME="destroy"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>destroy</strong> () <br></td><td align="right"><h3><strong>destroy</strong></h3></td></tr></table><p></p><p> Destroy the property completely. </p> <p> I.e. all entries will be cleared and the property will be removed from the root window. </p> <A NAME="readEntry"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>readEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& pDefault = QString::null ) <br></td><td align="right"><h3><strong>readEntry</strong></h3></td></tr></table><p> <small>[const]</small></p><p> Read the value of an entry specified by <code>rKey</code> in the current property </p> <p></p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to search for. </TD></TR> <TR><TD align="left" valign="top"><i>pDefault</i></TD><TD align="left" valign="top">A default value returned if the key was not found. </TD></TR> </TABLE></P> <p><b>Returns</b>: The value for this key or the default if no value was found. </p> <A NAME="readNumEntry"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>readNumEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, int nDefault = 0 ) <br></td><td align="right"><h3><strong>readNumEntry</strong></h3></td></tr></table><p> <small>[const]</small></p><p> Read a numerical value. </p> <p> Read the value of an entry specified by <code>rKey</code> in the current property and interpret it numerically. </p> <p></p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to search for. </TD></TR> <TR><TD align="left" valign="top"><i>nDefault</i></TD><TD align="left" valign="top">A default value returned if the key was not found. </TD></TR> </TABLE></P> <p><b>Returns</b>: The value for this key or the default if no value was found. </p> <A NAME="readFontEntry"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A> <strong>readFontEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A>* pDefault = 0 ) <br></td><td align="right"><h3><strong>readFontEntry</strong></h3></td></tr></table><p> <small>[const]</small></p><p> Read a <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A>. </p> <p> Read the value of an entry specified by <code>rKey</code> in the current property and interpret it as a font object. </p> <p></p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to search for. </TD></TR> <TR><TD align="left" valign="top"><i>pDefault</i></TD><TD align="left" valign="top">A default value returned if the key was not found. </TD></TR> </TABLE></P> <p><b>Returns</b>: The value for this key or a default font if no value was found. </p> <A NAME="readColorEntry"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A> <strong>readColorEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A>* pDefault = 0 ) <br></td><td align="right"><h3><strong>readColorEntry</strong></h3></td></tr></table><p> <small>[const]</small></p><p> Read a <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A>. </p> <p> Read the value of an entry specified by <code>rKey</code> in the current property and interpret it as a color. </p> <p></p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to search for. </TD></TR> <TR><TD align="left" valign="top"><i>pDefault</i></TD><TD align="left" valign="top">A default value returned if the key was not found. </TD></TR> </TABLE></P> <p><b>Returns</b>: The value for this key or a default color if no value was found. </p> <A NAME="writeEntry"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>writeEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rValue ) <br></td><td align="right"><h3><strong>writeEntry</strong></h3></td></tr></table><p></p><p> <A HREF="KRootProp.html#writeEntry">writeEntry</A>() overridden to accept a const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& argument. </p> <p> This is stored to the current property when destroying the config object or when calling <A HREF="KRootProp.html#sync">sync</A>(). </p> <p></p> <p></p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to write. </TD></TR> <TR><TD align="left" valign="top"><i>rValue</i></TD><TD align="left" valign="top">The value to write. </TD></TR> </TABLE></P> <p><b>Returns</b>: The old value for this key. If this key did not exist, a null string is returned. </p> <A NAME="writeEntry"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>writeEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, int nValue ) <br></td><td align="right"><h3><strong>writeEntry</strong></h3></td></tr></table><p></p><p> Write the key value pair. Same as above, but write a numerical value. </p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to write. </TD></TR> <TR><TD align="left" valign="top"><i>nValue</i></TD><TD align="left" valign="top">The value to write. </TD></TR> </TABLE></P> <p><b>Returns</b>: The old value for this key. If this key did not exist, a null string is returned. </p> <A NAME="writeEntry"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>writeEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qfont.html">QFont</A>& rFont ) <br></td><td align="right"><h3><strong>writeEntry</strong></h3></td></tr></table><p></p><p> Write the key value pair. Same as above, but write a font. </p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to write. </TD></TR> <TR><TD align="left" valign="top"><i>rValue</i></TD><TD align="left" valign="top">The value to write. </TD></TR> </TABLE></P> <p><b>Returns</b>: The old value for this key. If this key did not exist, a null string is returned. </p> <A NAME="writeEntry"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>writeEntry</strong> ( const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcolor.html">QColor</A>& rColor ) <br></td><td align="right"><h3><strong>writeEntry</strong></h3></td></tr></table><p></p><p> Write the key value pair. Same as above, but write a color. </p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to write. </TD></TR> <TR><TD align="left" valign="top"><i>rValue</i></TD><TD align="left" valign="top">The value to write. </TD></TR> </TABLE></P> <p><b>Returns</b>: The old value for this key. If this key did not exist, a null string is returned. </p> <A NAME="removeEntry"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> <strong>removeEntry</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A>& rKey) <br></td><td align="right"><h3><strong>removeEntry</strong></h3></td></tr></table><p></p><p> Remove an entry. </p> <p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5"> <TR><TD align="left" valign="top"><i>rKey</i></TD><TD align="left" valign="top">The key to remove. </TD></TR> </TABLE></P> <p><b>Returns</b>: The old value for this key. If this key did not exist, a null string is returned. </p> <A NAME="listEntries"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="#QStringList">QStringList</A> <strong>listEntries</strong> () <br></td><td align="right"><h3><strong>listEntries</strong></h3></td></tr></table><p> <small>[const]</small></p><p> Get a list of all keys. </p> <p><b>Returns</b>: A <A HREF="#QStringList">QStringList</A> containing all the keys. </p> <A NAME="sync"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>sync</strong> () <br></td><td align="right"><h3><strong>sync</strong></h3></td></tr></table><p></p><p> Flush the entry cache. Write back dirty configuration entries to the current property, This is called automatically from the destructor. </p> <HR><UL><LI><i>Version</i>: $Id: krootprop.h,v 1.15 2001/04/04 15:10:45 mueller Exp $ </LI><LI><i>Author</i>: Mark Donohoe (donohe@kde.org) </LI><LI><i>Generated</i>: qateam on updates.mandrakesoft.com on Mon Dec 30 16:08:56 2002, using kdoc 2.0a53.</LI></UL></BODY></HTML>
