ScriptInterface.hh 5.61 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3 4 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
*                                                                            *
*                              OpenFlipper                                   *
*      Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen       *
*                           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
\*===========================================================================*/
42 43 44 45 46 47 48




//
// C++ Interface: ScriptInterface
//
49
// Description:
50 51 52 53 54
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

55 56
#ifndef SCRIPTINTERFACE_HH
#define SCRIPTINTERFACE_HH
57 58 59 60 61 62 63 64

#include <QtScript/QScriptEngine>

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

66 67 68 69
   public:
      /// Destructor
      virtual ~ScriptInterface() {};

70
  signals :
71

72
     /** \brief Emit this signal if a scriptable function is executed
73
       *
74
       * e.g. selectAllVertices( ObjectId )
75
       *
76 77
       * @param _functionName the called function
       */
Dirk Wilden's avatar
Dirk Wilden committed
78
    virtual void scriptInfo( QString /*_functionName*/  ) {};
79

80 81 82
    /** Emit this signal to execute a script
       * @param _script The script to execute
       */
Dirk Wilden's avatar
Dirk Wilden committed
83
    virtual void executeScript( QString /*_script*/  ) {};
84

85 86 87
    /** Emit this signal to get the core scripting engine
      * @param _engine The scripting Engine
      */
Dirk Wilden's avatar
Dirk Wilden committed
88
    virtual void getScriptingEngine( QScriptEngine*& /*_engine*/  ) {};
89

90 91 92
    /** 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
93
    virtual void getAvailableFunctions( QStringList& /*_functions*/  ) {};
94 95 96 97 98 99 100 101 102 103

    /** 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*/  ) {};
104

105
  private slots:
106

107
    /** Slot for a scripting plugin. Gets the Script and executes it.
108
     *
109 110 111
     * @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
112
    virtual void slotScriptInfo( QString /*_pluginName*/ , QString /*_functionName*/  ) {};
113 114


115
    /** Slot for a scripting plugin. Gets the Script and executes it.
116
     *
117 118
     * @param _script Script to execute
     */
Dirk Wilden's avatar
Dirk Wilden committed
119
    virtual void slotExecuteScript( QString /*_script*/ ) {};
120 121


122 123
    /** Call this slot to open the given file and execute the script in it
     */
Dirk Wilden's avatar
Dirk Wilden committed
124
    virtual void slotExecuteFileScript( QString /*_filename*/ ) {};
125 126


127 128
};

129 130
Q_DECLARE_INTERFACE(ScriptInterface,"OpenFlipper.ScriptInterface/1.1")

131
#endif // SCRIPTINTERFACE_HH