ScriptInterface.hh 5.49 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37 38 39 40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42

43 44
#ifndef SCRIPTINTERFACE_HH
#define SCRIPTINTERFACE_HH
Jan Möbius's avatar
 
Jan Möbius committed
45 46 47 48 49 50 51 52

#include <QtScript/QScriptEngine>

/** Interface for all Plugins which provide scriptable Functions.
 * These Functions should follow some guidelines :
 * -# Todo
*/
class ScriptInterface {
53

54 55 56 57
   public:
      /// Destructor
      virtual ~ScriptInterface() {};

Jan Möbius's avatar
 
Jan Möbius committed
58
  signals :
59

Jan Möbius's avatar
 
Jan Möbius committed
60
     /** \brief Emit this signal if a scriptable function is executed
61
       *
Jan Möbius's avatar
 
Jan Möbius committed
62
       * e.g. selectAllVertices( ObjectId )
63
       *
Jan Möbius's avatar
 
Jan Möbius committed
64 65
       * @param _functionName the called function
       */
Dirk Wilden's avatar
Dirk Wilden committed
66
    virtual void scriptInfo( QString /*_functionName*/  ) {};
67

Jan Möbius's avatar
 
Jan Möbius committed
68 69 70
    /** Emit this signal to execute a script
       * @param _script The script to execute
       */
Dirk Wilden's avatar
Dirk Wilden committed
71
    virtual void executeScript( QString /*_script*/  ) {};
72

Jan Möbius's avatar
 
Jan Möbius committed
73 74 75
    /** Emit this signal to get the core scripting engine
      * @param _engine The scripting Engine
      */
Dirk Wilden's avatar
Dirk Wilden committed
76
    virtual void getScriptingEngine( QScriptEngine*& /*_engine*/  ) {};
77

Jan Möbius's avatar
 
Jan Möbius committed
78 79 80
    /** With this signal you can get a list of all available scripting functions
     * @param _functions All available functions
     */
Dirk Wilden's avatar
Dirk Wilden committed
81
    virtual void getAvailableFunctions( QStringList& /*_functions*/  ) {};
82 83 84 85 86 87 88 89 90 91

    /** With this signal you can get descriptions about a given function if available
     *
     *   @param _function name of the function (e.g. plugin.function)
     *   @param _description a description for the function
     *   @param _parameters list of names for the parameters
     *   @param _descriptions list of descriptions for the parameters (_descriptions[i] corresponds to _parameters[i])
     */
    virtual void getDescription(QString /*_function*/, QString& /*_description*/,
                                QStringList& /*_parameters*/, QStringList& /*_descriptions*/  ) {};
92

Jan Möbius's avatar
 
Jan Möbius committed
93
  private slots:
94

Jan Möbius's avatar
 
Jan Möbius committed
95
    /** Slot for a scripting plugin. Gets the Script and executes it.
96
     *
Jan Möbius's avatar
 
Jan Möbius committed
97 98 99
     * @param _pluginName Name of the plugin that executed a scriptable function
     * @param _functionName Name of the executed function
     */
Dirk Wilden's avatar
Dirk Wilden committed
100
    virtual void slotScriptInfo( QString /*_pluginName*/ , QString /*_functionName*/  ) {};
101 102


Jan Möbius's avatar
 
Jan Möbius committed
103
    /** Slot for a scripting plugin. Gets the Script and executes it.
104
     *
Jan Möbius's avatar
 
Jan Möbius committed
105 106
     * @param _script Script to execute
     */
Dirk Wilden's avatar
Dirk Wilden committed
107
    virtual void slotExecuteScript( QString /*_script*/ ) {};
108 109


Jan Möbius's avatar
 
Jan Möbius committed
110 111
    /** Call this slot to open the given file and execute the script in it
     */
Dirk Wilden's avatar
Dirk Wilden committed
112
    virtual void slotExecuteFileScript( QString /*_filename*/ ) {};
113 114


Jan Möbius's avatar
 
Jan Möbius committed
115 116
};

117 118
Q_DECLARE_INTERFACE(ScriptInterface,"OpenFlipper.ScriptInterface/1.1")

Jan Möbius's avatar
 
Jan Möbius committed
119
#endif // SCRIPTINTERFACE_HH