<?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" xml:lang="en"> <head> <title>KRES::Factory Class Reference</title> <style type="text/css"> .cp-doNotDisplay { display: none; } @media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }} .cp-edit { text-align: right; } @media print, embossed { .cp-edit { display: none; }} </style> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" /> <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" /> <meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" /> <link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" /> <link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" /> <link rel="stylesheet" type="text/css" href="../../doxygen.css" /> <link rel="stylesheet" type="text/css" href="../../tabs.css" /> </head> <body> <ul class="cp-doNotDisplay"> <li><a href="#cp-content" accesskey="2">Skip to content</a></li> <li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li> </ul> <div id="container"> <div id="header"> <div id="header_top"><div><div> <img alt ="" src="../../top-kde.jpg"/> </div></div></div> <div id="header_bottom"> <div id="location"> <ul> <li><a href="http://api.kde.org">KDE API Reference</a></li> <li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li> </ul> </div> <div id="menu"> <ul> <li><a href="http://www.kde.org/">KDE Home</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <!-- End page header --> <div id="body_wrapper"> <div id="body"> <!-- begin main content --> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h2><a name="content"></a>kresources</h2> <!-- BC --> <div id="top"> <!-- Generated by Doxygen 1.8.3.1 --> <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><!-- top --> <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> | <a href="classKRES_1_1Factory-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">KRES::Factory Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="factory_8h_source.html">factory.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ac72a43ea9cf478ff70c59878c1ec0a94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKRES_1_1ConfigWidget.html">ConfigWidget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#ac72a43ea9cf478ff70c59878c1ec0a94">configWidget</a> (const QString &type, QWidget *parent=0)</td></tr> <tr class="separator:ac72a43ea9cf478ff70c59878c1ec0a94"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a07f981f6017dde99dddb5c2427df120f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a07f981f6017dde99dddb5c2427df120f">reloadConfig</a> ()</td></tr> <tr class="separator:a07f981f6017dde99dddb5c2427df120f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:add81bef6cb27a4c331bfe0e51ff79b0d"><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#add81bef6cb27a4c331bfe0e51ff79b0d">resource</a> (const QString &type, const KConfigGroup &group)</td></tr> <tr class="separator:add81bef6cb27a4c331bfe0e51ff79b0d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8fc2c37fc3bc2c3a4938e11f569a3ea6"><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#a8fc2c37fc3bc2c3a4938e11f569a3ea6">resource</a> (const QString &type)</td></tr> <tr class="separator:a8fc2c37fc3bc2c3a4938e11f569a3ea6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1a95a23d0f3c9f35db449c2609e4052d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a1a95a23d0f3c9f35db449c2609e4052d">typeDescription</a> (const QString &type) const </td></tr> <tr class="separator:a1a95a23d0f3c9f35db449c2609e4052d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a579f79348f87d1ab402accbe46f8fcfa"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a579f79348f87d1ab402accbe46f8fcfa">typeName</a> (const QString &type) const </td></tr> <tr class="separator:a579f79348f87d1ab402accbe46f8fcfa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5f36fe845e9d2488b6eecbb036556aeb"><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1Factory.html#a5f36fe845e9d2488b6eecbb036556aeb">typeNames</a> () const </td></tr> <tr class="separator:a5f36fe845e9d2488b6eecbb036556aeb"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:afe1731301bb8ff202bd03828a1b49297"><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 QString &resourceFamily)</td></tr> <tr class="separator:afe1731301bb8ff202bd03828a1b49297"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:ab705a1a4252339c3d3d9517b4f336f65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab705a1a4252339c3d3d9517b4f336f65"></a>  </td><td class="memItemRight" valign="bottom"><b>Factory</b> (const QString &resourceFamily)</td></tr> <tr class="separator:ab705a1a4252339c3d3d9517b4f336f65"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A 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"><div class="line"><a class="code" href="classKRES_1_1Factory.html" title="A class for loading resource plugins.">KRES::Factory</a> *factory = <a class="code" href="classKRES_1_1Factory.html#afe1731301bb8ff202bd03828a1b49297" title="Returns the global resource factory.">KRES::Factory::self</a>( <span class="stringliteral">"contact"</span> );</div> <div class="line"></div> <div class="line"><span class="comment">// to allow a transparent configuration of resources, we have</span></div> <div class="line"><span class="comment">// to use a kconfig object.</span></div> <div class="line">KConfig config;</div> <div class="line">KConfigGroup group( &config, <span class="stringliteral">"General"</span> );</div> <div class="line">group.writePathEntry( <span class="stringliteral">"FileName"</span>, <span class="stringliteral">"/home/foobar/test.vcf"</span> );<span class="comment">// resource dependent</span></div> <div class="line">group.writeEntry( <span class="stringliteral">"FileFormat"</span>, <span class="stringliteral">"vcard"</span> ); <span class="comment">// resource dependent</span></div> <div class="line"></div> <div class="line"><a class="code" href="classKRES_1_1Resource.html" title="This class provides a resource which is managed in a general way.">KRES::Resource</a> *res = factory-><a class="code" href="classKRES_1_1Factory.html#add81bef6cb27a4c331bfe0e51ff79b0d" title="Returns a pointer to a resource object or a null pointer if resource type doesn't exist...">resource</a>( <span class="stringliteral">"file"</span>, group );</div> <div class="line"></div> <div class="line"><span class="comment">// do something with resource</span></div> </div><!-- fragment --> <p>Definition at line <a class="el" href="factory_8h_source.html#l00073">73</a> of file <a class="el" href="factory_8h_source.html">factory.h</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ac72a43ea9cf478ff70c59878c1ec0a94"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKRES_1_1ConfigWidget.html">ConfigWidget</a> * Factory::configWidget </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">QWidget * </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 class="params"><dt>Parameters</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#l00153">153</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a07f981f6017dde99dddb5c2427df120f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Factory::reloadConfig </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Reload the configuration. </p> <p>This reloads the plugin type map. Useful to call after resources have been added or removed. </p> <dl class="section since"><dt>Since</dt><dd>4.2 </dd></dl> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00126">126</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="add81bef6cb27a4c331bfe0e51ff79b0d"></a> <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 QString & </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const KConfigGroup & </td> <td class="paramname"><em>group</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 class="params"><dt>Parameters</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 configuration group where the resource should get its settings from. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00245">245</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a8fc2c37fc3bc2c3a4938e11f569a3ea6"></a> <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 QString & </td> <td class="paramname"><em>type</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Creates and returns a resource object with default values, or a null pointer if resource type doesn't exist. </p> <dl class="params"><dt>Parameters</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> </table> </dd> </dl> <p>Definition at line <a class="el" href="factory_8cpp_source.html#l00250">250</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="afe1731301bb8ff202bd03828a1b49297"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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 QString & </td> <td class="paramname"><em>resourceFamily</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span></span> </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#l00068">68</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a1a95a23d0f3c9f35db449c2609e4052d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Factory::typeDescription </td> <td>(</td> <td class="paramtype">const QString & </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#l00193">193</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a579f79348f87d1ab402accbe46f8fcfa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Factory::typeName </td> <td>(</td> <td class="paramtype">const QString & </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#l00183">183</a> of file <a class="el" href="factory_8cpp_source.html">factory.cpp</a>.</p> </div> </div> <a class="anchor" id="a5f36fe845e9d2488b6eecbb036556aeb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QStringList 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#l00148">148</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><!-- contents --> <div class="copyrights"> This file is part of the KDE documentation.<br/> Documentation copyright © 1996-2013 The KDE developers.<br/> Generated on Fri Jul 12 2013 16:48:47 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006 <p> KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online. </p> </div> </div> </div> </div> <div id="left"> <div class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">kresources</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kresources"</a> </div></div> <ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</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_1ConfigDialog.html">kres::configdialog</option>, <option value="classKRES_1_1ConfigPage.html">kres::configpage</option>, <option value="classKRES_1_1ConfigWidget.html">kres::configwidget</option>, <option value="classKRES_1_1Factory.html">kres::factory</option>, <option value="classKRES_1_1IdMapper.html">kres::idmapper</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_1ManagerImpl.html">kres::managerimpl</option>, <option value="classKRES_1_1ManagerNotifier.html">kres::managernotifier</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 class="menu_box"> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a> </div></div> <div class="nav_list"> <ul> <li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li> </ul></div></div> <!-- api_searchbox --> </div> </div> <div class="clearer"></div> </div> <div class="clearer"></div> </div> <div id="end_body"></div> <div id="footer"><div id="footer_text"> Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br> Contact the specific authors with questions and comments about the page contents.<p> KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a></p> </div></div> </div> <!-- WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL BE BLOCKED INSTANTLY AND PERMANENTLY! <a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a> WARNING END --> </body> </html>