kontact
plugin.h00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024 #ifndef KONTACT_PLUGIN_H
00025 #define KONTACT_PLUGIN_H
00026
00027 #include <qobject.h>
00028 #include <kxmlguiclient.h>
00029 #include <kdepimmacros.h>
00030 #include <qptrlist.h>
00031
00032 class QStringList;
00033 class DCOPClient;
00034 class DCOPObject;
00035 class KAboutData;
00036 class KAction;
00037 class KConfig;
00038 class QWidget;
00039 namespace KParts { class ReadOnlyPart; }
00040
00045 #define KONTACT_PLUGIN_VERSION 6
00046
00047 namespace Kontact
00048 {
00049
00050 class Core;
00051 class Summary;
00052
00058 class KDE_EXPORT Plugin : public QObject, virtual public KXMLGUIClient
00059 {
00060 Q_OBJECT
00061
00062 public:
00071 Plugin( Core *core, QObject *parent, const char *name );
00072
00073 ~Plugin();
00074
00078 void setIdentifier( const QString &identifier );
00079
00084 QString identifier() const;
00085
00089 void setTitle( const QString &title );
00090
00094 QString title() const;
00095
00099 void setIcon( const QString &icon );
00100
00104 QString icon() const;
00105
00109 void setExecutableName( const QString &bin );
00110
00114 QString executableName() const;
00115
00119 void setPartLibraryName( const QCString & );
00120
00125 virtual bool createDCOPInterface( const QString& ) { return false; }
00126
00131 virtual bool isRunningStandalone() { return false; }
00132
00138 virtual void bringToForeground();
00139
00144 virtual const KAboutData *aboutData();
00145
00151 KParts::ReadOnlyPart *part();
00152
00156 virtual QString tipFile() const;
00157
00162 virtual void select();
00163
00168 virtual void configUpdated();
00169
00174 virtual Summary *createSummaryWidget( QWidget * ) { return 0; }
00175
00179 virtual bool showInSideBar() const;
00180
00184 void setShowInSideBar( bool hasPart );
00185
00191 virtual bool queryClose() const { return true; }
00192
00202 DCOPClient *dcopClient() const;
00203
00208 virtual int weight() const { return 0; }
00209
00213 void insertNewAction( KAction *action );
00214
00218 void insertSyncAction( KAction *action );
00219
00223 QPtrList<KAction>* newActions() const;
00224
00228 QPtrList<KAction>* syncActions() const;
00229
00233 virtual QStringList invisibleToolbarActions() const { return QStringList(); }
00234
00238 virtual bool canDecodeDrag( QMimeSource * ) { return false; }
00239
00243 virtual void processDropEvent( QDropEvent * ) {}
00244
00245 virtual void loadProfile( const QString& directoryPath );
00246
00247 virtual void saveToProfile( const QString& directoryPath ) const;
00248
00252 virtual void readProperties( KConfig * ) {}
00253
00257 virtual void saveProperties( KConfig * ) {}
00258
00259 Core *core() const;
00260
00261 bool disabled() const;
00262 void setDisabled( bool v );
00263
00264 public slots:
00268 void slotConfigUpdated();
00269
00270 protected:
00275 virtual KParts::ReadOnlyPart *createPart() = 0;
00276
00277 KParts::ReadOnlyPart *loadPart();
00278
00279 virtual void virtual_hook( int id, void* data );
00280
00281 private slots:
00282 void partDestroyed();
00283
00284 private:
00285 class Private;
00286 Private *d;
00287 };
00288
00289 }
00290
00291 #endif
|