Ignition Gui

API Reference

4.1.1

Base class for Ignition GUI plugins. More...

#include <Plugin.hh>

Public Member Functions

 Plugin ()
 Constructor. More...
 
virtual ~Plugin ()
 Destructor. More...
 
QQuickItem * CardItem () const
 Get the card item which contains this plugin. The item is generated the first time this function is run. More...
 
virtual std::string ConfigStr ()
 Get the configuration XML as a string. More...
 
QQmlContext * Context () const
 Get the QML context where the plugin was created. More...
 
bool DeleteLaterRequested () const
 Get the value of the the delete_later element from the configuration file, which defaults to false. More...
 
void Load (const tinyxml2::XMLElement *_pluginElem)
 Load the plugin with a configuration file. This loads the default parameters and then calls LoadConfig(), which should be overridden to load custom parameters. More...
 
QQuickItem * PluginItem () const
 Get the plugin item. More...
 
void PostParentChanges ()
 Apply changes which should come after the plugin already has a parent. More...
 
virtual std::string Title () const
 Get title. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Protected Member Functions

void DeleteLater ()
 Wait until the plugin has a parent, then close and delete the parent. More...
 
virtual void LoadConfig (const tinyxml2::XMLElement *)
 Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations. More...
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

std::string configStr
 XML configuration. More...
 
std::string title = ""
 Title to be displayed on top of plugin. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Base class for Ignition GUI plugins.

When inheriting from this plugin, the following are assumed:

  • The derived class' name is the same as the generated shared library (i.e. if the Publisher class extends Plugin, the library file is libPublisher.so)
  • There is a QML file with the same name as the plugin's shared library name. (i.e. there must be a Publisher.qml)
  • The QML file is prefixed by the library's name in the QRC file (i.e. the file's resource is found at ':/Publisher/Publisher.qml')

Constructor & Destructor Documentation

◆ Plugin()

Plugin ( )

Constructor.

◆ ~Plugin()

virtual ~Plugin ( )
virtual

Destructor.

Member Function Documentation

◆ CardItem()

QQuickItem* CardItem ( ) const

Get the card item which contains this plugin. The item is generated the first time this function is run.

Returns
Pointer to card item.

◆ ConfigStr()

virtual std::string ConfigStr ( )
virtual

Get the configuration XML as a string.

Returns
Config element

◆ Context()

QQmlContext* Context ( ) const

Get the QML context where the plugin was created.

Returns
Pointer context.

◆ DeleteLater()

void DeleteLater ( )
protected

Wait until the plugin has a parent, then close and delete the parent.

Referenced by Plugin::Title().

◆ DeleteLaterRequested()

bool DeleteLaterRequested ( ) const

Get the value of the the delete_later element from the configuration file, which defaults to false.

Returns
The value of delete_later.

Referenced by Plugin::Title().

◆ Load()

void Load ( const tinyxml2::XMLElement *  _pluginElem)

Load the plugin with a configuration file. This loads the default parameters and then calls LoadConfig(), which should be overridden to load custom parameters.

Called when a plugin is first created. This function should not be blocking.

See also
Load
Parameters
[in]_pluginElemElement containing configuration

◆ LoadConfig()

virtual void LoadConfig ( const tinyxml2::XMLElement *  )
inlineprotectedvirtual

Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations.

Called when a plugin is first created. This function should not be blocking.

See also
Load
Parameters
[in]_pluginElemElement containing configuration

Reimplemented in WorldStats, Publisher, WorldControl, Scene3D, TopicEcho, Grid3D, ImageDisplay, TopicViewer, KeyPublisher, and TransportPlotting.

◆ PluginItem()

QQuickItem* PluginItem ( ) const

Get the plugin item.

Returns
Pointer to plugin item.

◆ PostParentChanges()

void PostParentChanges ( )

Apply changes which should come after the plugin already has a parent.

◆ Title()

virtual std::string Title ( ) const
inlinevirtual

Get title.

Returns
Plugin title.

References Plugin::DeleteLater(), Plugin::DeleteLaterRequested(), and Plugin::title.

Member Data Documentation

◆ configStr

std::string configStr
protected

XML configuration.

◆ title

std::string title = ""
protected

Title to be displayed on top of plugin.

Referenced by Plugin::Title().


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