PluginConnectionInterface.hh 6.4 KB
 Jan Möbius committed Dec 01, 2010 1 2 3 /*===========================================================================*\ * * * OpenFlipper *  Jan Möbius committed Jan 26, 2011 4 * Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen *  Jan Möbius committed Dec 01, 2010 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 39 40 41 42 43 44 45 46 47 48 * 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 . * * * \*===========================================================================*/ /*===========================================================================*\ * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * * \*===========================================================================*/ #ifndef PLUGINCONNECTIONINTERFACE_HH #define PLUGINCONNECTIONINTERFACE_HH #include  Jan Möbius committed Mar 01, 2011 49 50 51 52 53 54 /** \file PluginConnectionInterface.hh * * Interface for connecting signals and slots across plugins. \ref pluginConnectionInterfacePage */ /**  Jan Möbius committed Dec 01, 2010 55 56  * \brief Allow to connect slots between plugins *  Jan Möbius committed Mar 01, 2011 57 58 59  * \ref pluginConnectionInterfacePage "Detailed description" * \n *  Jan Möbius committed Dec 01, 2010 60 61  * Interface Class which allows to connect signals and slots across plugins *  Jan Möbius committed Mar 01, 2011 62 63 64 65 66 67 68  * \n * WARNING! Never connect SIGNALS and SLOTS which are already defined in the Interfaces!! WARNING! * \n * * This might result in endless loops and breaks OpenFlippers control loops. You have to keep track * of your connections yourself. If you call slots which call updatedOject which in turn call your original * slot you get a loop and OpenFlipper is not responsible for your endless loops! Be careful!  Jan Möbius committed Dec 01, 2010 69 70 71 72 73 74 75 76  */ class PluginConnectionInterface { signals : /** \brief connect signals and slots of plugins across plugins * * Connect a signal of one plugin to another plugin by its scripting name. * _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name)  Jan Möbius committed Mar 01, 2011 77  * _signal is the signal name. Use it like with regular connect ( SIGNAL(...) ) macro  Jan Möbius committed Dec 01, 2010 78  * _pluginName2 is the scripting name of the plugin containing a slot  Jan Möbius committed Mar 01, 2011 79  * _slot is the slot name. Use it like with regular connect ( SLOT(...) ) macro  Jan Möbius committed Dec 01, 2010 80 81 82 83 84 85 86 87 88 89 90 91  * */ virtual void crossPluginConnect( QString /*_pluginName1*/, const char* /*_signal*/, QString /*_pluginName2*/, const char* /*_slot*/) {}; public : /// Destructor virtual ~PluginConnectionInterface() {}; };  Jan Möbius committed Mar 01, 2011 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 /** \page pluginConnectionInterfacePage Plugin Connection Interface \n \image html PluginConnectionInterface.png \n The PluginConnectionInterface allows to connect signals and slots across different OpenFlipper plugins. Usually you should implement the BaseInterface::pluginsInitialized() function from BaseInterface. In this function you can setup your connections. Don't try to setup your connections earlier as the plugins you try to connect may not exist yet. \n WARNING! Never connect SIGNALS and SLOTS which are already defined in other Interfaces!! WARNING! \n This might result in endless loops and breaks OpenFlippers control loops. You have to keep track of your connections yourself. If you call slots which call updatedOject which in turn call your original slot you get a loop and OpenFlipper is not responsible for your endless loops! Be careful! The following code shows a simple example to connect signals and slots. For the signal and slot definition you have to use the common QT macros SIGNAL and SLOT. \code void ExamplePlugin::pluginsInitialized() { // Use the QT macros to generate the signatures emit crossPluginConnect(pluginA,SIGNAL(signalA(QString)),pluginB,SLOT(slotB(QString))); } \endcode To use the ScriptInterface:
*/  Jan Möbius committed Dec 01, 2010 130 131 132 Q_DECLARE_INTERFACE(PluginConnectionInterface,"OpenFlipper.PluginConnectionInterface/1.0") #endif // PLUGINCONNECTIONINTERFACE_HH