Open Lighting Architecture  Latest Git
Public Member Functions | List of all members
ola::plugin::usbdmx::WidgetObserver Class Referenceabstract

Detailed Description

Receives notifications when Widgets are added or removed.

Classes implementing the WidgetObserver can be used with WidgetFactories to receive notifications when widgets are added.

On adding a new Widget, the appropriate NewWidget() method is called. The observer can mark a widget as in-use by returning true.

Inheritance diagram for ola::plugin::usbdmx::WidgetObserver:
Inheritance graph
[legend]

Public Member Functions

virtual bool NewWidget (class AnymauDMX *widget)=0
 Called when a new AnymauDMX is added. More...
 
virtual bool NewWidget (class AVLdiyD512 *widget)=0
 Called when a new AVLdiyD512 is added. More...
 
virtual bool NewWidget (class DMXCProjectsNodleU1 *widget)=0
 Called when a new DMXCProjects Nodle U1 widget is added. More...
 
virtual bool NewWidget (class DMXCreator512Basic *widget)=0
 Called when a new DMXCreator512Basic is added. More...
 
virtual bool NewWidget (class EurolitePro *widget)=0
 Called when a new EurolitePro is added. More...
 
virtual bool NewWidget (class ShowJockeyDMXU1 *widget)=0
 Called when a new ShowJockeyDMXU1 is added. More...
 
virtual bool NewWidget (ola::usb::JaRuleWidget *widget)=0
 Called when a new Ja Rule widget is added. More...
 
virtual bool NewWidget (class ScanlimeFadecandy *widget)=0
 Called when a new ScanlimeFadecandy is added. More...
 
virtual bool NewWidget (class Sunlite *widget)=0
 Called when a new Sunlite is added. More...
 
virtual bool NewWidget (class VellemanK8062 *widget)=0
 Called when a new VellemanK8062 is added. More...
 

Member Function Documentation

◆ NewWidget() [1/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class AnymauDMX widget)
pure virtual

Called when a new AnymauDMX is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [2/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class AVLdiyD512 widget)
pure virtual

Called when a new AVLdiyD512 is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [3/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class DMXCProjectsNodleU1 widget)
pure virtual

Called when a new DMXCProjects Nodle U1 widget is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [4/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class DMXCreator512Basic widget)
pure virtual

Called when a new DMXCreator512Basic is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [5/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class EurolitePro widget)
pure virtual

Called when a new EurolitePro is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [6/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class ShowJockeyDMXU1 widget)
pure virtual

Called when a new ShowJockeyDMXU1 is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [7/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( ola::usb::JaRuleWidget widget)
pure virtual

Called when a new Ja Rule widget is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [8/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class ScanlimeFadecandy widget)
pure virtual

Called when a new ScanlimeFadecandy is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SyncPluginImpl, and ola::plugin::usbdmx::SynchronizedWidgetObserver.

◆ NewWidget() [9/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class Sunlite widget)
pure virtual

Called when a new Sunlite is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SynchronizedWidgetObserver, and ola::plugin::usbdmx::SyncPluginImpl.

◆ NewWidget() [10/10]

virtual bool ola::plugin::usbdmx::WidgetObserver::NewWidget ( class VellemanK8062 widget)
pure virtual

Called when a new VellemanK8062 is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implemented in ola::plugin::usbdmx::AsyncPluginImpl, ola::plugin::usbdmx::SynchronizedWidgetObserver, and ola::plugin::usbdmx::SyncPluginImpl.


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