#include <murl_output_i_device_handler.h>

Detailed Description

The device handler registers all control device instances created by the platform or the application.

Inherited by Murl::Output::DeviceHandler.

Public Member Functions
virtual Bool	Init ()=0
	Initialize the device handler. More...

virtual Bool	DeInit ()=0
	Deinitialize the device handler. More...

virtual Bool	UpdateDevices ()=0
	Update all registered devices. More...

virtual void	ConfigChanged (const IAppConfiguration *appConfig)=0
	Notification of changed configuration. More...

virtual Bool	AddKeyboardControl (IKeyboardControl *keyboardControl)=0
	Add a keyboard control object to the output device handler. More...

virtual Bool	RemoveKeyboardControl (const IKeyboardControl *keyboardControl)=0
	Remove a keyboard control object from the output device handler. More...

virtual IKeyboardControl *	GetKeyboardControl (UInt32 index=0) const =0
	Get a registered keyboard control object. More...

virtual Bool	AddAppControl (IAppControl *appControl)=0
	Add a application control object to the output device handler. More...

virtual Bool	RemoveAppControl (const IAppControl *appControl)=0
	Remove a application control object from the output device handler. More...

virtual IAppControl *	GetAppControl (UInt32 index=0) const =0
	Get a registered application control object. More...

virtual Bool	AddRumbleControl (IRumbleControl *rumbleControl)=0
	Add a rumble control object to the output device handler. More...

virtual Bool	RemoveRumbleControl (const IRumbleControl *rumbleControl)=0
	Remove a rumble control object from the output device handler. More...

virtual IRumbleControl *	GetRumbleControl (UInt32 index=0) const =0
	Get a registered rumble control object. More...

virtual Bool	AddAppStoreControl (IAppStoreControl *appStoreControl)=0
	Add a app-store control object to the output device handler. More...

virtual Bool	RemoveAppStoreControl (const IAppStoreControl *appStoreControl)=0
	Remove a app-store control object from the output device handler. More...

virtual IAppStoreControl *	GetAppStoreControl (UInt32 index=0) const =0
	Get a registered app-store control object. More...

virtual Bool	AddCloudControl (ICloudControl *cloudControl)=0
	Add a cloud control object to the output device handler. More...

virtual Bool	RemoveCloudControl (const ICloudControl *cloudControl)=0
	Remove a cloud control object from the output device handler. More...

virtual ICloudControl *	GetCloudControl (UInt32 index=0) const =0
	Get a registered cloud control object. More...

virtual Bool	AddGameCenterControl (IGameCenterControl *gameCenterControl)=0
	Add a game-center control object to the output device handler. More...

virtual Bool	RemoveGameCenterControl (const IGameCenterControl *gameCenterControl)=0
	Remove a game-center control object from the output device handler. More...

virtual IGameCenterControl *	GetGameCenterControl (UInt32 index=0) const =0
	Get a registered game-center control object. More...

virtual Bool	AddSystemDialogControl (ISystemDialogControl *systemDialogControl)=0
	Add a system-dialog control object to the output device handler. More...

virtual Bool	RemoveSystemDialogControl (const ISystemDialogControl *systemDialogControl)=0
	Remove a system-dialog control object from the output device handler. More...

virtual ISystemDialogControl *	GetSystemDialogControl (UInt32 index=0) const =0
	Get a registered system-dialog control object. More...

virtual Bool	AddSystemFontControl (ISystemFontControl *systemFontControl)=0
	Add a system-font control object to the output device handler. More...

virtual Bool	RemoveSystemFontControl (const ISystemFontControl *systemFontControl)=0
	Remove a system-font control object from the output device handler. More...

virtual ISystemFontControl *	GetSystemFontControl (UInt32 index=0) const =0
	Get a registered system-font control object. More...

virtual Bool	AddWebControl (IWebControl *webControl)=0
	Add a web control object to the output device handler. More...

virtual Bool	RemoveWebControl (const IWebControl *webControl)=0
	Remove a web control object from the output device handler. More...

virtual IWebControl *	GetWebControl (UInt32 index=0) const =0
	Get a registered web control object. More...

virtual Bool	AddScreenshotControl (IScreenshotControl *screenshotControl)=0
	Add a screen-shot control object to the output device handler. More...

virtual Bool	RemoveScreenshotControl (const IScreenshotControl *screenshotControl)=0
	Remove a screen-shot control object from the output device handler. More...

virtual IScreenshotControl *	GetScreenshotControl (UInt32 index=0) const =0
	Get a registered screen-shot control object. More...

virtual Bool	AddPreferencesControl (IPreferencesControl *preferencesControl)=0
	Add a preferences control object to the output device handler. More...

virtual Bool	RemovePreferencesControl (const IPreferencesControl *preferencesControl)=0
	Remove a preferences control object from the output device handler. More...

virtual IPreferencesControl *	GetPreferencesControl (UInt32 index=0) const =0
	Get a registered preferences control object. More...

virtual Bool	AddTelephonyControl (ITelephonyControl *telephonyControl)=0
	Add a telephony control object to the output device handler. More...

virtual Bool	RemoveTelephonyControl (const ITelephonyControl *telephonyControl)=0
	Remove a telephony control object from the output device handler. More...

virtual ITelephonyControl *	GetTelephonyControl (UInt32 index=0) const =0
	Get a registered telephony control object. More...

virtual Bool	AddMediaControl (IMediaControl *mediaControl)=0
	Add a media control object to the output device handler. More...

virtual Bool	RemoveMediaControl (const IMediaControl *mediaControl)=0
	Remove a media control object from the output device handler. More...

virtual IMediaControl *	GetMediaControl (UInt32 index=0) const =0
	Get a registered media control object. More...

virtual Bool	AddMusicPlayerControl (IMusicPlayerControl *musicPlayerControl)=0
	Add a music player control object to the output device handler. More...

virtual Bool	RemoveMusicPlayerControl (const IMusicPlayerControl *musicPlayerControl)=0
	Remove a music player control object from the output device handler. More...

virtual IMusicPlayerControl *	GetMusicPlayerControl (UInt32 index=0) const =0
	Get a registered music player control object. More...

virtual Bool	AddCustomControl (ICustomControlable *customControl)=0
	Add a custom control object to the output device handler. More...

virtual Bool	AddCustomControl (const String &name, ICustomControlable *customControl)=0
	Add a custom control object to the output device handler. More...

virtual ICustomControlable *	RemoveCustomControl (const String &name)=0
	Remove a custom control object from the output device handler. More...

virtual Bool	RemoveCustomControl (const ICustomControlable *customControl)=0
	Remove a custom control object from the output device handler. More...

virtual ICustomControlable *	GetCustomControl (const String &name) const =0
	Get a registered custom control object by name. More...

virtual UInt32	GetNumberOfCustomControls () const =0
	Get the number of registered custom controls. More...

virtual ICustomControlable *	GetCustomControl (UInt32 index) const =0
	Get a registered custom control object by index. More...

Member Function Documentation

◆ Init()

virtual Bool Murl::Output::IDeviceHandler::Init ( )

pure virtual

Initialize the device handler.

Returns: true if successful.

◆ DeInit()

virtual Bool Murl::Output::IDeviceHandler::DeInit ( )

pure virtual

Deinitialize the device handler.

Returns: true if successful.

◆ UpdateDevices()

virtual Bool Murl::Output::IDeviceHandler::UpdateDevices ( )

pure virtual

Update all registered devices.

The update is executed in the logic thread context each logic tick after executing the logic processors Logic::IEngineProcessor::ProcessTick().

Returns: true if successful.

◆ ConfigChanged()

virtual void Murl::Output::IDeviceHandler::ConfigChanged ( const IAppConfiguration * appConfig )

pure virtual

Notification of changed configuration.

The notification is executed in the engine thread context if any configuration item has changed.

Parameters

appConfig The application configuration object.

◆ AddKeyboardControl()

virtual Bool Murl::Output::IDeviceHandler::AddKeyboardControl ( IKeyboardControl * keyboardControl )

pure virtual

Add a keyboard control object to the output device handler.

Parameters

keyboardControl The keyboard control object to add.

Returns: true if successful.

◆ RemoveKeyboardControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveKeyboardControl ( const IKeyboardControl * keyboardControl )

pure virtual

Remove a keyboard control object from the output device handler.

Parameters

keyboardControl The keyboard control object to remove.

Returns: true if successful.

◆ GetKeyboardControl()

virtual IKeyboardControl* Murl::Output::IDeviceHandler::GetKeyboardControl ( UInt32 index = 0 ) const

pure virtual

Get a registered keyboard control object.

Parameters

index The zero-based index of the control.

Returns: The keyboard control object or null if the index is out of range.

◆ AddAppControl()

virtual Bool Murl::Output::IDeviceHandler::AddAppControl ( IAppControl * appControl )

pure virtual

Add a application control object to the output device handler.

Parameters

appControl The application control object to add.

Returns: true if successful.

◆ RemoveAppControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveAppControl ( const IAppControl * appControl )

pure virtual

Remove a application control object from the output device handler.

Parameters

appControl The application control object to remove.

Returns: true if successful.

◆ GetAppControl()

virtual IAppControl* Murl::Output::IDeviceHandler::GetAppControl ( UInt32 index = 0 ) const

pure virtual

Get a registered application control object.

Parameters

index The zero-based index of the control.

Returns: The application control object or null if the index is out of range.

◆ AddRumbleControl()

virtual Bool Murl::Output::IDeviceHandler::AddRumbleControl ( IRumbleControl * rumbleControl )

pure virtual

Add a rumble control object to the output device handler.

Parameters

rumbleControl The rumble control object to add.

Returns: true if successful.

◆ RemoveRumbleControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveRumbleControl ( const IRumbleControl * rumbleControl )

pure virtual

Remove a rumble control object from the output device handler.

Parameters

rumbleControl The rumble control object to remove.

Returns: true if successful.

◆ GetRumbleControl()

virtual IRumbleControl* Murl::Output::IDeviceHandler::GetRumbleControl ( UInt32 index = 0 ) const

pure virtual

Get a registered rumble control object.

Parameters

index The zero-based index of the control.

Returns: The rumble control object or null if the index is out of range.

◆ AddAppStoreControl()

virtual Bool Murl::Output::IDeviceHandler::AddAppStoreControl ( IAppStoreControl * appStoreControl )

pure virtual

Add a app-store control object to the output device handler.

Parameters

appStoreControl The app-store control object to add.

Returns: true if successful.

◆ RemoveAppStoreControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveAppStoreControl ( const IAppStoreControl * appStoreControl )

pure virtual

Remove a app-store control object from the output device handler.

Parameters

appStoreControl The app-store control object to remove.

Returns: true if successful.

◆ GetAppStoreControl()

virtual IAppStoreControl* Murl::Output::IDeviceHandler::GetAppStoreControl ( UInt32 index = 0 ) const

pure virtual

Get a registered app-store control object.

Parameters

index The zero-based index of the control.

Returns: The app-store control object or null if the index is out of range.

◆ AddCloudControl()

virtual Bool Murl::Output::IDeviceHandler::AddCloudControl ( ICloudControl * cloudControl )

pure virtual

Add a cloud control object to the output device handler.

Parameters

cloudControl The cloud control object to add.

Returns: true if successful.

◆ RemoveCloudControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveCloudControl ( const ICloudControl * cloudControl )

pure virtual

Remove a cloud control object from the output device handler.

Parameters

cloudControl The cloud control object to remove.

Returns: true if successful.

◆ GetCloudControl()

virtual ICloudControl* Murl::Output::IDeviceHandler::GetCloudControl ( UInt32 index = 0 ) const

pure virtual

Get a registered cloud control object.

Parameters

index The zero-based index of the control.

Returns: The cloud control object or null if the index is out of range.

◆ AddGameCenterControl()

virtual Bool Murl::Output::IDeviceHandler::AddGameCenterControl ( IGameCenterControl * gameCenterControl )

pure virtual

Add a game-center control object to the output device handler.

Parameters

gameCenterControl The game-center control object to add.

Returns: true if successful.

◆ RemoveGameCenterControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveGameCenterControl ( const IGameCenterControl * gameCenterControl )

pure virtual

Remove a game-center control object from the output device handler.

Parameters

gameCenterControl The game-center control object to remove.

Returns: true if successful.

◆ GetGameCenterControl()

virtual IGameCenterControl* Murl::Output::IDeviceHandler::GetGameCenterControl ( UInt32 index = 0 ) const

pure virtual

Get a registered game-center control object.

Parameters

index The zero-based index of the control.

Returns: The game-center control object or null if the index is out of range.

◆ AddSystemDialogControl()

virtual Bool Murl::Output::IDeviceHandler::AddSystemDialogControl ( ISystemDialogControl * systemDialogControl )

pure virtual

Add a system-dialog control object to the output device handler.

Parameters

systemDialogControl The system-dialog control object to add.

Returns: true if successful.

◆ RemoveSystemDialogControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveSystemDialogControl ( const ISystemDialogControl * systemDialogControl )

pure virtual

Remove a system-dialog control object from the output device handler.

Parameters

systemDialogControl The system-dialog control object to remove.

Returns: true if successful.

◆ GetSystemDialogControl()

virtual ISystemDialogControl* Murl::Output::IDeviceHandler::GetSystemDialogControl ( UInt32 index = 0 ) const

pure virtual

Get a registered system-dialog control object.

Parameters

index The zero-based index of the control.

Returns: The system-dialog control object or null if the index is out of range.

◆ AddSystemFontControl()

virtual Bool Murl::Output::IDeviceHandler::AddSystemFontControl ( ISystemFontControl * systemFontControl )

pure virtual

Add a system-font control object to the output device handler.

Parameters

systemFontControl The system-font control object to add.

Returns: true if successful.

◆ RemoveSystemFontControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveSystemFontControl ( const ISystemFontControl * systemFontControl )

pure virtual

Remove a system-font control object from the output device handler.

Parameters

systemFontControl The system-font control object to remove.

Returns: true if successful.

◆ GetSystemFontControl()

virtual ISystemFontControl* Murl::Output::IDeviceHandler::GetSystemFontControl ( UInt32 index = 0 ) const

pure virtual

Get a registered system-font control object.

Parameters

index The zero-based index of the control.

Returns: The system-font control object or null if the index is out of range.

◆ AddWebControl()

virtual Bool Murl::Output::IDeviceHandler::AddWebControl ( IWebControl * webControl )

pure virtual

Add a web control object to the output device handler.

Parameters

webControl The web control object to add.

Returns: true if successful.

◆ RemoveWebControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveWebControl ( const IWebControl * webControl )

pure virtual

Remove a web control object from the output device handler.

Parameters

webControl The web control object to remove.

Returns: true if successful.

◆ GetWebControl()

virtual IWebControl* Murl::Output::IDeviceHandler::GetWebControl ( UInt32 index = 0 ) const

pure virtual

Get a registered web control object.

Parameters

index The zero-based index of the control.

Returns: The web control object or null if the index is out of range.

◆ AddScreenshotControl()

virtual Bool Murl::Output::IDeviceHandler::AddScreenshotControl ( IScreenshotControl * screenshotControl )

pure virtual

Add a screen-shot control object to the output device handler.

Parameters

screenshotControl The screen-shot control object to add.

Returns: true if successful.

◆ RemoveScreenshotControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveScreenshotControl ( const IScreenshotControl * screenshotControl )

pure virtual

Remove a screen-shot control object from the output device handler.

Parameters

screenshotControl The screen-shot control object to remove.

Returns: true if successful.

◆ GetScreenshotControl()

virtual IScreenshotControl* Murl::Output::IDeviceHandler::GetScreenshotControl ( UInt32 index = 0 ) const

pure virtual

Get a registered screen-shot control object.

Parameters

index The zero-based index of the control.

Returns: The screen-shot control object or null if the index is out of range.

◆ AddPreferencesControl()

virtual Bool Murl::Output::IDeviceHandler::AddPreferencesControl ( IPreferencesControl * preferencesControl )

pure virtual

Add a preferences control object to the output device handler.

Parameters

preferencesControl The preferences control object to add.

Returns: true if successful.

◆ RemovePreferencesControl()

virtual Bool Murl::Output::IDeviceHandler::RemovePreferencesControl ( const IPreferencesControl * preferencesControl )

pure virtual

Remove a preferences control object from the output device handler.

Parameters

preferencesControl The preferences control object to remove.

Returns: true if successful.

◆ GetPreferencesControl()

virtual IPreferencesControl* Murl::Output::IDeviceHandler::GetPreferencesControl ( UInt32 index = 0 ) const

pure virtual

Get a registered preferences control object.

Parameters

index The zero-based index of the control.

Returns: The preferences control object or null if the index is out of range.

◆ AddTelephonyControl()

virtual Bool Murl::Output::IDeviceHandler::AddTelephonyControl ( ITelephonyControl * telephonyControl )

pure virtual

Add a telephony control object to the output device handler.

Parameters

telephonyControl The telephony control object to add.

Returns: true if successful.

◆ RemoveTelephonyControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveTelephonyControl ( const ITelephonyControl * telephonyControl )

pure virtual

Remove a telephony control object from the output device handler.

Parameters

telephonyControl The telephony control object to remove.

Returns: true if successful.

◆ GetTelephonyControl()

virtual ITelephonyControl* Murl::Output::IDeviceHandler::GetTelephonyControl ( UInt32 index = 0 ) const

pure virtual

Get a registered telephony control object.

Parameters

index The zero-based index of the control.

Returns: The telephony control object or null if the index is out of range.

◆ AddMediaControl()

virtual Bool Murl::Output::IDeviceHandler::AddMediaControl ( IMediaControl * mediaControl )

pure virtual

Add a media control object to the output device handler.

Parameters

mediaControl The media control object to add.

Returns: true if successful.

◆ RemoveMediaControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveMediaControl ( const IMediaControl * mediaControl )

pure virtual

Remove a media control object from the output device handler.

Parameters

mediaControl The media control object to remove.

Returns: true if successful.

◆ GetMediaControl()

virtual IMediaControl* Murl::Output::IDeviceHandler::GetMediaControl ( UInt32 index = 0 ) const

pure virtual

Get a registered media control object.

Parameters

index The zero-based index of the control.

Returns: The media control object or null if the index is out of range.

◆ AddMusicPlayerControl()

virtual Bool Murl::Output::IDeviceHandler::AddMusicPlayerControl ( IMusicPlayerControl * musicPlayerControl )

pure virtual

Add a music player control object to the output device handler.

Parameters

musicPlayerControl The music player control object to add.

Returns: true if successful.

◆ RemoveMusicPlayerControl()

virtual Bool Murl::Output::IDeviceHandler::RemoveMusicPlayerControl ( const IMusicPlayerControl * musicPlayerControl )

pure virtual

Remove a music player control object from the output device handler.

Parameters

musicPlayerControl The music player control object to remove.

Returns: true if successful.

◆ GetMusicPlayerControl()

virtual IMusicPlayerControl* Murl::Output::IDeviceHandler::GetMusicPlayerControl ( UInt32 index = 0 ) const

pure virtual

Get a registered music player control object.

Parameters

index The zero-based index of the control.

Returns: The music player control object or null if the index is out of range.

◆ AddCustomControl() [1/2]

virtual Bool Murl::Output::IDeviceHandler::AddCustomControl ( ICustomControlable * customControl )

pure virtual

Add a custom control object to the output device handler.

The identifier of the custom control is the control's name.

Parameters

customControl The custom control object to add.

Returns: true if successful.

◆ AddCustomControl() [2/2]

virtual Bool Murl::Output::IDeviceHandler::AddCustomControl	(	const String &	name,
		ICustomControlable *	customControl
	)

pure virtual

Add a custom control object to the output device handler.

Parameters

name	The identifier of the custom control.
customControl	The custom control object to add.

Returns: true if successful.

◆ RemoveCustomControl() [1/2]

virtual ICustomControlable* Murl::Output::IDeviceHandler::RemoveCustomControl ( const String & name )

pure virtual

Remove a custom control object from the output device handler.

Parameters

name	The identifier of the custom control to remove.

Returns: The removed custom control object.

◆ RemoveCustomControl() [2/2]

virtual Bool Murl::Output::IDeviceHandler::RemoveCustomControl ( const ICustomControlable * customControl )

pure virtual

Remove a custom control object from the output device handler.

Parameters

customControl The custom control object to remove.

Returns: true if successful.

◆ GetCustomControl() [1/2]

virtual ICustomControlable* Murl::Output::IDeviceHandler::GetCustomControl ( const String & name ) const

pure virtual

Get a registered custom control object by name.

Parameters

name	The identifier of the custom control.

Returns: The custom control object or null if the identifier is not found.

◆ GetNumberOfCustomControls()

virtual UInt32 Murl::Output::IDeviceHandler::GetNumberOfCustomControls ( ) const

pure virtual

Get the number of registered custom controls.

Returns: The number of registered custom controls.

◆ GetCustomControl() [2/2]

virtual ICustomControlable* Murl::Output::IDeviceHandler::GetCustomControl ( UInt32 index ) const

pure virtual

Get a registered custom control object by index.

A valid device index is [0 .. GetNumberOfCustomControls() - 1].

Parameters

index The zero-based index of the control.

Returns: The custom control object or null if the index is out of range.

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

murl_output_i_device_handler.h

Detailed Description

Public Member Functions

Member Function Documentation

◆ Init()

◆ DeInit()

◆ UpdateDevices()

◆ ConfigChanged()

◆ AddKeyboardControl()

◆ RemoveKeyboardControl()

◆ GetKeyboardControl()

◆ AddAppControl()

◆ RemoveAppControl()

◆ GetAppControl()

◆ AddRumbleControl()

◆ RemoveRumbleControl()

◆ GetRumbleControl()

◆ AddAppStoreControl()

◆ RemoveAppStoreControl()

◆ GetAppStoreControl()

◆ AddCloudControl()

◆ RemoveCloudControl()

◆ GetCloudControl()

◆ AddGameCenterControl()

◆ RemoveGameCenterControl()

◆ GetGameCenterControl()

◆ AddSystemDialogControl()

◆ RemoveSystemDialogControl()

◆ GetSystemDialogControl()

◆ AddSystemFontControl()

◆ RemoveSystemFontControl()

◆ GetSystemFontControl()

◆ AddWebControl()

◆ RemoveWebControl()

◆ GetWebControl()

◆ AddScreenshotControl()

◆ RemoveScreenshotControl()

◆ GetScreenshotControl()

◆ AddPreferencesControl()

◆ RemovePreferencesControl()

◆ GetPreferencesControl()

◆ AddTelephonyControl()

◆ RemoveTelephonyControl()

◆ GetTelephonyControl()

◆ AddMediaControl()

◆ RemoveMediaControl()

◆ GetMediaControl()

◆ AddMusicPlayerControl()

◆ RemoveMusicPlayerControl()

◆ GetMusicPlayerControl()

◆ AddCustomControl() [1/2]

◆ AddCustomControl() [2/2]

◆ RemoveCustomControl() [1/2]

◆ RemoveCustomControl() [2/2]

◆ GetCustomControl() [1/2]

◆ GetNumberOfCustomControls()

◆ GetCustomControl() [2/2]