cc_tools_qt::PluginProperties Class Reference

#include "cc_tools_qt/PluginProperties.h"

Detailed Description

Accumulation of various properties of Plugin.

Public Types
using	ConfigWidgetCreateFunc = std::function< QWidget *()>
	Type of callback to be used when a widget responsible to configure the plugin needs to be allocated. The allocated widget will be owned by the application. The plugin won't need to delete it explicitly.
using	FiltersCreateFunc = std::function< ListOfFilters()>
	Type of callback to be used to allocate a Filter objects.
using	GuiActionsCreateFunc = std::function< ListOfGuiActions()>
	Type of callback to be used to allocate QAction to be displayed in the main toolbar of GUI application.
using	ListOfFilters = QList< FilterPtr >
	List of Filter objects.
using	ListOfGuiActions = QList< QAction * >
	List of dynamically allocated QAction objects.
using	ProtocolCreateFunc = std::function< ProtocolPtr()>
	Type of callback to be used to allocate a Protocol object.
using	SocketCreateFunc = std::function< SocketPtr()>
	Type of callback to be used to allocate a Socket object.

Public Member Functions
	PluginProperties ()
	Constructor.
	~PluginProperties () noexcept
	Destructor.
ConfigWidgetCreateFunc	getConfigWidgetCreateFunc () const
	Retrieve plugin configuration widget creation callback.
QVariant	getCustomProperty (const QString &name) const
	Get custom property.
FiltersCreateFunc	getFiltersCreateFunc () const
	Retrieve list of Filter creation callback.
GuiActionsCreateFunc	getGuiActionsCreateFunc () const
	Retrieve GUI Actions creation callback.
ProtocolCreateFunc	getProtocolCreateFunc () const
	Retrieve Protocol creation callback.
SocketCreateFunc	getSocketCreateFunc () const
	Retrieve Socket creation callback.
PluginProperties &	setConfigWidgetCreateFunc (ConfigWidgetCreateFunc &&func)
	Assign callback for configuration widget creation.
PluginProperties &	setCustomProperty (const QString &name, QVariant &&val)
	Set custom property.
PluginProperties &	setFiltersCreateFunc (FiltersCreateFunc &&func)
	Assign callback for Filter allocation.
PluginProperties &	setGuiActionsCreateFunc (GuiActionsCreateFunc &&func)
	Assign callback for list of QAction allocation.
PluginProperties &	setProtocolCreateFunc (ProtocolCreateFunc &&func)
	Assign callback for Protocol allocation.
PluginProperties &	setSocketCreateFunc (SocketCreateFunc &&func)
	Assign callback for Socket allocation.

Member Typedef Documentation

GuiActionsCreateFunc

using cc_tools_qt::PluginProperties::GuiActionsCreateFunc = std::function<ListOfGuiActions ()>

Type of callback to be used to allocate QAction to be displayed in the main toolbar of GUI application.

The allocated QAction objects will be owned by the application. The plugin won't need to delete them explicitly.

Member Function Documentation

getCustomProperty()

QVariant cc_tools_qt::PluginProperties::getCustomProperty

(

const QString &

name

)

const

Get custom property.

Parameters

[in]

name

Property name

Returns

Value of the property

setConfigWidgetCreateFunc()

PluginProperties & cc_tools_qt::PluginProperties::setConfigWidgetCreateFunc

(

ConfigWidgetCreateFunc &&

func

)

Assign callback for configuration widget creation.

Parameters

[in]

func

Callback function

Returns

*this

setCustomProperty()

PluginProperties & cc_tools_qt::PluginProperties::setCustomProperty	(	const QString &	name,
		QVariant &&	val
	)

Set custom property.

Parameters

[in]	name	Name of the property
[out]	val	Property value

setFiltersCreateFunc()

PluginProperties & cc_tools_qt::PluginProperties::setFiltersCreateFunc

(

FiltersCreateFunc &&

func

)

Assign callback for Filter allocation.

Parameters

[in]

func

Callback function

Returns

*this

setGuiActionsCreateFunc()

PluginProperties & cc_tools_qt::PluginProperties::setGuiActionsCreateFunc

(

GuiActionsCreateFunc &&

func

)

Assign callback for list of QAction allocation.

Parameters

[in]

func

Callback function

Returns

*this

setProtocolCreateFunc()

PluginProperties & cc_tools_qt::PluginProperties::setProtocolCreateFunc

(

ProtocolCreateFunc &&

func

)

Assign callback for Protocol allocation.

Parameters

[in]

func

Callback function

Returns

*this

setSocketCreateFunc()

PluginProperties & cc_tools_qt::PluginProperties::setSocketCreateFunc

(

SocketCreateFunc &&

func

)

Assign callback for Socket allocation.

Parameters

[in]

func

Callback function

Returns

*this

---

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

• lib/include/cc_tools_qt/PluginProperties.h