Developer Documentation
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 //== INCLUDES =================================================================
45 
46 #ifndef VSIPLUGIN_HH
47 #define VSIPLUGIN_HH
48 
49 #include <QObject>
50 #include <QScriptValue>
51 
56 
57 #include <QPushButton>
58 #include <QHBoxLayout>
59 
60 //== FORWARDDECLARATIONS ======================================================
61 
62 namespace VSI {
63  class Context;
64  class BaseWidget;
65 }
66 
67 //== CLASS DEFINITION =========================================================
68 
72 {
73  Q_OBJECT
74  Q_INTERFACES(BaseInterface)
75  Q_INTERFACES(MenuInterface)
76  Q_INTERFACES(ScriptInterface)
77  Q_INTERFACES(RPCInterface)
78 
79  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-VSI")
80 
81  signals:
82 
83  // MenuInterface
84  void getMenubarMenu (QString _name, QMenu *& _menu, bool _create);
85 
86  // ScriptInterface
87  void getScriptingEngine (QScriptEngine*& _engine);
88 
89  // RPC Interface
90  void pluginExists (QString _pluginName, bool& _exists) ;
91  void functionExists (QString _pluginName, QString _functionName, bool& _exists);
92 
93  public:
94 
96  VsiPlugin ();
97 
99  ~VsiPlugin ();
100 
102  QString name () { return QString ("Visual Scripting"); };
103 
105  QString description () { return QString ("Visual Scripting interface for OpenFlipper"); };
106 
107  public slots:
108 
110  QScriptValue askForInputs (QString _element, QString _inputs);
111 
113  void messageBox (QString _message);
114 
116  bool questionBox (QString _message);
117 
119  bool continueBox(QString _message);
120 
121  QString version () { return QString("1.0"); };
122 
123  private slots:
124  void pluginsInitialized ();
125 
126  void noguiSupported () {};
127 
129  void showScriptEditor ();
130 
132  void showInScriptEditor (QString _script);
133 
134  private:
135 
137  void initContext ();
138 
139  private:
140 
141  VSI::Context *context_;
142  VSI::BaseWidget *baseWidget_;
143 };
144 
145 //=============================================================================
146 
147 class QContinueBox : public QWidget {
148  Q_OBJECT
149 
150 public:
151  QContinueBox(QString _message,QWidget* _parent = 0) :
152  QWidget(_parent),
153  continue_(true)
154  {
155  QPushButton* stopButton = new QPushButton("Stop",this);
156  QHBoxLayout* layout = new QHBoxLayout(this);
157 
158  this->setWindowTitle(_message);
159 
160  layout->addWidget(stopButton);
161  this->setLayout(layout);
162 
163  connect(stopButton,SIGNAL(clicked()), this, SLOT(clicked()));
164  }
165 
166 public slots:
167  void clicked( ) {
168  continue_ = false;
169  }
170 
171 public:
172  bool continueBox() { return continue_; };
173 
174 private:
175  bool continue_;
176 };
177 
178 
179 //=============================================================================
180 //=============================================================================
181 
182 #endif
Interface for all plugins which provide entries to the main menubar.
QString description()
Description of the Plugin.
Definition: vsiPlugin.hh:105
QString name()
Name of the Plugin.
Definition: vsiPlugin.hh:102
Interface to call functions across plugins.
Definition: RPCInterface.hh:61
Interface for all Plugins which provide scriptable Functions.
Interface class from which all plugins have to be created.