PluginConnectionInterface.hh 5.54 KB
 Jan Möbius committed Dec 01, 2010 1 2 3 /*===========================================================================*\ * * * OpenFlipper *  Martin Schultz committed Jul 16, 2015 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 committed Dec 01, 2010 39 40 41 * * \*===========================================================================*/  Jan Möbius committed Jan 08, 2019 42 #pragma once  Jan Möbius committed Dec 01, 2010 43 44 45  #include  Jan Möbius committed Mar 01, 2011 46 47 48 49 50 51 /** \file PluginConnectionInterface.hh * * Interface for connecting signals and slots across plugins. \ref pluginConnectionInterfacePage */ /**  Jan Möbius committed Dec 01, 2010 52 53  * \brief Allow to connect slots between plugins *  Jan Möbius committed Mar 01, 2011 54 55 56  * \ref pluginConnectionInterfacePage "Detailed description" * \n *  Jan Möbius committed Dec 01, 2010 57 58  * Interface Class which allows to connect signals and slots across plugins *  Jan Möbius committed Mar 01, 2011 59 60 61 62 63 64 65  * \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 66 67 68 69 70 71 72  */ 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.  Martin Schultz committed Jun 13, 2017 73 74 75 76  * \param _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name) * \param _signal is the signal name. Use it like with regular connect ( SIGNAL(...) ) macro * \param _pluginName2 is the scripting name of the plugin containing a slot * \param _slot is the slot name. Use it like with regular connect ( SLOT(...) ) macro  Jan Möbius committed Dec 01, 2010 77 78  * */  Martin Schultz committed Jun 13, 2017 79  virtual void crossPluginConnect( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot) = 0;  Jan Möbius committed Dec 01, 2010 80   Martin Schultz committed Jun 08, 2017 81 82 83  /** \brief connect signals and slots of plugins across plugins using Qt::QueuedConnection * * Connect a signal of one plugin to another plugin by its scripting name.  Martin Schultz committed Jun 13, 2017 84 85 86 87  * \param _pluginName1 is the scripting name of the plugin containing the signal ( Use script editor to check that name) * \param _signal is the signal name. Use it like with regular connect ( SIGNAL(...) ) macro * \param _pluginName2 is the scripting name of the plugin containing a slot * \param _slot is the slot name. Use it like with regular connect ( SLOT(...) ) macro  Martin Schultz committed Jun 08, 2017 88 89  * */  Martin Schultz committed Jun 13, 2017 90  virtual void crossPluginConnectQueued( QString _pluginName1, const char* _signal, QString _pluginName2, const char* _slot) = 0;  Martin Schultz committed Jun 08, 2017 91   Jan Möbius committed Dec 01, 2010 92 93 94 95 96 97 98 99  public : /// Destructor virtual ~PluginConnectionInterface() {}; };  Jan Möbius committed Mar 01, 2011 100   Jan Möbius committed Dec 01, 2010 101 102 Q_DECLARE_INTERFACE(PluginConnectionInterface,"OpenFlipper.PluginConnectionInterface/1.0")