Scribus
Open source desktop publishing at your fingertips
shortwords.h
1 /*
2 For general Scribus (>=1.3.2) copyright and licensing information please refer
3 to the COPYING file provided with the program. Following this notice may exist
4 a copyright and/or license notice that predates the release of Scribus 1.3.2
5 for which a new license (GPL+exception) is in place.
6 */
7 #ifndef SCRIBUS_SHORTWORDS_H
8 #define SCRIBUS_SHORTWORDS_H
9 
10 #include "scconfig.h"
11 #include "pluginapi.h"
12 #include "scplugin.h"
13 #include <QPixmap>
14 
22 class PLUGIN_API ShortWordsPlugin : public ScActionPlugin
23 {
24  Q_OBJECT
25 
26  public:
27  // Standard plugin implementation
29  virtual ~ShortWordsPlugin();
30  virtual bool run(ScribusDoc* doc, QString target = QString::null);
31  virtual const QString fullTrName() const;
32  virtual const AboutData* getAboutData() const;
33  virtual void deleteAboutData(const AboutData* about) const;
34  virtual void languageChange();
37  virtual bool newPrefsPanelWidget(QWidget* parent, PrefsPanel*& panel,
38  QString& caption, QPixmap& icon);
39  virtual bool newPrefsPanelWidget(QWidget* parent, Prefs_Pane*& panel,
40  QString& caption, QPixmap& icon);
41  // Special features (none)
42 };
43 
44 extern "C" PLUGIN_API int scribusshortwords_getPluginAPIVersion();
45 extern "C" PLUGIN_API ScPlugin* scribusshortwords_getPlugin();
46 extern "C" PLUGIN_API void scribusshortwords_freePlugin(ScPlugin* plugin);
47 
48 #endif
virtual bool newPrefsPanelWidget(QWidget *parent, PrefsPanel *&panel, QString &caption, QPixmap &icon)
Create and return a prefs UI panel for the plugin.
Definition: scplugin.cpp:30
A plug-in that performs a single action.
Definition: scplugin.h:248
virtual const QString fullTrName() const =0
Plug-in's human-readable, translated name.
Abstract super class for all Scribus plug-ins.
Definition: scplugin.h:90
This Class is the base class for your application. It sets up the main window and providing a menubar...
Definition: scribus.h:123
virtual bool run(ScribusDoc *doc, QString target=QString::null)=0
Run the plug-in's main action.
virtual void languageChange()=0
Update all user-visible text to reflect current UI language.
the Document Class
Definition: scribusdoc.h:90
ScPlugin provides an interface to ask plugins for information about themselves.
Definition: scplugin.h:103
A base class for all preferences panels.
Definition: prefspanel.h:21
Definition: prefs_pane.h:14
This is the Scribus Short Words plugin interface specification.
Definition: shortwords.h:22
virtual void addToMainWindowMenu(ScribusMainWindow *)
Allow plugins to add to a main menu.
Definition: shortwords.h:35
virtual const AboutData * getAboutData() const =0
Return descriptive information about the plug-in.