<HTML>
<HEAD>
<TITLE>class KDEDModule</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 KDEDModule</h1>
</TD>
<TD valign="top" align="right" colspan="1">
The base class for KDED modules. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Definition</TH><TD><code>#include <<A HREF="kdedmodule_h.html">kdedmodule.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="../dcop/DCOPObject.html">DCOPObject</A> <small>(dcop)</small> <small>[public ]</small>, <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qobject.html">QObject</A> <small>(qt)</small> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-KDEDModule.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="#ref1">KDEDModule</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &name)
</LI>
<LI>virtual <b><A HREF="#ref2">~KDEDModule</A></b> ()
</LI>
<LI>void <b><A HREF="#ref3">setIdleTimeout</A></b> (int secs)
</LI>
<LI>void <b><A HREF="#ref4">resetIdle</A></b> ()
</LI>
<LI>void <b><A HREF="#ref5">insert</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &key, <A HREF="../kdecore/KShared.html">KShared</A> *obj)
</LI>
<LI><A HREF="../kdecore/KShared.html">KShared</A> * <b><A HREF="#ref6">find</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &key)
</LI>
<LI>void <b><A HREF="#ref7">remove</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &key)
</LI>
<LI>void <b><A HREF="#ref8">removeAll</A></b> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app)
</LI>
</ul><h4>Public Slots</h4><ul><LI>virtual void <b><A HREF="#ref9">idle</A></b> ()
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
The base class for KDED modules.
</p>
<p> In KDE 2.x, KDED modules are realized as shared
libraries that are loaded on-demand into kded at runtime.
</p>
<p> To write a config module, you have to create a library
that contains at least one factory function like this:
</p>
<p></p><table border="0" width="100%">
<tr>
<td bgcolor="#BEEAE0">
<pre>
extern "C" {
<A HREF="KDEDModule.html#KDEDModule">KDEDModule</A> *create_xyz(<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> *name)
{
return new XYZ(name);
}
}
</pre>
</td></tr>
</table> <p>
</p>
<p> See kkdelibs/kio/kded/HOWTO for more detailed documentation.
</p>
<p></p>
<A NAME="KDEDModule"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>KDEDModule</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &name)
<br></td><td align="right"><h3><strong>KDEDModule</strong></h3></td></tr></table><p></p><p>
Create a DCOPObject named <code>name</code>
</p>
<A NAME="~KDEDModule"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~KDEDModule</strong> ()
<br></td><td align="right"><h3><strong>~KDEDModule</strong></h3></td></tr></table><p> <small>[virtual]</small></p><A NAME="setIdleTimeout"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setIdleTimeout</strong> (int secs)
<br></td><td align="right"><h3><strong>setIdleTimeout</strong></h3></td></tr></table><p></p><p>
Specifies the idle timeout in seconds. The default is 0.
</p>
<p> This will call the idle slot <code>secs</code> seconds after the last
reference was removed.
</p>
<A NAME="resetIdle"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>resetIdle</strong> ()
<br></td><td align="right"><h3><strong>resetIdle</strong></h3></td></tr></table><p></p><p>
Reset the idle timeout counter.
</p>
<p> (re)starts the timeout counter if no objects are being referenced.
</p>
<A NAME="insert"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>insert</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &key, <A HREF="../kdecore/KShared.html">KShared</A> *obj)
<br></td><td align="right"><h3><strong>insert</strong></h3></td></tr></table><p></p><p>
Insert <code>obj</code> indexed with <code>app</code> and <code>key</code>. The
object will be automatically deleted when the application
<code>app</code> unregisters with DCOP.
</p>
<p> Any previous object inserted with the same values for <code>app</code>
and <code>key</code> will be removed.
</p>
<A NAME="find"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../kdecore/KShared.html">KShared</A> * <strong>find</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &key)
<br></td><td align="right"><h3><strong>find</strong></h3></td></tr></table><p></p><p>
Lookup object indexed with <code>app</code> and <code>key</code>
</p>
<p>Reimplemented from <A HREF="../dcop/DCOPObject.html#find">DCOPObject</A>.</p>
<A NAME="remove"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>remove</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app, const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &key)
<br></td><td align="right"><h3><strong>remove</strong></h3></td></tr></table><p></p><p>
remove object indexed with <code>app</code> and <code>key</code>.
The object will be deleted when it is no more referenced.
</p>
<A NAME="removeAll"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>removeAll</strong> (const <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A> &app)
<br></td><td align="right"><h3><strong>removeAll</strong></h3></td></tr></table><p></p><p>
remove all objects indexed with <code>app</code>.
The objects will be deleted when they are no more referenced.
</p>
<A NAME="idle"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>idle</strong> ()
<br></td><td align="right"><h3><strong>idle</strong></h3></td></tr></table><p> <small>[virtual slot]</small></p><p>
Called whenever the last referenced object gets dereferenced.
</p>
<p> See also <A HREF="KDEDModule.html#setIdleTimeout">setIdleTimeout</A>()
</p>
<p> You may delete the module from this slot.
</p>
<HR><UL><LI><i>Author</i>: Waldo Bastian <bastian@kde.org>
</LI><LI><i>Generated</i>: qateam on updates.mandrakesoft.com on Fri Jan 3 12:35:23 2003, using kdoc 2.0a53.</LI></UL></BODY></HTML>
