<?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>kontact: plugin.h Source File (kontact)</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=".">kontact</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>kontact</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>plugin.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> This file is part of KDE Kontact.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (c) 2001 Matthias Hoelzer-Kluepfel <mhk@kde.org></span>
<a name="l00005"></a>00005 <span class="comment"> Copyright (c) 2002-2003 Daniel Molkentin <molkentin@kde.org></span>
<a name="l00006"></a>00006 <span class="comment"> Copyright (c) 2003 Cornelius Schumacher <schumacher@kde.org></span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00009"></a>00009 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00010"></a>00010 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00011"></a>00011 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00016"></a>00016 <span class="comment"> Library General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> You should have received a copy of the GNU Library General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span>
<a name="l00020"></a>00020 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00021"></a>00021 <span class="comment"> Boston, MA 02110-1301, USA.</span>
<a name="l00022"></a>00022 <span class="comment">*/</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef KONTACT_PLUGIN_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define KONTACT_PLUGIN_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <qobject.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <kxmlguiclient.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <kdepimmacros.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <qptrlist.h></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">class </span>QStringList;
<a name="l00033"></a>00033 <span class="keyword">class </span>DCOPClient;
<a name="l00034"></a>00034 <span class="keyword">class </span>DCOPObject;
<a name="l00035"></a>00035 <span class="keyword">class </span>KAboutData;
<a name="l00036"></a>00036 <span class="keyword">class </span>KAction;
<a name="l00037"></a>00037 <span class="keyword">class </span>KConfig;
<a name="l00038"></a>00038 <span class="keyword">class </span>QWidget;
<a name="l00039"></a>00039 <span class="keyword">namespace </span>KParts { <span class="keyword">class </span>ReadOnlyPart; }
<a name="l00040"></a>00040
<a name="l00045"></a>00045 <span class="preprocessor">#define KONTACT_PLUGIN_VERSION 6</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="keyword">namespace </span>Kontact
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">class </span>Core;
<a name="l00051"></a>00051 <span class="keyword">class </span>Summary;
<a name="l00052"></a>00052
<a name="l00058"></a><a class="code" href="classKontact_1_1Plugin.html">00058</a> <span class="keyword">class </span>KDE_EXPORT <a class="code" href="classKontact_1_1Plugin.html" title="Base class for all Plugins in Kontact.">Plugin</a> : <span class="keyword">public</span> QObject, <span class="keyword">virtual</span> <span class="keyword">public</span> KXMLGUIClient
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 Q_OBJECT
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00071"></a>00071 <a class="code" href="classKontact_1_1Plugin.html" title="Base class for all Plugins in Kontact.">Plugin</a>( <a class="code" href="classKontact_1_1Core.html" title="This class provides the interface to the Kontact core for the plugins.">Core</a> *core, QObject *parent, <span class="keyword">const</span> <span class="keywordtype">char</span> *name );
<a name="l00072"></a>00072
<a name="l00073"></a>00073 ~<a class="code" href="classKontact_1_1Plugin.html" title="Base class for all Plugins in Kontact.">Plugin</a>();
<a name="l00074"></a>00074
<a name="l00078"></a>00078 <span class="keywordtype">void</span> setIdentifier( <span class="keyword">const</span> QString &identifier );
<a name="l00079"></a>00079
<a name="l00084"></a>00084 QString identifier() <span class="keyword">const</span>;
<a name="l00085"></a>00085
<a name="l00089"></a>00089 <span class="keywordtype">void</span> setTitle( <span class="keyword">const</span> QString &title );
<a name="l00090"></a>00090
<a name="l00094"></a>00094 QString title() <span class="keyword">const</span>;
<a name="l00095"></a>00095
<a name="l00099"></a>00099 <span class="keywordtype">void</span> setIcon( <span class="keyword">const</span> QString &icon );
<a name="l00100"></a>00100
<a name="l00104"></a>00104 QString icon() <span class="keyword">const</span>;
<a name="l00105"></a>00105
<a name="l00109"></a>00109 <span class="keywordtype">void</span> setExecutableName( <span class="keyword">const</span> QString &bin );
<a name="l00110"></a>00110
<a name="l00114"></a>00114 QString executableName() <span class="keyword">const</span>;
<a name="l00115"></a>00115
<a name="l00119"></a>00119 <span class="keywordtype">void</span> setPartLibraryName( <span class="keyword">const</span> QCString & );
<a name="l00120"></a>00120
<a name="l00125"></a><a class="code" href="classKontact_1_1Plugin.html#b9fa096b66c5f168edcbb45b4d12e4e9">00125</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> createDCOPInterface( <span class="keyword">const</span> QString& <span class="comment">/*serviceType*/</span> ) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00126"></a>00126
<a name="l00131"></a><a class="code" href="classKontact_1_1Plugin.html#1db12c027dab92bb37dd73b16f7556f8">00131</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isRunningStandalone() { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00132"></a>00132
<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">void</span> bringToForeground();
<a name="l00139"></a>00139
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keyword">const</span> KAboutData *aboutData();
<a name="l00145"></a>00145
<a name="l00151"></a>00151 KParts::ReadOnlyPart *part();
<a name="l00152"></a>00152
<a name="l00156"></a>00156 <span class="keyword">virtual</span> QString tipFile() <span class="keyword">const</span>;
<a name="l00157"></a>00157
<a name="l00162"></a>00162 <span class="keyword">virtual</span> <span class="keywordtype">void</span> select();
<a name="l00163"></a>00163
<a name="l00168"></a>00168 <span class="keyword">virtual</span> <span class="keywordtype">void</span> configUpdated();
<a name="l00169"></a>00169
<a name="l00174"></a><a class="code" href="classKontact_1_1Plugin.html#d2f6bcddfe035cb5887deef5d01d8a72">00174</a> <span class="keyword">virtual</span> <a class="code" href="classKontact_1_1Summary.html" title="Summary widget for display in the Summary View plugin.">Summary</a> *createSummaryWidget( QWidget * <span class="comment">/*parent*/</span> ) { <span class="keywordflow">return</span> 0; }
<a name="l00175"></a>00175
<a name="l00179"></a>00179 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> showInSideBar() <span class="keyword">const</span>;
<a name="l00180"></a>00180
<a name="l00184"></a>00184 <span class="keywordtype">void</span> setShowInSideBar( <span class="keywordtype">bool</span> hasPart );
<a name="l00185"></a>00185
<a name="l00191"></a><a class="code" href="classKontact_1_1Plugin.html#f44c45ae67dc82464e5f792f33f07483">00191</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> queryClose()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }
<a name="l00192"></a>00192
<a name="l00202"></a>00202 DCOPClient *dcopClient() <span class="keyword">const</span>;
<a name="l00203"></a>00203
<a name="l00208"></a><a class="code" href="classKontact_1_1Plugin.html#74d18be0a202daf34ae8701561f7dc38">00208</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> weight()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }
<a name="l00209"></a>00209
<a name="l00213"></a>00213 <span class="keywordtype">void</span> insertNewAction( KAction *action );
<a name="l00214"></a>00214
<a name="l00218"></a>00218 <span class="keywordtype">void</span> insertSyncAction( KAction *action );
<a name="l00219"></a>00219
<a name="l00223"></a>00223 QPtrList<KAction>* newActions() <span class="keyword">const</span>;
<a name="l00224"></a>00224
<a name="l00228"></a>00228 QPtrList<KAction>* syncActions() <span class="keyword">const</span>;
<a name="l00229"></a>00229
<a name="l00233"></a><a class="code" href="classKontact_1_1Plugin.html#dda2ad9bdccaa908297dea82eb2d4b27">00233</a> <span class="keyword">virtual</span> QStringList invisibleToolbarActions()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> QStringList(); }
<a name="l00234"></a>00234
<a name="l00238"></a><a class="code" href="classKontact_1_1Plugin.html#c6eccf506ff50251493c3903a84e6f91">00238</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> canDecodeDrag( QMimeSource * ) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00239"></a>00239
<a name="l00243"></a><a class="code" href="classKontact_1_1Plugin.html#97b7923349a8d61127da445e282cd5c5">00243</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> processDropEvent( QDropEvent * ) {}
<a name="l00244"></a>00244
<a name="l00245"></a>00245 <span class="keyword">virtual</span> <span class="keywordtype">void</span> loadProfile( <span class="keyword">const</span> QString& directoryPath );
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="keyword">virtual</span> <span class="keywordtype">void</span> saveToProfile( <span class="keyword">const</span> QString& directoryPath ) <span class="keyword">const</span>;
<a name="l00248"></a>00248
<a name="l00252"></a><a class="code" href="classKontact_1_1Plugin.html#e52d1d14fa00aaba60d7c7f67dd930b3">00252</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> readProperties( KConfig * ) {}
<a name="l00253"></a>00253
<a name="l00257"></a><a class="code" href="classKontact_1_1Plugin.html#72a846c39e383b0a1364fa813bf57603">00257</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> saveProperties( KConfig * ) {}
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <a class="code" href="classKontact_1_1Core.html" title="This class provides the interface to the Kontact core for the plugins.">Core</a> *core() <span class="keyword">const</span>;
<a name="l00260"></a>00260
<a name="l00261"></a>00261 <span class="keywordtype">bool</span> disabled() <span class="keyword">const</span>;
<a name="l00262"></a>00262 <span class="keywordtype">void</span> setDisabled( <span class="keywordtype">bool</span> v );
<a name="l00263"></a>00263
<a name="l00264"></a>00264 <span class="keyword">public</span> slots:
<a name="l00268"></a>00268 <span class="keywordtype">void</span> slotConfigUpdated();
<a name="l00269"></a>00269
<a name="l00270"></a>00270 <span class="keyword">protected</span>:
<a name="l00275"></a>00275 <span class="keyword">virtual</span> KParts::ReadOnlyPart *createPart() = 0;
<a name="l00276"></a>00276
<a name="l00277"></a>00277 KParts::ReadOnlyPart *loadPart();
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="keyword">virtual</span> <span class="keywordtype">void</span> virtual_hook( <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">void</span>* data );
<a name="l00280"></a>00280
<a name="l00281"></a>00281 <span class="keyword">private</span> slots:
<a name="l00282"></a>00282 <span class="keywordtype">void</span> partDestroyed();
<a name="l00283"></a>00283
<a name="l00284"></a>00284 <span class="keyword">private</span>:
<a name="l00285"></a>00285 <span class="keyword">class </span>Private;
<a name="l00286"></a>00286 Private *d;
<a name="l00287"></a>00287 };
<a name="l00288"></a>00288
<a name="l00289"></a>00289 }
<a name="l00290"></a>00290
<a name="l00291"></a>00291 <span class="preprocessor">#endif</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kontact</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKontact_1_1Core.html">kontact::core</option>, <option value="classKontact_1_1EntryItem.html">kontact::entryitem</option>, <option value="classKontact_1_1EntryItemToolTip.html">kontact::entryitemtooltip</option>, <option value="classKontact_1_1Navigator.html">kontact::navigator</option>, <option value="classKontact_1_1Plugin.html">kontact::plugin</option>, <option value="classKontact_1_1Summary.html">kontact::summary</option>, <option value="classKontact_1_1UniqueAppHandler.html">kontact::uniqueapphandler</option>, <option value="classKontact_1_1UniqueAppHandlerFactory.html">kontact::uniqueapphandlerfactory</option>, <option value="classKontact_1_1UniqueAppHandlerFactoryBase.html">kontact::uniqueapphandlerfactorybase</option>, <option value="classKontact_1_1UniqueAppWatcher.html">kontact::uniqueappwatcher</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>
