Developer Documentation
PluginInfo Class Reference

#include <OpenFlipper/Core/PluginInfo.hh>

Public Types

enum  StatusType { LOADED = 0 , BLOCKED , UNLOADED , FAILED }
 current status of the plugin More...
 

Public Attributes

QObject * plugin
 Pointer to the loaded plugin (Already casted when loading it) More...
 
QString name
 Name of the plugin ( requested from the plugin on load) More...
 
QString description
 Description of the plugin ( requested from the plugin on load) More...
 
QString version
 Version of the plugin. More...
 
QString path
 Path to the plugin ( set on load ) More...
 
QString rpcName
 Clean rpc name of the plugin. More...
 
QString errors
 Store errors encountered during plugin loading. More...
 
QString warnings
 Store warnings encountered during plugin loading. More...
 
QStringList rpcFunctions
 List of exported rpc slots. More...
 
QList< SlotInfoslotInfos
 This list contains Descriptions about public slots if available. More...
 
QList< KeyBindingkeys
 List of registered keys with description. More...
 
std::vector< std::pair< QString, QWidget * > > toolboxWidgets
 Pointer to plugins toolbox widget (if available) More...
 
std::vector< std::pair< QString, QWidget * > > headerAreaWidgets
 Pointer to plugins header area widgets (if available) More...
 
std::vector< QIcon * > toolboxIcons
 Pointer to plugins toolbox widget icons (if available) More...
 
std::vector< std::pair< QString, QToolBar * > > toolbars
 Pointer to plugins toolbars (if available) More...
 
std::vector< std::pair< QString, QAction * > > contextMenus
 Pointer to plugins context menus (if available) More...
 
QWidget * optionsWidget
 Pointer to plugins options widget (if available) More...
 
bool buildIn
 Indicates, if the plugin is a built in Plugin (in Plugin directory) More...
 
enum PluginInfo::StatusType status
 

Detailed Description

Type defining a currently loaded Plugin

Definition at line 71 of file PluginInfo.hh.

Member Enumeration Documentation

◆ StatusType

current status of the plugin

Definition at line 153 of file PluginInfo.hh.

Constructor & Destructor Documentation

◆ PluginInfo()

PluginInfo::PluginInfo ( )
inline

Definition at line 75 of file PluginInfo.hh.

Member Data Documentation

◆ buildIn

bool PluginInfo::buildIn

Indicates, if the plugin is a built in Plugin (in Plugin directory)

Definition at line 150 of file PluginInfo.hh.

◆ contextMenus

std::vector< std::pair< QString , QAction* > > PluginInfo::contextMenus

Pointer to plugins context menus (if available)

Definition at line 144 of file PluginInfo.hh.

◆ description

QString PluginInfo::description

Description of the plugin ( requested from the plugin on load)

Definition at line 105 of file PluginInfo.hh.

◆ errors

QString PluginInfo::errors

Store errors encountered during plugin loading.

Definition at line 117 of file PluginInfo.hh.

◆ headerAreaWidgets

std::vector< std::pair< QString , QWidget* > > PluginInfo::headerAreaWidgets

Pointer to plugins header area widgets (if available)

Definition at line 135 of file PluginInfo.hh.

◆ keys

QList< KeyBinding > PluginInfo::keys

List of registered keys with description.

Definition at line 129 of file PluginInfo.hh.

◆ name

QString PluginInfo::name

Name of the plugin ( requested from the plugin on load)

Definition at line 102 of file PluginInfo.hh.

◆ optionsWidget

QWidget* PluginInfo::optionsWidget

Pointer to plugins options widget (if available)

Definition at line 147 of file PluginInfo.hh.

◆ path

QString PluginInfo::path

Path to the plugin ( set on load )

Definition at line 111 of file PluginInfo.hh.

◆ plugin

QObject* PluginInfo::plugin

Pointer to the loaded plugin (Already casted when loading it)

Definition at line 99 of file PluginInfo.hh.

◆ rpcFunctions

QStringList PluginInfo::rpcFunctions

List of exported rpc slots.

Definition at line 123 of file PluginInfo.hh.

◆ rpcName

QString PluginInfo::rpcName

Clean rpc name of the plugin.

Definition at line 114 of file PluginInfo.hh.

◆ slotInfos

QList< SlotInfo > PluginInfo::slotInfos

This list contains Descriptions about public slots if available.

Definition at line 126 of file PluginInfo.hh.

◆ toolbars

std::vector< std::pair< QString , QToolBar* > > PluginInfo::toolbars

Pointer to plugins toolbars (if available)

Definition at line 141 of file PluginInfo.hh.

◆ toolboxIcons

std::vector< QIcon* > PluginInfo::toolboxIcons

Pointer to plugins toolbox widget icons (if available)

Definition at line 138 of file PluginInfo.hh.

◆ toolboxWidgets

std::vector< std::pair< QString , QWidget* > > PluginInfo::toolboxWidgets

Pointer to plugins toolbox widget (if available)

Definition at line 132 of file PluginInfo.hh.

◆ version

QString PluginInfo::version

Version of the plugin.

Definition at line 108 of file PluginInfo.hh.

◆ warnings

QString PluginInfo::warnings

Store warnings encountered during plugin loading.

Definition at line 120 of file PluginInfo.hh.


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