Scribus
Open source desktop publishing at your fingertips
flattenpath.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 /***************************************************************************
8 * Copyright (C) 2011 by Franz Schmid *
9 * franz.schmid@altmuehlnet.de *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
25 ****************************************************************************/
26 
27 #ifndef FLATTENPATH_H
28 #define FLATTENPATH_H
29 
30 #include "pluginapi.h"
31 #include "scplugin.h"
32 
33 class PLUGIN_API FlattenPathPlugin : public ScActionPlugin
34 {
35  Q_OBJECT
36 
37  public:
38  // Standard plugin implementation
40  virtual ~FlattenPathPlugin();
41  virtual bool run(ScribusDoc* doc, QString target = QString::null);
42  virtual const QString fullTrName() const;
43  virtual const AboutData* getAboutData() const;
44  virtual void deleteAboutData(const AboutData* about) const;
45  virtual void languageChange();
47 
48  // Special features (none)
49 };
50 
51 extern "C" PLUGIN_API int flattenpath_getPluginAPIVersion();
52 extern "C" PLUGIN_API ScPlugin* flattenpath_getPlugin();
53 extern "C" PLUGIN_API void flattenpath_freePlugin(ScPlugin* plugin);
54 
55 #endif
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.
Definition: flattenpath.h:33
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
virtual const AboutData * getAboutData() const =0
Return descriptive information about the plug-in.
virtual void addToMainWindowMenu(ScribusMainWindow *)
Allow plugins to add to a main menu.
Definition: flattenpath.h:46