Developer Documentation
Signals | Public Member Functions | List of all members
PluginConnectionInterface Class Reference

Allow to connect slots between plugins. More...

#include <OpenFlipper/BasePlugin/PluginConnectionInterface.hh>

Signals

virtual void crossPluginConnect (QString _pluginName1, const char *_signal, QString _pluginName2, const char *_slot)
 connect signals and slots of plugins across plugins More...
 

Public Member Functions

virtual void crossPluginConnectQueued (QString _pluginName1, const char *_signal, QString _pluginName2, const char *_slot)
 connect signals and slots of plugins across plugins using Qt::QueuedConnection More...
 
virtual ~PluginConnectionInterface ()
 Destructor.
 

Detailed Description

Allow to connect slots between plugins.

Detailed description
Interface Class which allows to connect signals and slots across plugins


WARNING! Never connect SIGNALS and SLOTS which are already defined in the Interfaces!! WARNING!
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!

Definition at line 67 of file PluginConnectionInterface.hh.

Member Function Documentation

◆ crossPluginConnect

virtual void PluginConnectionInterface::crossPluginConnect ( QString  _pluginName1,
const char *  _signal,
QString  _pluginName2,
const char *  _slot 
)
inlinevirtualsignal

connect signals and slots of plugins across plugins

Connect a signal of one plugin to another plugin by its scripting name.

Parameters
_pluginName1is the scripting name of the plugin containing the signal ( Use script editor to check that name)
_signalis the signal name. Use it like with regular connect ( SIGNAL(...) ) macro
_pluginName2is the scripting name of the plugin containing a slot
_slotis the slot name. Use it like with regular connect ( SLOT(...) ) macro

Definition at line 79 of file PluginConnectionInterface.hh.

◆ crossPluginConnectQueued()

virtual void PluginConnectionInterface::crossPluginConnectQueued ( QString  _pluginName1,
const char *  _signal,
QString  _pluginName2,
const char *  _slot 
)
inlinevirtual

connect signals and slots of plugins across plugins using Qt::QueuedConnection

Connect a signal of one plugin to another plugin by its scripting name.

Parameters
_pluginName1is the scripting name of the plugin containing the signal ( Use script editor to check that name)
_signalis the signal name. Use it like with regular connect ( SIGNAL(...) ) macro
_pluginName2is the scripting name of the plugin containing a slot
_slotis the slot name. Use it like with regular connect ( SLOT(...) ) macro

Definition at line 90 of file PluginConnectionInterface.hh.

The documentation for this class was generated from the following file: