ScriptInterface.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 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/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 8520 $                                                         *
 *   $Author: moebius $                                                      *
 *   $Date: 2010-02-10 15:56:59 +0100 (Mi, 10. Feb 2010) $                   *
 *                                                                           *
\*===========================================================================*/




//
// C++ Interface: ScriptInterface
//
// Description:
//
//
// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
//

#ifndef SCRIPTINTERFACE_HH
#define SCRIPTINTERFACE_HH

#include <QtScript/QScriptEngine>

class ScriptInterface {

   public:
      virtual ~ScriptInterface() {};

  signals :

    virtual void scriptInfo( QString /*_functionName*/  ) {};

    virtual void executeScript( QString /*_script*/  ) {};

    virtual void getScriptingEngine( QScriptEngine*& /*_engine*/  ) {};

    virtual void getAvailableFunctions( QStringList& /*_functions*/  ) {};

    virtual void getDescription(QString /*_function*/, QString& /*_description*/,
                                QStringList& /*_parameters*/, QStringList& /*_descriptions*/  ) {};

  private slots:

    virtual void slotScriptInfo( QString /*_pluginName*/ , QString /*_functionName*/  ) {};


    virtual void slotExecuteScript( QString /*_script*/ ) {};


    virtual void slotExecuteFileScript( QString /*_filename*/ ) {};


};

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

#endif // SCRIPTINTERFACE_HH