<?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>libkdepim: KPIM::PluginLoader< T, T_config > Class Template Reference (libkdepim)</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" /> <style type="text/css"> <!-- hr { display: none; } #content h2 { margin-left: 0px; } table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; } td.mdRow { padding: 8px 20px; } td.md { font-weight: bold; } td.mdname1 { font-weight: bold; color: #602020; } td.mdname { font-weight: bold; color: #602020; } --> </style> </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> <img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" /> <div id="nav_header_title" align="left">KDE PIM 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_left" style="text-align: left;"> / <a href="../../">API Reference</a> / <a href=".">libkdepim</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;"> <h2><a name="content"></a>libkdepim</h2> <!-- Generated by Doxygen 1.5.5 --> <div class="navpath"><a class="el" href="namespaceKPIM.html">KPIM</a>::<a class="el" href="classKPIM_1_1PluginLoader.html">PluginLoader</a> </div> <div class="contents"> <h1>KPIM::PluginLoader< T, T_config > Class Template Reference</h1><!-- doxytag: class="KPIM::PluginLoader" --><!-- doxytag: inherits="KPIM::PluginLoaderBase" --><code>#include <<a class="el" href="pluginloader_8h-source.html">pluginloader.h</a>></code> <p> Inherits KPIM::PluginLoaderBase. <p> <p> <a href="classKPIM_1_1PluginLoader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename T, typename T_config><br> class KPIM::PluginLoader< T, T_config ></h3> A generic plugin loader for when KPart::Plugin is overkill. <p> <dl class="author" compact><dt><b>Author:</b></dt><dd>Marc Mutz <<a href="mailto:mutz@kde.org">mutz@kde.org</a>> based on KABC's FormatFactory</dd></dl> This is a generic plugin loader / factory for small plugins that don't want to be QObjects.<h2><a class="anchor" name="Usage"> Usage</a></h2> A <a class="el" href="classKPIM_1_1PluginLoader.html" title="A generic plugin loader for when KPart::Plugin is overkill.">PluginLoader</a> takes two template arguments, <code>T</code> and <code>T_config</code>:<p> <dl> <dt>T</dt> <dd>The type of object to return </dd> <dt>T_config::mainfunc</dt> <dd>The suffix of the factory function to call in the library to obtain a new object of type <code>T</code>. The string passed to <code>KLibrary::symbol()</code> is <code>libName_mainfunc</code>. </dd> <dt>T_config::path</dt> <dd>The search pattern for <code>.desktop</code> files containing the plugin descriptions. This is the string passed as the <code>filter</code> argument to <code>KStandardDirs::findAllResources</code>. </dd> </dl> <p> The last two parameters being strings, they are passed via an encapsulating class, of which <code>mainfunc</code> and <code>path</code> are public static members:<p> <pre> struct MyObjectPluginLoaderConfig { static const char * const mainfunc; static const char * const path; }; const char * const MyObjectPluginLoaderConfig::mainfunc = "myapp_create_myobject"; const char * const MyObjectPluginLoaderConfig::path = "myapp/plugins/ *.desktop"; </pre><p> You would then use a <code>typedef</code> to create a less unwieldy name for your plugin loader:<p> <pre> typedef KPIM::PluginLoader< MyObject, MyObjectPluginLoaderConfig > MyObjectPluginLoader; </pre><p> All of this is what the <code>KPIM_DEFINE_PLUGIN_LOADER(pluginloadername,type,mainfunc,path)</code> macro achieves. <p>Definition at line <a class="el" href="pluginloader_8h-source.html#l00079">79</a> of file <a class="el" href="pluginloader_8h-source.html">pluginloader.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1PluginLoader.html#c50d58af44ebb88b9897ddb310e53f49">scan</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1PluginLoader.html#01761d346395dca92ba4a2e550532d13">createForName</a> (const QString &type) const </td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classKPIM_1_1PluginLoader.html">PluginLoader</a>< T, <br> T_config > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPIM_1_1PluginLoader.html#103e3f0789842903313ad47052ecf6ca">instance</a> ()</td></tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="103e3f0789842903313ad47052ecf6ca"></a><!-- doxytag: member="KPIM::PluginLoader::instance" ref="103e3f0789842903313ad47052ecf6ca" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T, typename T_config> </div> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classKPIM_1_1PluginLoader.html">PluginLoader</a><T,T_config>* <a class="el" href="classKPIM_1_1PluginLoader.html">KPIM::PluginLoader</a>< T, T_config >::instance </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the single instance of this loader. <p> <p>Definition at line <a class="el" href="pluginloader_8h-source.html#l00090">90</a> of file <a class="el" href="pluginloader_8h-source.html">pluginloader.h</a>.</p> </div> </div><p> <a class="anchor" name="c50d58af44ebb88b9897ddb310e53f49"></a><!-- doxytag: member="KPIM::PluginLoader::scan" ref="c50d58af44ebb88b9897ddb310e53f49" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T, typename T_config> </div> <table class="memname"> <tr> <td class="memname">virtual void <a class="el" href="classKPIM_1_1PluginLoader.html">KPIM::PluginLoader</a>< T, T_config >::scan </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Rescans the plugin directory to find any newly installed plugins. <p> <p>Definition at line <a class="el" href="pluginloader_8h-source.html#l00101">101</a> of file <a class="el" href="pluginloader_8h-source.html">pluginloader.h</a>.</p> </div> </div><p> <a class="anchor" name="01761d346395dca92ba4a2e550532d13"></a><!-- doxytag: member="KPIM::PluginLoader::createForName" ref="01761d346395dca92ba4a2e550532d13" args="(const QString &type) const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T, typename T_config> </div> <table class="memname"> <tr> <td class="memname">virtual T* <a class="el" href="classKPIM_1_1PluginLoader.html">KPIM::PluginLoader</a>< T, T_config >::createForName </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>type</em> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns a pointer to a plugin object (of type <code>T</code>) or a null pointer if the type wasn't found. <p> You can extend this method for when you want to handle builtin types <p>Definition at line <a class="el" href="pluginloader_8h-source.html#l00108">108</a> of file <a class="el" href="pluginloader_8h-source.html">pluginloader.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="pluginloader_8h-source.html">pluginloader.h</a></ul> </div> </div></div> </td> </tr> <tr> <td valign="top" id="leftmenu" width="25%"> <a name="navigation"></a> <div class="menu_box"><h2>libkdepim</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</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="namespacemembers.html">Namespace Members</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="classActionBase.html">actionbase</option>, <option value="classActionEditWidget.html">actioneditwidget</option>, <option value="classAlarmClient.html">alarmclient</option>, <option value="classConditionEditWidget.html">conditioneditwidget</option>, <option value="classGroupItem.html">groupitem</option>, <option value="classKABC_1_1ResourceNull.html">kabc::resourcenull</option>, <option value="classKConfigWizard.html">kconfigwizard</option>, <option value="classKDateEdit.html">kdateedit</option>, <option value="classKDatePickerPopup.html">kdatepickerpopup</option>, <option value="classKIncidenceChooser.html">kincidencechooser</option>, <option value="classKomposer_1_1Core.html">komposer::core</option>, <option value="classKomposer_1_1KomposerIface.html">komposer::komposeriface</option>, <option value="classKParts_1_1InfoExtension.html">kparts::infoextension</option>, <option value="classKParts_1_1SideBarExtension.html">kparts::sidebarextension</option>, <option value="classKPartsGenericPart.html">kpartsgenericpart</option>, <option value="classKPartsWidgetPlugin.html">kpartswidgetplugin</option>, <option value="classKPIM_1_1BroadcastStatus.html">kpim::broadcaststatus</option>, <option value="classKPIM_1_1ClickLineEdit.html">kpim::clicklineedit</option>, <option value="classKPIM_1_1CollectingProcess.html">kpim::collectingprocess</option>, <option value="classKPIM_1_1ConfigManager.html">kpim::configmanager</option>, <option value="classKPIM_1_1DiffAlgoDisplay.html">kpim::diffalgodisplay</option>, <option value="classKPIM_1_1DistributionList.html">kpim::distributionlist</option>, <option value="classKPIM_1_1KMailCompletion.html">kpim::kmailcompletion</option>, <option value="classKPIM_1_1KPixmapRegionSelectorDialog.html">kpim::kpixmapregionselectordialog</option>, <option value="classKPIM_1_1KPixmapRegionSelectorWidget.html">kpim::kpixmapregionselectorwidget</option>, <option value="classKPIM_1_1LdapClient.html">kpim::ldapclient</option>, <option value="classKPIM_1_1LdapObject.html">kpim::ldapobject</option>, <option value="classKPIM_1_1LdapSearch.html">kpim::ldapsearch</option>, <option value="classKPIM_1_1OverlayWidget.html">kpim::overlaywidget</option>, <option value="classKPIM_1_1PluginLoader.html">kpim::pluginloader</option>, <option value="classKPIM_1_1ProgressManager.html">kpim::progressmanager</option>, <option value="classKPIM_1_1ResourceABC.html">kpim::resourceabc</option>, <option value="classKPIM_1_1SelectionItem.html">kpim::selectionitem</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Event.html">kpim::threadweaver::event</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Job.html">kpim::threadweaver::job</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Thread.html">kpim::threadweaver::thread</option>, <option value="classKPIM_1_1ThreadWeaver_1_1Weaver.html">kpim::threadweaver::weaver</option>, <option value="classKPIM_1_1ThreadWeaver_1_1WeaverExtension.html">kpim::threadweaver::weaverextension</option>, <option value="classKPIM_1_1ThreadWeaver_1_1WeaverThreadLogger.html">kpim::threadweaver::weaverthreadlogger</option>, <option value="classKPrefsDialog.html">kprefsdialog</option>, <option value="classKPrefsWid.html">kprefswid</option>, <option value="classKPrefsWidBool.html">kprefswidbool</option>, <option value="classKPrefsWidColor.html">kprefswidcolor</option>, <option value="classKPrefsWidCombo.html">kprefswidcombo</option>, <option value="classKPrefsWidDate.html">kprefswiddate</option>, <option value="classKPrefsWidDuration.html">kprefswidduration</option>, <option value="classKPrefsWidFont.html">kprefswidfont</option>, <option value="classKPrefsWidInt.html">kprefswidint</option>, <option value="classKPrefsWidManager.html">kprefswidmanager</option>, <option value="classKPrefsWidPath.html">kprefswidpath</option>, <option value="classKPrefsWidRadios.html">kprefswidradios</option>, <option value="classKPrefsWidString.html">kprefswidstring</option>, <option value="classKPrefsWidTime.html">kprefswidtime</option>, <option value="classKRecentAddress_1_1RecentAddresses.html">krecentaddress::recentaddresses</option>, <option value="classKRegExp3.html">kregexp3</option>, <option value="classKResourcePrefs.html">kresourceprefs</option>, <option value="classKRSqueezedTextLabel.html">krsqueezedtextlabel</option>, <option value="classKSubscription.html">ksubscription</option>, <option value="classKTimeEdit.html">ktimeedit</option>, <option value="classKVCardDrag.html">kvcarddrag</option>, <option value="classKWidgetLister.html">kwidgetlister</option>, <option value="classLinkLocator.html">linklocator</option>, <option value="classQStrictUtf7Codec.html">qstrictutf7codec</option>, <option value="classQUtf7Codec.html">qutf7codec</option>, <option value="classRuleEditWidget.html">ruleeditwidget</option>, <option value="classRuleListWidget.html">rulelistwidget</option>, <option value="classRuleStack.html">rulestack</option>, <option value="classScorableGroup.html">scorablegroup</option>, <option value="classSingleActionWidget.html">singleactionwidget</option>, <option value="classSingleConditionWidget.html">singleconditionwidget</option>, </select> </form> </div> --> </div></div> <div class="menu_box"><h2>API Dox</h2> <div class="nav_list"> <ul> <li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</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>