ScriptingWrapper.hh 4.48 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40 41
\*===========================================================================*/

42

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




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

53
#pragma once
Jan Möbius's avatar
 
Jan Möbius committed
54 55 56 57 58 59 60 61 62 63 64 65

//=============================================================== 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
 * and passing it to the core. This class is generated for every plugin of the core.
 */
class ScriptingWrapper : public QObject {
  
72
 Q_OBJECT
Jan Möbius's avatar
 
Jan Möbius committed
73 74

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)
   */
85
  explicit ScriptingWrapper(QString _pluginName);
Jan Möbius's avatar
 
Jan Möbius committed
86 87 88 89 90
  
  /// 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
  void slotScriptInfo( QString _functionName  );

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