Detailed Description

Receives notifications when Widgets are added or removed.

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

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

When widgets are removed, the appropriate WidgetRemoved() method is called. The observer must not access the removed widget object once the call to WidgetRemoved() completes.

Inheritance diagram for ola::plugin::usbdmx::WidgetObserver:

Public Member Functions
virtual bool	NewWidget (class AnymauDMX *widget)=0
	Called when a new AnymauDMX is added.
virtual bool	NewWidget (class EurolitePro *widget)=0
	Called when a new EurolitePro is added.
virtual bool	NewWidget (class ScanlimeFadecandy *widget)=0
	Called when a new ScanlimeFadecandy is added.
virtual bool	NewWidget (class Sunlite *widget)=0
	Called when a new Sunlite is added.
virtual bool	NewWidget (class VellemanK8062 *widget)=0
	Called when a new VellemanK8062 is added.
virtual void	WidgetRemoved (class AnymauDMX *widget)=0
	Called when an AnymauDMX is removed.
virtual void	WidgetRemoved (class EurolitePro *widget)=0
	Called when a EurolitePro is removed.
virtual void	WidgetRemoved (class ScanlimeFadecandy *widget)=0
	Called when a ScanlimeFadecandy is removed.
virtual void	WidgetRemoved (class Sunlite *widget)=0
	Called when a Sunlite is removed.
virtual void	WidgetRemoved (class VellemanK8062 *widget)=0
	Called when a VellemanK8062 is removed.

Member Function Documentation

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

pure virtual

Called when a new AnymauDMX is added.

Parameters

widget the 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::SyncronizedWidgetObserver.

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

pure virtual

Called when a new EurolitePro is added.

Parameters

widget the 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::SyncronizedWidgetObserver.

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

pure virtual

Called when a new ScanlimeFadecandy is added.

Parameters

widget the 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::SyncronizedWidgetObserver.

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

pure virtual

Called when a new Sunlite is added.

Parameters

widget the 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::SyncronizedWidgetObserver.

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

pure virtual

Called when a new VellemanK8062 is added.

Parameters

widget the 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::SyncronizedWidgetObserver.

virtual void ola::plugin::usbdmx::WidgetObserver::WidgetRemoved ( class AnymauDMX * widget )

pure virtual

Called when an AnymauDMX is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

virtual void ola::plugin::usbdmx::WidgetObserver::WidgetRemoved ( class EurolitePro * widget )

pure virtual

Called when a EurolitePro is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

virtual void ola::plugin::usbdmx::WidgetObserver::WidgetRemoved ( class ScanlimeFadecandy * widget )

pure virtual

Called when a ScanlimeFadecandy is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

virtual void ola::plugin::usbdmx::WidgetObserver::WidgetRemoved ( class Sunlite * widget )

pure virtual

Called when a Sunlite is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

virtual void ola::plugin::usbdmx::WidgetObserver::WidgetRemoved ( class VellemanK8062 * widget )

pure virtual

Called when a VellemanK8062 is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

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

plugins/usbdmx/WidgetFactory.h

Detailed Description

Public Member Functions

Member Function Documentation