Developer Documentation

Namespaces
RPCWrappers.hh File Reference
`#include <QtScript>`
`#include <vector>`
`#include <OpenFlipper/common/Types.hh>`

Go to the source code of this file.

## Namespaces
| RPC

## Functions
Script Engine Controls
Functions to get the scripting engine. Normally you don't need them. And RPC::setScriptEngine should never be used!
QScriptEngine * | RPC::getScriptEngine ()
| get a pointer to OpenFlippers core scripting engine More...
void | RPC::setScriptEngine (QScriptEngine *_engine)
| DONT USE! (Function to set the internal reference to the script Engine) More...
Call functions across plugins (simple calls)
These functions can be used to call functions in other plugins.
QScriptValue | RPC::callFunction (QString _plugin, QString _functionName)
| call a function provided by a plugin More...
QScriptValue | RPC::callFunction (QString _plugin, QString _functionName, std::vector< QScriptValue > _parameters)
| Call a function provided by a plugin getting multiple parameters. More...
Call functions across plugins
These templates can be used to call functions in other plugins.
template<typename T0 >
void | RPC::callFunction (QString _plugin, QString _functionName, T0 _t0)
| call a function in another plugin More...
template<typename T0 , typename T1 >
void | RPC::callFunction (QString _plugin, QString _functionName, T0 _t0, T1 _t1)
| call a function in another plugin More...
template<typename T0 , typename T1 , typename T2 >
void | RPC::callFunction (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2)
| call a function in another plugin More...
template<typename T0 , typename T1 , typename T2 , typename T3 >
void | RPC::callFunction (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2, T3 _t3)
| call a function in another plugin More...
template<typename T0 , typename T1 , typename T2 , typename T3 , typename T4 >
void | RPC::callFunction (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2, T3 _t3, T4 _t4)
| call a function in another plugin More...
template<typename T0 , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void | RPC::callFunction (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2, T3 _t3, T4 _t4, T5 _t5)
| call a function in another plugin More...
Call functions across plugins which return a value
These templates can be used to call functions that return a value. You have to pass the type of return value as the first template parameter.
template<typename ReturnValue >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName)
| call a function in another plugin and get a return parameter More...
template<typename ReturnValue , typename T0 >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName, T0 _t0)
| call a function in another plugin and get a return parameter More...
template<typename ReturnValue , typename T0 , typename T1 >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName, T0 _t0, T1 _t1)
| call a function in another plugin and get a return parameter More...
template<typename ReturnValue , typename T0 , typename T1 , typename T2 >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2)
| call a function in another plugin and get a return parameter More...
template<typename ReturnValue , typename T0 , typename T1 , typename T2 , typename T3 >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2, T3 _t3)
| call a function in another plugin and get a return parameter More...
template<typename ReturnValue , typename T0 , typename T1 , typename T2 , typename T3 , typename T4 >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2, T3 _t3, T4 _t4)
| call a function in another plugin and get a return parameter More...
template<typename ReturnValue , typename T0 , typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
ReturnValue | RPC::callFunctionValue (QString _plugin, QString _functionName, T0 _t0, T1 _t1, T2 _t2, T3 _t3, T4 _t4, T5 _t5)
| call a function in another plugin and get a return parameter More...

## Detailed Description

This file contains functions to call functions and procedures across plugins. The QT Scripting system is used to pass the calls between different plugins.

Usage is described in RPC Interface

Definition in file RPCWrappers.hh.