<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US"> <head> <title>kresources: KRES::Factory Class Reference (kresources)</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' /> <meta name="trademark" content="KDE e.V." /> <meta name="description" content="K Desktop Environment Homepage, KDE.org" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="robots" content="all" /> <link rel="shortcut icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" /> </head> <body> <div id="nav_header_top" align="right"> <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a> <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a> <span class="doNotDisplay">::</span> <div id="nav_header_title" align="left">KDE API Reference</div> </div> <div id="nav_header_bottom" align="right"> <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span> <div id="nav_header_bottom_right" style="text-align: left;"> / <a href="../..">API Reference</a> / <a href=".">kresources</a> </div> </div> <table id="main" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td valign="top" class="menuheader" height="0"></td> <td id="contentcolumn" valign="top" rowspan="2" > <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;"> <a name="content"></a> <!-- Generated by Doxygen 1.7.4 --> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>KRES</b> </li> <li class="navelem"><a class="el" href="classKRES_1_1Factory.html">Factory</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <div class="title">KRES::Factory Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="KRES::Factory" --> <p>Class for loading resource plugins. <a href="classKRES_1_1Factory.html#details">More...</a></p> <p><code>#include <<a class="el" href="factory_8h_source.html">factory.h</a>></code></p> <p><a href="classKRES_1_1Factory-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">ConfigWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#ac72a43ea9cf478ff70c59878c1ec0a94">configWidget</a> (const <a class="elRef" href="qstring.html">QString</a> &type, <a class="elRef" href="qwidget.html">QWidget</a> *parent=0)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKRES_1_1Resource.html">Resource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#ab0b615cf4f673a084971509a44665b2d">resource</a> (const <a class="elRef" href="qstring.html">QString</a> &type, const KConfig *config)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a5f36fe845e9d2488b6eecbb036556aeb">typeNames</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a579f79348f87d1ab402accbe46f8fcfa">typeName</a> (const <a class="elRef" href="qstring.html">QString</a> &type) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a1a95a23d0f3c9f35db449c2609e4052d">typeDescription</a> (const <a class="elRef" href="qstring.html">QString</a> &type) const </td></tr> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKRES_1_1Factory.html">Factory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#afe1731301bb8ff202bd03828a1b49297">self</a> (const <a class="elRef" href="qstring.html">QString</a> &resourceFamily)</td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab705a1a4252339c3d3d9517b4f336f65"></a><!-- doxytag: member="KRES::Factory::Factory" ref="ab705a1a4252339c3d3d9517b4f336f65" args="(const QString &resourceFamily)" -->  </td><td class="memItemRight" valign="bottom"><b>Factory</b> (const <a class="elRef" href="qstring.html">QString</a> &resourceFamily)</td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Class for loading resource plugins. </p> <p>Use this class if you need resources with special settings, otherwise use <a class="el" href="classKRES_1_1Manager.html#a1d5cb3fdc5f6e14b67d1e8ab1384ebb1" title="Creates a new resource of type type with default settings.">KRES::Manager::createResource()</a> to get resources with the default settings.</p> <p>Example:</p> <div class="fragment"><pre class="fragment"> KABC::Factory *factory = <a class="code" href="classKRES_1_1Factory.html#afe1731301bb8ff202bd03828a1b49297" title="Returns the global resource factory.">KABC::Factory::self</a>( <span class="stringliteral">"contact"</span> ); <span class="comment">// to allow a transparent configuration of resources, we have</span> <span class="comment">// to use a kconfig object.</span> KConfig config( <span class="stringliteral">"tst"</span> ); config.writePathEntry( <span class="stringliteral">"FileName"</span>, <span class="stringliteral">"/home/foobar/test.vcf"</span> );<span class="comment">// resource dependend</span> config.writeEntry( <span class="stringliteral">"FileFormat"</span>, <span class="stringliteral">"vcard"</span> ); <span class="comment">// resource dependend</span> KABC::Resource *res = factory->resource( <span class="stringliteral">"file"</span>, &config ); <span class="comment">// do something with resource</span> </pre></div> <p>Definition at line <a class="el" href="factory_8h_source.html#l00062">62</a> of file <a class="el" href="factory_8h_source.html">factory.h</a>.</p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ac72a43ea9cf478ff70c59878c1ec0a94"></a><!-- doxytag: member="KRES::Factory::configWidget" ref="ac72a43ea9cf478ff70c59878c1ec0a94" args="(const QString &type, QWidget *parent=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ConfigWidget * Factory::configWidget </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td> <td class="paramname"><em>parent</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the config widget for the given resource type, or a null pointer if resource type doesn't exist. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">type</td><td>The type of the resource, returned by <a class="el" href="classKRES_1_1Factory.html#a5f36fe845e9d2488b6eecbb036556aeb" title="Returns a list of all available resource types.">typeNames()</a> </td></tr> <tr><td class="paramname">parent</td><td>The parent widget </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00080">80</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="ab0b615cf4f673a084971509a44665b2d"></a><!-- doxytag: member="KRES::Factory::resource" ref="ab0b615cf4f673a084971509a44665b2d" args="(const QString &type, const KConfig *config)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKRES_1_1Resource.html">Resource</a> * Factory::resource </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const KConfig * </td> <td class="paramname"><em>config</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a pointer to a resource object or a null pointer if resource type doesn't exist. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">type</td><td>The type of the resource, returned by <a class="el" href="classKRES_1_1Factory.html#a5f36fe845e9d2488b6eecbb036556aeb" title="Returns a list of all available resource types.">typeNames()</a> </td></tr> <tr><td class="paramname">config</td><td>The config object where the resource get it settings from, or 0 if a resource with default values should be created. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00128">128</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="afe1731301bb8ff202bd03828a1b49297"></a><!-- doxytag: member="KRES::Factory::self" ref="afe1731301bb8ff202bd03828a1b49297" args="(const QString &resourceFamily)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKRES_1_1Factory.html">Factory</a> * Factory::self </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>resourceFamily</em></td><td>)</td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns the global resource factory. </p> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00040">40</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a1a95a23d0f3c9f35db449c2609e4052d"></a><!-- doxytag: member="KRES::Factory::typeDescription" ref="a1a95a23d0f3c9f35db449c2609e4052d" args="(const QString &type) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="qstring.html">QString</a> Factory::typeDescription </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>type</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the description for a special type. </p> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00119">119</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a579f79348f87d1ab402accbe46f8fcfa"></a><!-- doxytag: member="KRES::Factory::typeName" ref="a579f79348f87d1ab402accbe46f8fcfa" args="(const QString &type) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="qstring.html">QString</a> Factory::typeName </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>type</em></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns the name for a special type. </p> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00110">110</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a5f36fe845e9d2488b6eecbb036556aeb"></a><!-- doxytag: member="KRES::Factory::typeNames" ref="a5f36fe845e9d2488b6eecbb036556aeb" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="qstringlist.html">QStringList</a> Factory::typeNames </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Returns a list of all available resource types. </p> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00075">75</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="factory_8h_source.html">factory.h</a></li> <li><a class="el" href="factory_8cpp_source.html">factory.cpp</a></li> </ul> </div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>kresources</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul> <!-- <h2>Class Picker</h2> <div style="text-align: center;"> <form name="guideform"> <select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value"> <option value="annotated.html">-- Choose --</option> <option value="classKRES_1_1Factory.html">kres::factory</option>, <option value="classKRES_1_1Manager.html">kres::manager</option>, <option value="classKRES_1_1Manager_1_1ActiveIterator.html">kres::manager::activeiterator</option>, <option value="classKRES_1_1Manager_1_1Iterator.html">kres::manager::iterator</option>, <option value="classKRES_1_1ManagerObserver.html">kres::managerobserver</option>, <option value="classKRES_1_1Resource.html">kres::resource</option>, <option value="classKRES_1_1SelectDialog.html">kres::selectdialog</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li> </ul></div></div> </td> </tr> </table> <span class="doNotDisplay"> <a href="http://www.kde.org/" accesskey="8">KDE Home</a> | <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> | <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a> </span> <div style="height: 8px"></div> <div id="footer"> <div id="footer_left"> Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a> and <a href="mailto:winter@kde.org">Allen Winter</a>. <br/> KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div> <div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a> WARNING END --> </body> </html>