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 #pragma once
43
44 #include <QtScript/QScriptEngine>
45
58 class ScriptInterface {
59
60 public:
62 virtual ~ScriptInterface() {};
63
64
65 //===========================================================================
68 //===========================================================================
69
70 signals:
75 virtual void executeScript( QString _script ) {};
76
80 virtual void executeFileScript( QString _filename ) {};
81
84 //===========================================================================
87 //===========================================================================
88
89 signals:
90
94 virtual void getAvailableFunctions(QStringList& _functions) { };
95
103 virtual void getDescription(QString _function, QString& _description, QStringList& _parameters, QStringList& _descriptions) { };
104
107 //===========================================================================
110 //===========================================================================
111 signals:
112
131 virtual void scriptInfo( QString _functionWithParameters ) {};
132
133
136 //===========================================================================
139 //===========================================================================
140
141 signals:
146 virtual void getScriptingEngine( QScriptEngine*& _engine ) {};
147
151 //===========================================================================
154 //===========================================================================
155
156 private slots:
157
163 virtual void slotScriptInfo( QString _pluginName , QString _functionWithParameters ) {};
164
165
170 virtual void slotExecuteScript( QString _script ) {};
171
172
175 virtual void slotExecuteFileScript( QString _filename ) {};
176
179 };
180
242 Q_DECLARE_INTERFACE(ScriptInterface,"OpenFlipper.ScriptInterface/1.1")
243
ScriptInterface::getAvailableFunctions
virtual void getAvailableFunctions(QStringList &_functions)
Definition: ScriptInterface.hh:94
ScriptInterface::slotScriptInfo
virtual void slotScriptInfo(QString _pluginName, QString _functionWithParameters)
Definition: ScriptInterface.hh:163
ScriptInterface::getDescription
virtual void getDescription(QString _function, QString &_description, QStringList &_parameters, QStringList &_descriptions)
Definition: ScriptInterface.hh:103
ScriptInterface::executeFileScript
virtual void executeFileScript(QString _filename)
Definition: ScriptInterface.hh:80
ScriptInterface::executeScript
virtual void executeScript(QString _script)
Definition: ScriptInterface.hh:75
ScriptInterface::~ScriptInterface
virtual ~ScriptInterface()
Destructor.
Definition: ScriptInterface.hh:62
ScriptInterface::slotExecuteFileScript
virtual void slotExecuteFileScript(QString _filename)
Definition: ScriptInterface.hh:175
ScriptInterface::scriptInfo
virtual void scriptInfo(QString _functionWithParameters)
Emit this signal if a scriptable function is executed.
Definition: ScriptInterface.hh:131
ScriptInterface::slotExecuteScript
virtual void slotExecuteScript(QString _script)
Definition: ScriptInterface.hh:170
ScriptInterface
Interface for all Plugins which provide scriptable Functions.
Definition: ScriptInterface.hh:58
ScriptInterface::getScriptingEngine
virtual void getScriptingEngine(QScriptEngine *&_engine)
Definition: ScriptInterface.hh:146