Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vsiPlugin.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 //== INCLUDES =================================================================
51
52 #ifndef VSIPLUGIN_HH
53 #define VSIPLUGIN_HH
54
55 #include <QObject>
56 #include <QScriptValue>
57
58 #include <OpenFlipper/BasePlugin/BaseInterface.hh>
59 #include <OpenFlipper/BasePlugin/MenuInterface.hh>
60 #include <OpenFlipper/BasePlugin/ScriptInterface.hh>
61 #include <OpenFlipper/BasePlugin/RPCInterface.hh>
62
63 //== FORWARDDECLARATIONS ======================================================
64
65 namespace VSI {
66 class Context;
67 class BaseWidget;
68 }
69
70 //== CLASS DEFINITION =========================================================
71
74 class VsiPlugin : public QObject, BaseInterface, MenuInterface, ScriptInterface, RPCInterface
75 {
76 Q_OBJECT
77 Q_INTERFACES(BaseInterface)
78 Q_INTERFACES(MenuInterface)
79 Q_INTERFACES(ScriptInterface)
80 Q_INTERFACES(RPCInterface)
81
82 #if QT_VERSION >= 0x050000
83 Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-VSI")
84 #endif
85
86 signals:
87
88 // MenuInterface
89 void getMenubarMenu (QString _name, QMenu *& _menu, bool _create);
90
91 // ScriptInterface
92 void getScriptingEngine (QScriptEngine*& _engine);
93
94 // RPC Interface
95 void pluginExists (QString _pluginName, bool& _exists) ;
96 void functionExists (QString _pluginName, QString _functionName, bool& _exists);
97
98 public:
99
101 VsiPlugin ();
102
104 ~VsiPlugin ();
105
107 QString name () { return QString ("Visual Scripting"); };
108
110 QString description () { return QString ("Visual Scripting interface for OpenFlipper"); };
111
112 public slots:
113
115 QScriptValue askForInputs (QString _element, QString _inputs);
116
118 void messageBox (QString _message);
119
121 bool questionBox (QString _message);
122
124 bool continueBox(QString _message);
125
126 QString version () { return QString("1.0"); };
127
128 private slots:
129 void pluginsInitialized ();
130
131 void noguiSupported () {};
132
134 void showScriptEditor ();
135
137 void showInScriptEditor (QString _script);
138
139 private:
140
142 void initContext ();
143
144 private:
145
146 VSI::Context *context_;
147 VSI::BaseWidget *baseWidget_;
148 };
149
150 //=============================================================================
151
152 class QContinueBox : public QWidget {
153 Q_OBJECT
154
155 public:
156 QContinueBox(QString _message,QWidget* _parent = 0) :
157 QWidget(_parent),
158 continue_(true)
159 {
160 QPushButton* stopButton = new QPushButton("Stop",this);
161 QHBoxLayout* layout = new QHBoxLayout(this);
162
163 this->setWindowTitle(_message);
164
165 layout->addWidget(stopButton);
166 this->setLayout(layout);
167
168 connect(stopButton,SIGNAL(clicked()), this, SLOT(clicked()));
169 }
170
171 public slots:
172 void clicked( ) {
173 continue_ = false;
174 }
175
176 public:
177 bool continueBox() { return continue_; };
178
179 private:
180 bool continue_;
181 };
182
183
184 //=============================================================================
185 //=============================================================================
186
187 #endif
VSI
Definition: baseWidget.cc:78
BaseInterface
Interface class from which all plugins have to be created.
Definition: BaseInterface.hh:76
VSI::BaseWidget
Definition: baseWidget.hh:75
VsiPlugin::pluginsInitialized
void pluginsInitialized()
Register in menubar.
Definition: vsiPlugin.cc:96
VSI::Context
Definition: context.hh:76
VsiPlugin::askForInputs
QScriptValue askForInputs(QString _element, QString _inputs)
Scripting function, that allows to ask the user for inputs during script execution.
Definition: vsiPlugin.cc:175
VsiPlugin::description
QString description()
Description of the Plugin.
Definition: vsiPlugin.hh:110
RPCInterface
Interface to call functions across plugins.
Definition: RPCInterface.hh:71
VsiPlugin::~VsiPlugin
~VsiPlugin()
Destructor.
Definition: vsiPlugin.cc:85
VsiPlugin::continueBox
bool continueBox(QString _message)
Shows a non blocking stop box for use inside loops.
Definition: vsiPlugin.cc:264
VsiPlugin::showInScriptEditor
void showInScriptEditor(QString _script)
Opens the text based script editor with the given script.
Definition: vsiPlugin.cc:226
VsiPlugin::messageBox
void messageBox(QString _message)
Scripting function, that displays a message box.
Definition: vsiPlugin.cc:241
VsiPlugin::questionBox
bool questionBox(QString _message)
Scripting function, that displays a Yes/No message box.
Definition: vsiPlugin.cc:251
VsiPlugin::name
QString name()
Name of the Plugin.
Definition: vsiPlugin.hh:107
ScriptInterface
Interface for all Plugins which provide scriptable Functions.
Definition: ScriptInterface.hh:67
RPCInterface.hh
ScriptInterface.hh
BaseInterface.hh
VsiPlugin::initContext
void initContext()
initalisation
Definition: vsiPlugin.cc:132
QContinueBox
Definition: vsiPlugin.hh:152
VsiPlugin
Definition: vsiPlugin.hh:74
MenuInterface.hh
VsiPlugin::showScriptEditor
void showScriptEditor()
Shows visual script editor.
Definition: vsiPlugin.cc:118
MenuInterface
Interface for all plugins which provide entries to the main menubar.
Definition: MenuInterface.hh:91
VsiPlugin::VsiPlugin
VsiPlugin()
Constructor.
Definition: vsiPlugin.cc:76