<?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>KontactInterface::Plugin 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>Kontact Plugin Interface Library</h2> <!-- BC --> <div id="top"> <!-- Generated by Doxygen 1.8.3.1 --> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>KontactInterface</b></li><li class="navelem"><a class="el" href="classKontactInterface_1_1Plugin.html">Plugin</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-slots">Public Slots</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="classKontactInterface_1_1Plugin-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">KontactInterface::Plugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="plugin_8h_source.html">plugin.h</a>></code></p> <p>Inherits QObject, and KXMLGUIClient.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a> Public Slots</h2></td></tr> <tr class="memitem:a3147f4f5a38baeebd7c258d052127693"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a3147f4f5a38baeebd7c258d052127693">slotConfigUpdated</a> ()</td></tr> <tr class="separator:a3147f4f5a38baeebd7c258d052127693"><td class="memSeparator" colspan="2"> </td></tr> </table><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:ac3da34a3ceaf73bae92534871d41a1bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#ac3da34a3ceaf73bae92534871d41a1bb">Plugin</a> (<a class="el" href="classKontactInterface_1_1Core.html">Core</a> *<a class="el" href="classKontactInterface_1_1Plugin.html#aa672c16fdc0b7724365969c949508ccb">core</a>, QObject *parent, const char *appName, const char *pluginName=0)</td></tr> <tr class="separator:ac3da34a3ceaf73bae92534871d41a1bb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aee4cc1864a2afa84a9ad935153f3fe39"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#aee4cc1864a2afa84a9ad935153f3fe39">~Plugin</a> ()</td></tr> <tr class="separator:aee4cc1864a2afa84a9ad935153f3fe39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e6fd08f6213b8b565fecaa532a4f7dc"><td class="memItemLeft" align="right" valign="top">virtual const KAboutData * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a9e6fd08f6213b8b565fecaa532a4f7dc">aboutData</a> () const </td></tr> <tr class="separator:a9e6fd08f6213b8b565fecaa532a4f7dc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaba4d2364e865025cb5bab93874682bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#aaba4d2364e865025cb5bab93874682bb">aboutToSelect</a> ()</td></tr> <tr class="separator:aaba4d2364e865025cb5bab93874682bb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a50cf81b553bf5b1a13c4d09437f16ef4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a50cf81b553bf5b1a13c4d09437f16ef4">bringToForeground</a> ()</td></tr> <tr class="separator:a50cf81b553bf5b1a13c4d09437f16ef4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a84be8b21c2c567ef43dde1e1e4d32bb4"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a84be8b21c2c567ef43dde1e1e4d32bb4">canDecodeMimeData</a> (const QMimeData *data) const </td></tr> <tr class="separator:a84be8b21c2c567ef43dde1e1e4d32bb4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acad83371e8a9a6e9ad52ada75ae4efa6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#acad83371e8a9a6e9ad52ada75ae4efa6">configUpdated</a> ()</td></tr> <tr class="separator:acad83371e8a9a6e9ad52ada75ae4efa6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa672c16fdc0b7724365969c949508ccb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKontactInterface_1_1Core.html">Core</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#aa672c16fdc0b7724365969c949508ccb">core</a> () const </td></tr> <tr class="separator:aa672c16fdc0b7724365969c949508ccb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aecd6d81505af55cd6af5a1808239c43f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#aecd6d81505af55cd6af5a1808239c43f">createDBUSInterface</a> (const QString &serviceType)</td></tr> <tr class="separator:aecd6d81505af55cd6af5a1808239c43f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f76aae6c91131b475ee29dd05d0e6b8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classKontactInterface_1_1Summary.html">Summary</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a6f76aae6c91131b475ee29dd05d0e6b8">createSummaryWidget</a> (QWidget *parent)</td></tr> <tr class="separator:a6f76aae6c91131b475ee29dd05d0e6b8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa3b4de528629aea0c4f8e2c3dba1c00f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#aa3b4de528629aea0c4f8e2c3dba1c00f">disabled</a> () const </td></tr> <tr class="separator:aa3b4de528629aea0c4f8e2c3dba1c00f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abf25353652645f01419f95782ef8d4da"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#abf25353652645f01419f95782ef8d4da">executableName</a> () const </td></tr> <tr class="separator:abf25353652645f01419f95782ef8d4da"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a629ffa812c981fd02c8936c8fd04ddc8"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a629ffa812c981fd02c8936c8fd04ddc8">icon</a> () const </td></tr> <tr class="separator:a629ffa812c981fd02c8936c8fd04ddc8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8035513498229a238d7de32ded6bfee1"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a8035513498229a238d7de32ded6bfee1">identifier</a> () const </td></tr> <tr class="separator:a8035513498229a238d7de32ded6bfee1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2659fa917e927db3a6c09ba0b9448dbc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a2659fa917e927db3a6c09ba0b9448dbc">insertNewAction</a> (KAction *action)</td></tr> <tr class="separator:a2659fa917e927db3a6c09ba0b9448dbc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada0d2cea25a4fb34002f992b6e6c239a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#ada0d2cea25a4fb34002f992b6e6c239a">insertSyncAction</a> (KAction *action)</td></tr> <tr class="separator:ada0d2cea25a4fb34002f992b6e6c239a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a076d857410108267514111f4913edf0a"><td class="memItemLeft" align="right" valign="top">virtual QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a076d857410108267514111f4913edf0a">invisibleToolbarActions</a> () const </td></tr> <tr class="separator:a076d857410108267514111f4913edf0a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2933cf6ab06b645e52b5e27c1e6aaa4a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a2933cf6ab06b645e52b5e27c1e6aaa4a">isRunningStandalone</a> () const </td></tr> <tr class="separator:a2933cf6ab06b645e52b5e27c1e6aaa4a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a723d829594e5b340653e8e3fa58c1430"><td class="memItemLeft" align="right" valign="top">QList< KAction * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a723d829594e5b340653e8e3fa58c1430">newActions</a> () const </td></tr> <tr class="separator:a723d829594e5b340653e8e3fa58c1430"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0b9279ab6238e273de7e06ba91f8cb84"><td class="memItemLeft" align="right" valign="top">KParts::ReadOnlyPart * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a0b9279ab6238e273de7e06ba91f8cb84">part</a> ()</td></tr> <tr class="separator:a0b9279ab6238e273de7e06ba91f8cb84"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2da8b45f09095d0999cf3746f7abc871"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a2da8b45f09095d0999cf3746f7abc871">processDropEvent</a> (QDropEvent *)</td></tr> <tr class="separator:a2da8b45f09095d0999cf3746f7abc871"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a394495bb03f068b46c5e71fd0a8ae0ba"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a394495bb03f068b46c5e71fd0a8ae0ba">queryClose</a> () const </td></tr> <tr class="separator:a394495bb03f068b46c5e71fd0a8ae0ba"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a471a4aa9c55c4a120b9cdd89d283df3d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a471a4aa9c55c4a120b9cdd89d283df3d">readProperties</a> (const KConfigGroup &)</td></tr> <tr class="separator:a471a4aa9c55c4a120b9cdd89d283df3d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a0a5e4242ce73edee0370e66895644b"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a2a0a5e4242ce73edee0370e66895644b">registerClient</a> ()</td></tr> <tr class="separator:a2a0a5e4242ce73edee0370e66895644b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a91d54bf20944a3eb2fae13196c08b0ed"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a91d54bf20944a3eb2fae13196c08b0ed">saveProperties</a> (KConfigGroup &)</td></tr> <tr class="separator:a91d54bf20944a3eb2fae13196c08b0ed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9b1e9cc591c23c8c8bbb07a76ce5d43e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a9b1e9cc591c23c8c8bbb07a76ce5d43e">select</a> ()</td></tr> <tr class="separator:a9b1e9cc591c23c8c8bbb07a76ce5d43e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af4a8ef6e2e93526275518a12fa290833"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#af4a8ef6e2e93526275518a12fa290833">setDisabled</a> (bool value)</td></tr> <tr class="separator:af4a8ef6e2e93526275518a12fa290833"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a40c2f5b9529db32a7b0eae229d9d5bd0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a40c2f5b9529db32a7b0eae229d9d5bd0">setExecutableName</a> (const QString &name)</td></tr> <tr class="separator:a40c2f5b9529db32a7b0eae229d9d5bd0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a18ce7836474eb8088aad1bfa1462d86b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a18ce7836474eb8088aad1bfa1462d86b">setIcon</a> (const QString &<a class="el" href="classKontactInterface_1_1Plugin.html#a629ffa812c981fd02c8936c8fd04ddc8">icon</a>)</td></tr> <tr class="separator:a18ce7836474eb8088aad1bfa1462d86b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0a1804dfb71bdcf92dcc69765c1872aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a0a1804dfb71bdcf92dcc69765c1872aa">setIdentifier</a> (const QString &<a class="el" href="classKontactInterface_1_1Plugin.html#a8035513498229a238d7de32ded6bfee1">identifier</a>)</td></tr> <tr class="separator:a0a1804dfb71bdcf92dcc69765c1872aa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac54fed8a1486b1f8a92b5e6b218c3ccb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#ac54fed8a1486b1f8a92b5e6b218c3ccb">setPartLibraryName</a> (const QByteArray &name)</td></tr> <tr class="separator:ac54fed8a1486b1f8a92b5e6b218c3ccb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d4412c8f455e8d03d49a5321aebc6ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a1d4412c8f455e8d03d49a5321aebc6ed">setShowInSideBar</a> (bool hasPart)</td></tr> <tr class="separator:a1d4412c8f455e8d03d49a5321aebc6ed"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af9062497cf77b3984936d794c95d2ee5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#af9062497cf77b3984936d794c95d2ee5">setTitle</a> (const QString &<a class="el" href="classKontactInterface_1_1Plugin.html#abe2af021ae05cc8fd27ea30edfec3fdf">title</a>)</td></tr> <tr class="separator:af9062497cf77b3984936d794c95d2ee5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aec03fe1b0dc7913639c5b0b11ddef159"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#aec03fe1b0dc7913639c5b0b11ddef159">showInSideBar</a> () const </td></tr> <tr class="separator:aec03fe1b0dc7913639c5b0b11ddef159"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a26ed94ad66dc227aeb82add162f220cb"><td class="memItemLeft" align="right" valign="top">QList< KAction * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a26ed94ad66dc227aeb82add162f220cb">syncActions</a> () const </td></tr> <tr class="separator:a26ed94ad66dc227aeb82add162f220cb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a82bc225e9027fd6c90497ab1bc7441"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a2a82bc225e9027fd6c90497ab1bc7441">tipFile</a> () const </td></tr> <tr class="separator:a2a82bc225e9027fd6c90497ab1bc7441"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abe2af021ae05cc8fd27ea30edfec3fdf"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#abe2af021ae05cc8fd27ea30edfec3fdf">title</a> () const </td></tr> <tr class="separator:abe2af021ae05cc8fd27ea30edfec3fdf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6593d5ad133b82f193391b135bd4bb60"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a6593d5ad133b82f193391b135bd4bb60">weight</a> () const </td></tr> <tr class="separator:a6593d5ad133b82f193391b135bd4bb60"><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:ad72a4a1c1f1ef235bbf209b2bb05ce5a"><td class="memItemLeft" align="right" valign="top">virtual KParts::ReadOnlyPart * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#ad72a4a1c1f1ef235bbf209b2bb05ce5a">createPart</a> ()=0</td></tr> <tr class="separator:ad72a4a1c1f1ef235bbf209b2bb05ce5a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a82221a604d622266435499abbc65f4d4"><td class="memItemLeft" align="right" valign="top">KParts::ReadOnlyPart * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a82221a604d622266435499abbc65f4d4">loadPart</a> ()</td></tr> <tr class="separator:a82221a604d622266435499abbc65f4d4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5762664367c1dd67fd84863a25eb072c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKontactInterface_1_1Plugin.html#a5762664367c1dd67fd84863a25eb072c">virtual_hook</a> (int id, void *data)</td></tr> <tr class="separator:a5762664367c1dd67fd84863a25eb072c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Base class for all Plugins in Kontact. </p> <p>Inherit from it to get a plugin. It can insert an icon into the sidepane, add widgets to the widgetstack and add menu items via XMLGUI. </p> <p>Definition at line <a class="el" href="plugin_8h_source.html#l00077">77</a> of file <a class="el" href="plugin_8h_source.html">plugin.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="ac3da34a3ceaf73bae92534871d41a1bb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Plugin::Plugin </td> <td>(</td> <td class="paramtype"><a class="el" href="classKontactInterface_1_1Core.html">Core</a> * </td> <td class="paramname"><em>core</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">QObject * </td> <td class="paramname"><em>parent</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>appName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>pluginName</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Creates a new plugin. </p> <p>Private class that helps to provide binary compatibility between releases.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">core</td><td>The core object that manages the plugin. </td></tr> <tr><td class="paramname">parent</td><td>The parent object. </td></tr> <tr><td class="paramname">appName</td><td>The name of the application that provides the part. This is the name used for DBus registration. It's ok to have several plugins using the same application name. </td></tr> <tr><td class="paramname">pluginName</td><td>The unique name of the plugin. Defaults to appName if not set.</td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00075">75</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="aee4cc1864a2afa84a9ad935153f3fe39"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Plugin::~Plugin </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Destroys the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00089">89</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a9e6fd08f6213b8b565fecaa532a4f7dc"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const KAboutData * Plugin::aboutData </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement this method if you want to add your credits to the Kontact about dialog. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00156">156</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="aaba4d2364e865025cb5bab93874682bb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::aboutToSelect </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Called by kontact when the plugin is selected by the user. </p> <p>Calls the virtual method <a class="el" href="classKontactInterface_1_1Plugin.html#a9b1e9cc591c23c8c8bbb07a76ce5d43e" title="This function is called when the plugin is selected by the user before the widget of the KPart belong...">select()</a>, but also handles some standard behavior like "invisible toolbar actions". </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00273">273</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a50cf81b553bf5b1a13c4d09437f16ef4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::bringToForeground </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement this method if your application needs a different approach to be brought in the foreground. </p> <p>The default behaviour is calling the binary. This is only required if your part is also available as standalone application. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00366">366</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a84be8b21c2c567ef43dde1e1e4d32bb4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool Plugin::canDecodeMimeData </td> <td>(</td> <td class="paramtype">const QMimeData * </td> <td class="paramname"><em>data</em></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns whether the plugin can handle the drag object of the given mime type. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00250">250</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="acad83371e8a9a6e9ad52ada75ae4efa6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::configUpdated </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This function is called whenever the config dialog has been closed successfully. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00286">286</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="aa672c16fdc0b7724365969c949508ccb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKontactInterface_1_1Core.html">Core</a> * Plugin::core </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a pointer to the kontact core object. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00268">268</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="aecd6d81505af55cd6af5a1808239c43f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool Plugin::createDBUSInterface </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>serviceType</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Create the D-Bus interface for the given <code>serviceType</code>, if this plugin provides it. </p> <p>Returns <code>true</code> on success, <code>false</code> otherwise. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00140">140</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="ad72a4a1c1f1ef235bbf209b2bb05ce5a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual KParts::ReadOnlyPart* KontactInterface::Plugin::createPart </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement and return the part here. </p> <p>Reimplementing <a class="el" href="classKontactInterface_1_1Plugin.html#ad72a4a1c1f1ef235bbf209b2bb05ce5a" title="Reimplement and return the part here.">createPart()</a> is mandatory! </p> </div> </div> <a class="anchor" id="a6f76aae6c91131b475ee29dd05d0e6b8"></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="classKontactInterface_1_1Summary.html">Summary</a> * Plugin::createSummaryWidget </td> <td>(</td> <td class="paramtype">QWidget * </td> <td class="paramname"><em>parent</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement this method if you want to add a widget for your application to Kontact's summary page. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">parent</td><td>The parent widget of the summary widget. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00378">378</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="aa3b4de528629aea0c4f8e2c3dba1c00f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Plugin::disabled </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns whether the plugin is disabled. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00404">404</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="abf25353652645f01419f95782ef8d4da"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Plugin::executableName </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the name of the executable (if existent). </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00130">130</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a629ffa812c981fd02c8936c8fd04ddc8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Plugin::icon </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the icon name that is used for the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00120">120</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a8035513498229a238d7de32ded6bfee1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Plugin::identifier </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the identifier of the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00100">100</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a2659fa917e927db3a6c09ba0b9448dbc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::insertNewAction </td> <td>(</td> <td class="paramtype">KAction * </td> <td class="paramname"><em>action</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Inserts a custom "New" <code>action</code>. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00225">225</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="ada0d2cea25a4fb34002f992b6e6c239a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::insertSyncAction </td> <td>(</td> <td class="paramtype">KAction * </td> <td class="paramname"><em>action</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Inserts a custom "Sync" <code>action</code>. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00230">230</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a076d857410108267514111f4913edf0a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">QStringList Plugin::invisibleToolbarActions </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a list of action names that shall be hidden in the main toolbar. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00245">245</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a2933cf6ab06b645e52b5e27c1e6aaa4a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool Plugin::isRunningStandalone </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement this method and return whether a standalone application is still running. </p> <p>This is only required if your part is also available as standalone application. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00146">146</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a82221a604d622266435499abbc65f4d4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">KParts::ReadOnlyPart * Plugin::loadPart </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the loaded part. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00151">151</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a723d829594e5b340653e8e3fa58c1430"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QList< KAction * > Plugin::newActions </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the list of custom "New" actions. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00235">235</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a0b9279ab6238e273de7e06ba91f8cb84"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">KParts::ReadOnlyPart * Plugin::part </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>You can use this method if you need to access the current part. </p> <p>You can be sure that you always get the same pointer as long as the part has not been deleted. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00189">189</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a2da8b45f09095d0999cf3746f7abc871"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::processDropEvent </td> <td>(</td> <td class="paramtype">QDropEvent * </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Process drop event. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00256">256</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a394495bb03f068b46c5e71fd0a8ae0ba"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool Plugin::queryClose </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement this method if you want to add checks before closing the main kontact window. </p> <p>Return true if it's OK to close the window. If any loaded plugin returns false from this method, then the main kontact window will not close. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00394">394</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a471a4aa9c55c4a120b9cdd89d283df3d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::readProperties </td> <td>(</td> <td class="paramtype">const KConfigGroup & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Session management: read properties. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00260">260</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a2a0a5e4242ce73edee0370e66895644b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Plugin::registerClient </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Registers the client at DBus and returns the dbus identifier. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00207">207</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a91d54bf20944a3eb2fae13196c08b0ed"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::saveProperties </td> <td>(</td> <td class="paramtype">KConfigGroup & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Session management: save properties. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00264">264</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a9b1e9cc591c23c8c8bbb07a76ce5d43e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::select </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This function is called when the plugin is selected by the user before the widget of the KPart belonging to the plugin is raised. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00282">282</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="af4a8ef6e2e93526275518a12fa290833"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setDisabled </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>value</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets whether the plugin shall be disabled. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00399">399</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a40c2f5b9529db32a7b0eae229d9d5bd0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setExecutableName </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>name</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the <code>name</code> of executable (if existent). </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00125">125</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a18ce7836474eb8088aad1bfa1462d86b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setIcon </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>icon</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the <code>icon</code> name that is used for the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00115">115</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a0a1804dfb71bdcf92dcc69765c1872aa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setIdentifier </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>identifier</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the <code>identifier</code> of the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00095">95</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="ac54fed8a1486b1f8a92b5e6b218c3ccb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setPartLibraryName </td> <td>(</td> <td class="paramtype">const QByteArray & </td> <td class="paramname"><em>name</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set <code>name</code> of library which contains the KPart used by this plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00135">135</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a1d4412c8f455e8d03d49a5321aebc6ed"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setShowInSideBar </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>hasPart</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set if the plugin provides a part that should be shown in the sidebar. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00389">389</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="af9062497cf77b3984936d794c95d2ee5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Plugin::setTitle </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>title</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Sets the localized <code>title</code> of the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00105">105</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="aec03fe1b0dc7913639c5b0b11ddef159"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool Plugin::showInSideBar </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns whether the plugin provides a part that should be shown in the sidebar. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00384">384</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a3147f4f5a38baeebd7c258d052127693"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::slotConfigUpdated </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">slot</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>usage</p> <p>This slot is called whenever the configuration has been changed. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00361">361</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a26ed94ad66dc227aeb82add162f220cb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QList< KAction * > Plugin::syncActions </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the list of custom "Sync" actions. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00240">240</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a2a82bc225e9027fd6c90497ab1bc7441"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">QString Plugin::tipFile </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Reimplement this method and return the a path relative to "data" to the tips file. </p> <p>The tips file contains hints/tips that are displayed at the beginning of the program as "tip of the day". It has nothing to do with tooltips. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00202">202</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="abe2af021ae05cc8fd27ea30edfec3fdf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString Plugin::title </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns the localized title of the plugin. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00110">110</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a5762664367c1dd67fd84863a25eb072c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void Plugin::virtual_hook </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>data</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Virtual hook for BC extension. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00409">409</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <a class="anchor" id="a6593d5ad133b82f193391b135bd4bb60"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int Plugin::weight </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the weight of the plugin. </p> <p>The higher the weight the lower it will be displayed in the sidebar. The default implementation returns 0. </p> <p>Definition at line <a class="el" href="plugin_8cpp_source.html#l00220">220</a> of file <a class="el" href="plugin_8cpp_source.html">plugin.cpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="plugin_8h_source.html">plugin.h</a></li> <li><a class="el" href="plugin_8cpp_source.html">plugin.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:49 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">Kontact Plugin Interface Library</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "Kontact Plugin Interface Library"</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="classKontactInterface_1_1Core.html">kontactinterface::core</option>, <option value="classKontactInterface_1_1PimUniqueApplication.html">kontactinterface::pimuniqueapplication</option>, <option value="classKontactInterface_1_1Plugin.html">kontactinterface::plugin</option>, <option value="classKontactInterface_1_1Summary.html">kontactinterface::summary</option>, <option value="classKontactInterface_1_1UniqueAppHandler.html">kontactinterface::uniqueapphandler</option>, <option value="classKontactInterface_1_1UniqueAppHandlerFactory.html">kontactinterface::uniqueapphandlerfactory</option>, <option value="classKontactInterface_1_1UniqueAppHandlerFactoryBase.html">kontactinterface::uniqueapphandlerfactorybase</option>, <option value="classKontactInterface_1_1UniqueAppWatcher.html">kontactinterface::uniqueappwatcher</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>