Scripting.hh 4.62 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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65




//=============================================================================
//
//  Logging System
//
//=============================================================================

#ifndef SCRIPTING_HH
#define SCRIPTING_HH

//=============================================================== INCLUDES ====

#include <QObject>

//======================================================= CLASS DEFINITION ====
/**
 * \file Scripting.hh 
 * This File contains the header for the scripting wrapper used for Plugins
*/


Jan Möbius's avatar
Jan Möbius committed
66 67
/** \class ScriptingWrapper
 * A wrapper class, getting events from an plugin, prepending plugin name to the scripting
Jan Möbius's avatar
 
Jan Möbius committed
68 69 70 71 72 73 74
 * and passing it to the core. This class is generated for every plugin of the core.
 */
class ScriptingWrapper : public QObject {
  
Q_OBJECT

signals:
Jan Möbius's avatar
Jan Möbius committed
75 76
  /// complete signal for scripting plugins

Jan Möbius's avatar
 
Jan Möbius committed
77 78 79 80
  void scriptInfo( QString _pluginName , QString _functionName  );
    
public:
  
Jan Möbius's avatar
Jan Möbius committed
81 82 83 84
  /** \brief Standard Constructor
   *
   * @param _pluginName Name of the Plugin which uses this logger (Prepended to all Output)
   */
Jan Möbius's avatar
 
Jan Möbius committed
85 86 87 88 89 90
  ScriptingWrapper(QString _pluginName);
  
  /// Destructor
  ~ScriptingWrapper();
  
private slots:
Jan Möbius's avatar
Jan Möbius committed
91 92 93 94
  /** \brief This function prepends the plugin name and emits the extended signal to the core.
   *
   * @param _functionName Name of the function
   */
Jan Möbius's avatar
 
Jan Möbius committed
95 96 97 98 99 100 101 102 103 104 105 106
  void slotScriptInfo( QString _functionName  );

private:
  /// The Scriptng name of the plugin
  QString pluginName_;
    
};


//=============================================================================
#endif // SCRIPTING_HH
//=============================================================================