Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > by-pkgid > 6282078ae76a671f49c6af38c67b1a07 > files > 477

kdelibs-devel-2.2.2-49.2mdk.i586.rpm

<HTML>
<HEAD>
<TITLE>class KConfigDBMBackEnd</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 KConfigDBMBackEnd</h1>
		</TD>
		<TD valign="top" align="right" colspan="1">(Not yet in libkdecore) Backend to use dbm files as configuration files.
   <small><A HREF="#longdesc">More...</A></small></TD></TR>
	</TABLE>
	<HR>
	<TABLE BORDER="0">
		<TR><TH>Definition</TH><TD><code>#include &lt;<A HREF="kdbmconfigbackend_h.html">kdbmconfigbackend.h</A>&gt;</code></TD></TR>
<TR><TH>Inherits</TH><TD><i><A HREF="KConfigBackEnd.html">KConfigBackEnd</A></i> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-KConfigDBMBackEnd.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>&nbsp;<b><A HREF="#ref1">KConfigDBMBackEnd</A></b> (<A HREF="KConfigBase.html">KConfigBase</A> *_config, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> &_fileName,
                    const char * _resType, bool _useKDEGlobals = true) 
</LI>
<LI>virtual  &nbsp;<b><A HREF="#ref2">~KConfigDBMBackEnd</A></b> () 
</LI>
<LI>bool &nbsp;<b><A HREF="#ref3">parseConfigFiles</A></b> () 
</LI>
<LI>virtual  void &nbsp;<b><A HREF="#ref4">sync</A></b> (bool bMerge = true) 
</LI>
</ul><h4>Protected Methods</h4><ul><LI>void &nbsp;<b><A HREF="#ref5">parseSingleConfigFile</A></b> (void *rFile, <A HREF="#KEntryMap">KEntryMap</A> *pWriteBackMap = 0L,
                             bool bGlobal = false) 
</LI>
<LI>bool &nbsp;<b><A HREF="#ref6">writeConfigFile</A></b> (<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> filename, bool bGlobal = false, bool bMerge = true) 
</LI>
<LI>virtual  <A HREF="KConfigBase.html#ConfigState">KConfigBase::ConfigState</A> &nbsp;<b><A HREF="#ref7">getConfigState</A></b> ()  const
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
</p>
<A NAME="KConfigDBMBackEnd"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>&nbsp;<strong>KConfigDBMBackEnd</strong> (<A HREF="KConfigBase.html">KConfigBase</A> *_config, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> &_fileName,
                    const char * _resType, bool _useKDEGlobals = true)
<br></td><td align="right"><h3><strong>KConfigDBMBackEnd</strong></h3></td></tr></table><p></p><p>
 Construct a configuration back end.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>_config</i></TD><TD align="left" valign="top">Specifies the configuration object which values
        will be passed to as they are read, or from where values
        to be written to will be obtained from.
</TD></TR>
<TR><TD align="left" valign="top"><i>_fileName</i></TD><TD align="left" valign="top">The name of the file in which config
        data is stored.  All registered configuration directories
        will be looked in in order of decreasing relevance.
</TD></TR>
<TR><TD align="left" valign="top"><i>_resType</i></TD><TD align="left" valign="top">the resource type of the fileName specified, _if_
        it is not an absolute path (otherwise this parameter is ignored).
</TD></TR>
<TR><TD align="left" valign="top"><i>_useKDEGlobals</i></TD><TD align="left" valign="top">If true, the user's system-wide kdeglobals file
        will be imported into the config object.  If false, only
        the filename specified will be dealt with.
   </TD></TR>
</TABLE></P>
<A NAME="~KConfigDBMBackEnd"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> &nbsp;<strong>~KConfigDBMBackEnd</strong> ()
<br></td><td align="right"><h3><strong>~KConfigDBMBackEnd</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 Destructor.
   </p>
<A NAME="parseConfigFiles"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool &nbsp;<strong>parseConfigFiles</strong> ()
<br></td><td align="right"><h3><strong>parseConfigFiles</strong></h3></td></tr></table><p></p><p>
 Parse all DBM configuration files for a config object.
</p>
<p></p>
<p><b>Returns</b>: Whether or not parsing was successful.
   </p>
<p>Reimplemented from <A HREF="KConfigBackEnd.html#parseConfigFiles">KConfigBackEnd</A>.</p>
<A NAME="sync"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void &nbsp;<strong>sync</strong> (bool bMerge = true)
<br></td><td align="right"><h3><strong>sync</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
 write configuration data to file(s).
   </p>
<p>Reimplemented from <A HREF="KConfigBackEnd.html#sync">KConfigBackEnd</A>.</p>
<A NAME="parseSingleConfigFile"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void &nbsp;<strong>parseSingleConfigFile</strong> (void *rFile, <A HREF="#KEntryMap">KEntryMap</A> *pWriteBackMap = 0L,
                             bool bGlobal = false)
<br></td><td align="right"><h3><strong>parseSingleConfigFile</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Parse one configuration file.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>rFile</i></TD><TD align="left" valign="top">The configuration file to parse
</TD></TR>
<TR><TD align="left" valign="top"><i>pWriteBackMap</i></TD><TD align="left" valign="top">If specified, points to a KEntryMap where
        the data read from the file should be stored, instead of
        inserting them directly into the configuration object.
        Use this area as a "scratchpad" when you need to know what is
        on disk but don't want to effect the configuration object.
</TD></TR>
<TR><TD align="left" valign="top"><i>bGlobal</i></TD><TD align="left" valign="top">Specifies whether entries should be marked as
        belonging to the global KDE configuration file rather
        than the application-specific KDE configuration file(s).
   </TD></TR>
</TABLE></P>
<A NAME="writeConfigFile"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool &nbsp;<strong>writeConfigFile</strong> (<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qstring.html">QString</A> filename, bool bGlobal = false, bool bMerge = true)
<br></td><td align="right"><h3><strong>writeConfigFile</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
 Write configuration file back.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>filename</i></TD><TD align="left" valign="top">The name of the file to write.
</TD></TR>
<TR><TD align="left" valign="top"><i>bGlobal</i></TD><TD align="left" valign="top">Specifies whether to write only entries which
        are marked as belonging to the global KDE config file.
        If this is false, it skips those entries.
</TD></TR>
<TR><TD align="left" valign="top"><i>bMerge</i></TD><TD align="left" valign="top">Specifies whether the old config file already
        on disk should be merged in with the data in memory.  If true,
        data is read off the disk and merged.  If false, the on-disk
        file is removed and only in-memory data is written out.
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Whether some entries are left to be written to other
         files.
   </p>
<A NAME="getConfigState"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="KConfigBase.html#ConfigState">KConfigBase::ConfigState</A> &nbsp;<strong>getConfigState</strong> ()
<br></td><td align="right"><h3><strong>getConfigState</strong></h3></td></tr></table><p> <small>[protected const virtual]</small></p><p>
 Retrieve the state of the app-config object.
</p>
<p></p>
<p><b>See also</b>: KConfig::getConfigState</p>
<p>Reimplemented from <A HREF="KConfigBackEnd.html#getConfigState">KConfigBackEnd</A>.</p>
<HR>
	<table>
	<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:08:56 2002, using kdoc 2.0a53.</small></td></tr>
	</table>
</BODY>
</HTML>