Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 * *
44  * $Revision$ *
45  * $LastChangedBy$ *
46  * $Date$ *
47  * *
48  \*===========================================================================*/
49 
50 #ifndef TESTPLUGIN_HH
51 #define TESTPLUGIN_HH
52 
56 
57 class TestPlugin: public QObject, BaseInterface, LoggingInterface {
58  Q_OBJECT
59  Q_INTERFACES(BaseInterface)
60  Q_INTERFACES(LoggingInterface)
61 
62 #if QT_VERSION >= 0x050000
63  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Test")
64 #endif
65 
66  signals:
67  //BaseInterface
68  void updateView();
69  void updatedObject(int _id, const UpdateType& _type);
70 
71  //LoggingInterface
72  void log(Logtype _type, QString _message);
73  void log(QString _message);
74 
75 public:
76 
77  // BaseInterface
78  QString name() { return (QString("Test Plugin")); } ;
79  QString description() { return (QString("Plugin used for testing OpenFlipper functions")); } ;
80 
81 private slots:
82 
84  void initializePlugin();
85  void pluginsInitialized();
86 
88  void noguiSupported( ) {} ;
89 
90 public slots:
91 
92  QString version() { return QString("1.0"); };
93 
94 };
95 
96 #endif //TESTPLUGIN_HH
Interface class from which all plugins have to be created.
Logtype
Log types for Message Window.
Update type class.
Definition: UpdateType.hh:70
Interface for all Plugins which do logging to the logging window of the framework.
void noguiSupported()
Tell system that this plugin runs without ui.
Definition: TestPlugin.hh:88
QString description()
Return a description of what the plugin is doing.
Definition: TestPlugin.hh:79
QString name()
Return a name for the plugin.
Definition: TestPlugin.hh:78
void initializePlugin()
BaseInterface.
Definition: TestPlugin.cc:55