BPS C++ API  2.24.4
BpsApplicationPlugin Class Referenceabstract

Virtual class for application plugin of BPS Workplace. More...

#include <bpsapplicationplugin.h>

Public Member Functions

virtual QWidgetcreateWidget ()=0
 Create the application widget and return a pointer to it. More...
 
virtual QString groupText () const =0
 
virtual QIcon icon () const
 
virtual bool init (BpsDatastore *aDatastore)=0
 Initialize the plugin. More...
 
virtual QString text () const =0
 
virtual QString toolTip () const
 
virtual ~BpsApplicationPlugin ()
 Default destructor to satisfy compiler in case the plugin implementation does not declare a destructor.
 

Detailed Description

Virtual class for application plugin of BPS Workplace.

Member Function Documentation

◆ createWidget()

virtual QWidget* BpsApplicationPlugin::createWidget ( )
pure virtual

Create the application widget and return a pointer to it.

The returned widget must be one of BpsApplicationWindow or BpsApplicationWizard.

Returns
Pointer to new window.

◆ groupText()

virtual QString BpsApplicationPlugin::groupText ( ) const
pure virtual
Returns
Text for the application group QAction.

◆ icon()

virtual QIcon BpsApplicationPlugin::icon ( ) const
virtual
Returns
Icon for the application QAction.

◆ init()

virtual bool BpsApplicationPlugin::init ( BpsDatastore aDatastore)
pure virtual

Initialize the plugin.

This method will be called at first after loading the plugin to check if the plugin shall be included in the start menu of the BPS Workplace. It is not recommended to do comprehensive initializations here, because the user might never use the plugin during the session. Instead you should defer such activities until widget() is called.

Parameters
aDatastoreThe datastore object used by the BPS Workplace.
Returns
True if plugin is ok to be included in the start menu. False when plugin is not active, for example because of missing user permission or an unlicensed product.

◆ text()

virtual QString BpsApplicationPlugin::text ( ) const
pure virtual
Returns
Text for the application QAction.

◆ toolTip()

virtual QString BpsApplicationPlugin::toolTip ( ) const
virtual
Returns
Tool tip for the application QAction.

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