Developer Documentation
ScriptInterface.hh
Go to the documentation of this file.
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 SCRIPTINTERFACE_HH
51 #define SCRIPTINTERFACE_HH
52 
53 #include <QtScript/QScriptEngine>
54 
68 
69  public:
71  virtual ~ScriptInterface() {};
72 
73 
74  //===========================================================================
77  //===========================================================================
78 
79  signals:
84  virtual void executeScript( QString _script ) {};
85 
89  virtual void executeFileScript( QString _filename ) {};
90 
93  //===========================================================================
96  //===========================================================================
97 
98  signals:
99 
103  virtual void getAvailableFunctions(QStringList& _functions) { };
104 
112  virtual void getDescription(QString _function, QString& _description, QStringList& _parameters, QStringList& _descriptions) { };
113 
116  //===========================================================================
119  //===========================================================================
120  signals:
121 
140  virtual void scriptInfo( QString _functionWithParameters ) {};
141 
142 
145  //===========================================================================
148  //===========================================================================
149 
150  signals:
155  virtual void getScriptingEngine( QScriptEngine*& _engine ) {};
156 
160  //===========================================================================
163  //===========================================================================
164 
165  private slots:
166 
172  virtual void slotScriptInfo( QString _pluginName , QString _functionWithParameters ) {};
173 
174 
179  virtual void slotExecuteScript( QString _script ) {};
180 
181 
184  virtual void slotExecuteFileScript( QString _filename ) {};
185 
188 };
189 
251 Q_DECLARE_INTERFACE(ScriptInterface,"OpenFlipper.ScriptInterface/1.1")
252 
253 #endif // SCRIPTINTERFACE_HH
virtual void executeScript(QString _script)
virtual void slotExecuteScript(QString _script)
virtual void slotScriptInfo(QString _pluginName, QString _functionWithParameters)
virtual void getAvailableFunctions(QStringList &_functions)
virtual ~ScriptInterface()
Destructor.
virtual void getDescription(QString _function, QString &_description, QStringList &_parameters, QStringList &_descriptions)
Interface for all Plugins which provide scriptable Functions.
virtual void slotExecuteFileScript(QString _filename)
virtual void scriptInfo(QString _functionWithParameters)
Emit this signal if a scriptable function is executed.
virtual void getScriptingEngine(QScriptEngine *&_engine)
virtual void executeFileScript(QString _filename)