RPCInterface.hh 4.34 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




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

#ifndef RPCINTERFACE_HH
#define RPCINTERFACE_HH

Jan Möbius's avatar
Jan Möbius committed
58 59
#include <OpenFlipper/BasePlugin/RPCWrappers.hh>

Jan Möbius's avatar
Jan Möbius committed
60 61 62
/** Interface for all Plugins which do remote procedure calls ( and cross plugin calls).\n
 * The functions provided in the interface are only used to verify that certain plugins or
 * functions are available. The actual calls are in the RPCWrappers.hh file.
Jan Möbius's avatar
 
Jan Möbius committed
63 64 65
*/
class RPCInterface {

66
   public:
Jan Möbius's avatar
Jan Möbius committed
67

68 69 70 71
      /// Destructor
      virtual ~RPCInterface() {};

   signals :
Jan Möbius's avatar
 
Jan Möbius committed
72 73 74 75 76

     /** Check if the plugin exists in the current Environment \n
       * @param _pluginName Name of the Plugin (has to be the clean version .. no Spaces etc)
       * @param _exists found or not
       */
Dirk Wilden's avatar
Dirk Wilden committed
77
    virtual void pluginExists( QString /*_pluginName*/ , bool& /*_exists*/  ) {};
Jan Möbius's avatar
 
Jan Möbius committed
78 79 80 81 82 83 84


    /** Check if a plugin exists and provides the given function \n
       * @param _pluginName Name of the Plugin (has to be the clean version .. no Spaces etc)
       * @param _functionName requested function
       * @param _exists found or not
       */
Dirk Wilden's avatar
Dirk Wilden committed
85
    virtual void functionExists( QString /*_pluginName*/ , QString /*_functionName*/ , bool& /*_exists*/  ) {};
Jan Möbius's avatar
 
Jan Möbius committed
86 87 88 89 90 91

};

Q_DECLARE_INTERFACE(RPCInterface,"OpenFlipper.RPCInterface/1.0")

#endif // RPCINTERFACE_HH