Developer Documentation

TestPlugin.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 #ifndef TESTPLUGIN_HH
44 #define TESTPLUGIN_HH
45
46 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
47 #include <OpenFlipper/BasePlugin/LoggingInterface.hh>
48 #include <OpenFlipper/common/Types.hh>
49
50 class TestPlugin: public QObject, BaseInterface, LoggingInterface {
51 Q_OBJECT
52 Q_INTERFACES(BaseInterface)
53 Q_INTERFACES(LoggingInterface)
54
55 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Test")
56
57 signals:
58 //BaseInterface
59 void updateView();
60 void updatedObject(int _id, const UpdateType& _type);
61
62 //LoggingInterface
63 void log(Logtype _type, QString _message);
64 void log(QString _message);
65
66 public:
67
68 // BaseInterface
69 QString name() { return (QString("Test Plugin")); } ;
70 QString description() { return (QString("Plugin used for testing OpenFlipper functions")); } ;
71
72 private slots:
73
75 void initializePlugin();
76 void pluginsInitialized();
77
79 void noguiSupported( ) {} ;
80
81 public slots:
82
83 QString version() { return QString("1.0"); };
84
85 };
86
87 #endif //TESTPLUGIN_HH
UpdateType
Update type class.
Definition: UpdateType.hh:60
Logtype
Logtype
Log types for Message Window.
Definition: LoggingInterface.hh:92
LoggingInterface.hh
TestPlugin
Definition: TestPlugin.hh:50
TestPlugin::description
QString description()
Return a description of what the plugin is doing.
Definition: TestPlugin.hh:70
LoggingInterface
Interface for all Plugins which do logging to the logging window of the framework.
Definition: LoggingInterface.hh:112
TestPlugin::name
QString name()
Return a name for the plugin.
Definition: TestPlugin.hh:69
BaseInterface.hh
TestPlugin::noguiSupported
void noguiSupported()
Tell system that this plugin runs without ui.
Definition: TestPlugin.hh:79
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:65
Types.hh
TestPlugin::initializePlugin
void initializePlugin()
BaseInterface.
Definition: TestPlugin.cc:49