BPS C++ API  2.24.4
BpsAccessPlugin Class Referenceabstract

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

#include <bpsaccessplugin.h>

Public Member Functions

virtual BpsAccessWidgetcreateWidget (QWidget *aParent=nullptr)=0
 Create the widget application main window and return a pointer to it. More...
 
virtual bool init (BpsDatastore *aDatastore)=0
 Initialize the plugin. More...
 
virtual ~BpsAccessPlugin ()
 Virtual destructor.
 

Related Functions

(Note that these are not member functions.)

#define BpsAccessPlugin_IID   "com.ibk-software.BPS2.BpsAccessPlugin/1.0"
 IID of the plugin.
 

Detailed Description

Virtual class for application plugin of BPS Workplace.

Place the dynamic library in the plugins/bpsacc folder.

Member Function Documentation

◆ createWidget()

virtual BpsAccessWidget* BpsAccessPlugin::createWidget ( QWidget aParent = nullptr)
pure virtual

Create the widget application main window and return a pointer to it.

The widget will be deleted by the application when no longer used.

Parameters
aParentThe parent widget.
Returns
Pointer to the new widget.

◆ init()

virtual bool BpsAccessPlugin::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 groups application. 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 createWidget() is called, or if applicable even later in the methods of the widget.

Parameters
aDatastoreThe datastore object used by the application.
Returns
True if plugin is ok to be used. False when plugin is not active, for example because of missing user permission or a unlicensed product.

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