scplugin.h
Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007 #ifndef _SCPLUGIN_H
00008 #define _SCPLUGIN_H
00009
00010 #include <QObject>
00011 #include <QWidget>
00012 #include <QString>
00013 #include <QPixmap>
00014 #include <QDateTime>
00015 #include <QIcon>
00016 #include "scribusapi.h"
00017
00018 class ScribusDoc;
00019 class ScribusMainWindow;
00020 class DeferredTask;
00021 class PrefsPanel;
00022
00089 class SCRIBUS_API ScPlugin : public QObject
00090 {
00091 Q_OBJECT
00092
00098 public:
00099
00102 struct AboutData
00103 {
00105 QString authors;
00107 QString shortDescription;
00109 QString description;
00111 QString version;
00113 QDateTime releaseDate;
00115 QString copyright;
00120 QString license;
00121 };
00122
00129 ScPlugin();
00130
00138 virtual ~ScPlugin() = 0;
00139
00146 virtual const QString fullTrName() const = 0;
00147
00173 virtual bool newPrefsPanelWidget(QWidget* parent, PrefsPanel*& panel,
00174 QString& caption, QPixmap& icon);
00175
00187 virtual const AboutData* getAboutData() const = 0;
00188 virtual void deleteAboutData(const AboutData* about) const = 0;
00189
00197 const QString & lastError() const;
00198
00210 virtual void languageChange() = 0;
00211
00213 const QString pluginTypeName() const;
00214
00216 virtual void addToMainWindowMenu(ScribusMainWindow *) = 0;
00217 protected:
00219 QString m_lastError;
00220 };
00221
00222
00234 class SCRIBUS_API ScActionPlugin : public ScPlugin
00235 {
00236 Q_OBJECT
00237
00238 public:
00239
00244 ScActionPlugin();
00245
00247 virtual ~ScActionPlugin() = 0;
00248
00249
00250 struct ActionInfo {
00251 QString name;
00252 QString text;
00253 QString keySequence;
00254 QString menu;
00255 QString menuAfterName;
00256 QString parentMenu;
00257 QString subMenuName;
00258 QString toolbar;
00259 QString toolBarName;
00260 QPixmap icon1;
00261 QPixmap icon2;
00262 QList<int> notSuitableFor;
00263 QList<int> forAppMode;
00264 int needsNumObjects;
00265 QList<int> firstObjectType;
00266 QList<int> secondObjectType;
00267
00268
00269 bool enabledOnStartup;
00270 };
00271
00272
00273 const ActionInfo & actionInfo() const;
00274
00275 public slots:
00302 virtual bool run(ScribusDoc* doc, QString target = QString::null) = 0;
00303
00311 virtual bool run(QWidget* parent, ScribusDoc* doc, QString target = QString::null);
00312
00328 virtual bool run(ScribusDoc* doc, QIODevice* target);
00329
00370 virtual DeferredTask* runAsync(QString target = QString::null);
00371
00379 virtual DeferredTask* runAsync(QIODevice* target);
00380
00381
00382
00383
00384
00385
00387 const QString & runResult() const;
00388
00389 protected:
00390
00391 ActionInfo m_actionInfo;
00392
00393 QString m_runResult;
00394 ScribusDoc* m_Doc;
00395 };
00396
00410 class SCRIBUS_API ScPersistentPlugin : public ScPlugin
00411 {
00412 Q_OBJECT
00413
00414 public:
00415
00420 ScPersistentPlugin();
00421
00423 virtual ~ScPersistentPlugin() = 0;
00424
00449 virtual bool initPlugin() = 0;
00450
00462 virtual bool cleanupPlugin() = 0;
00463 };
00464
00465
00466
00467
00468
00469
00470
00471
00472
00473
00474
00475 #define PLUGIN_API_VERSION 0x00000008
00476
00477
00478 #endif