Developer Documentation

PrintPlugin.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43
44 #ifndef PRINTPLUGIN
45 #define PRINTPLUGIN
46
47 #include <QObject>
48 #include <QMenuBar>
49
50 #include <OpenFlipper/common/Types.hh>
51 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
52 #include <OpenFlipper/BasePlugin/MenuInterface.hh>
53 #include <OpenFlipper/BasePlugin/KeyInterface.hh>
54
55 class PrintPlugin : public QObject, BaseInterface, MenuInterface, KeyInterface
56 {
57 Q_OBJECT
58 Q_INTERFACES(BaseInterface)
59 Q_INTERFACES(MenuInterface)
60 Q_INTERFACES(KeyInterface)
61
62 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Print")
63
64 signals:
65 void addMenubarAction(QAction* _action, QString _type );
66
67 private slots:
68 void pluginsInitialized();
69
70 void slotKeyEvent( QKeyEvent* _event );
71
72 public :
73 QString name() { return (QString("Printing Plugin")); };
74 QString description( ) { return (QString(tr("Print the current view"))); };
75
76 public slots:
77 void printView();
78
79 public slots:
80 QString version() { return QString("1.0"); };
81 };
82
83 #endif //PRINTPLUGIN
PrintPlugin
Definition: PrintPlugin.hh:55
MenuInterface.hh
BaseInterface.hh
KeyInterface.hh
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
PrintPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: PrintPlugin.hh:74
Types.hh
KeyInterface
Keyboard Event Interface.
Definition: KeyInterface.hh:59
PrintPlugin::name
QString name()
Return a name for the plugin.
Definition: PrintPlugin.hh:73
MenuInterface
Interface for all plugins which provide entries to the main menubar.
Definition: MenuInterface.hh:81