Widgets::FactoryMethods Struct Reference

#include <widgets.hpp>

Collaboration diagram for Widgets::FactoryMethods:

Data Fields
std::unique_ptr< Widgets::Plugin >(*	createPlugin )(Event::Manager *) = nullptr
	Function that returns a smart pointer to plugin object. More...
std::unique_ptr< Widgets::Component >(*	createComponent )(Widgets::Plugin *)
Widgets::Panel *(*	createPanel )(QMainWindow *, Event::Manager *) = nullptr

Detailed Description

This structure contains functions for creating Widget instances.

This struct is used when loading and unloading RTXI modules. It allows RTXI to use the builder pattern for loading widgets by calling these functions to generate the widget specific classes, then using relevant assembly methods to put them together and display them.

Definition at line 134 of file widgets.hpp.

Field Documentation

createComponent

std::unique_ptr< Widgets::Component > Widgets::FactoryMethods::createComponent

Initial value:

=
nullptr

Parameters

event_manager

Raw pointer to Widgets::Plugin object

Returns

Smart pointer to component object

See also

Widgets::Component

Definition at line 118 of file widgets.hpp.

createPanel

Widgets::Panel * Widgets::FactoryMethods::createPanel = nullptr

returns the pointer

Parameters

window	QMainWindow pointer to attach the panel to
event_manager	Raw pointer to Event::Manager object

Returns

Widgets::Plugin pointer to created panel

See also

Widgets::Panel

Definition at line 170 of file widgets.hpp.

createPlugin

std::unique_ptr< Widgets::Plugin > Widgets::FactoryMethods::createPlugin = nullptr

Function that returns a smart pointer to plugin object.

Parameters

event_manager

Raw pointer to Event::Manager object

Returns

Smart pointer to plugin object

See also

Widgets::Plugin

Definition at line 118 of file widgets.hpp.

---

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

• src/widgets.hpp