![]() |
Murl Engine API
Version 2018.3
|
The IDeviceHandler interface. More...
#include <murl_output_i_device_handler.h>
The IDeviceHandler interface.
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... | |
|
pure virtual |
Initialize the device handler.
|
pure virtual |
Deinitialize the device handler.
|
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().
|
pure virtual |
Notification of changed configuration.
The notification is executed in the engine thread context if any configuration item has changed.
appConfig | The application configuration object. |
|
pure virtual |
Add a keyboard control object to the output device handler.
keyboardControl | The keyboard control object to add. |
|
pure virtual |
Remove a keyboard control object from the output device handler.
keyboardControl | The keyboard control object to remove. |
|
pure virtual |
Get a registered keyboard control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a application control object to the output device handler.
appControl | The application control object to add. |
|
pure virtual |
Remove a application control object from the output device handler.
appControl | The application control object to remove. |
|
pure virtual |
Get a registered application control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a rumble control object to the output device handler.
rumbleControl | The rumble control object to add. |
|
pure virtual |
Remove a rumble control object from the output device handler.
rumbleControl | The rumble control object to remove. |
|
pure virtual |
Get a registered rumble control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a app-store control object to the output device handler.
appStoreControl | The app-store control object to add. |
|
pure virtual |
Remove a app-store control object from the output device handler.
appStoreControl | The app-store control object to remove. |
|
pure virtual |
Get a registered app-store control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a cloud control object to the output device handler.
cloudControl | The cloud control object to add. |
|
pure virtual |
Remove a cloud control object from the output device handler.
cloudControl | The cloud control object to remove. |
|
pure virtual |
Get a registered cloud control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a game-center control object to the output device handler.
gameCenterControl | The game-center control object to add. |
|
pure virtual |
Remove a game-center control object from the output device handler.
gameCenterControl | The game-center control object to remove. |
|
pure virtual |
Get a registered game-center control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a system-dialog control object to the output device handler.
systemDialogControl | The system-dialog control object to add. |
|
pure virtual |
Remove a system-dialog control object from the output device handler.
systemDialogControl | The system-dialog control object to remove. |
|
pure virtual |
Get a registered system-dialog control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a system-font control object to the output device handler.
systemFontControl | The system-font control object to add. |
|
pure virtual |
Remove a system-font control object from the output device handler.
systemFontControl | The system-font control object to remove. |
|
pure virtual |
Get a registered system-font control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a web control object to the output device handler.
webControl | The web control object to add. |
|
pure virtual |
Remove a web control object from the output device handler.
webControl | The web control object to remove. |
|
pure virtual |
Get a registered web control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a screen-shot control object to the output device handler.
screenshotControl | The screen-shot control object to add. |
|
pure virtual |
Remove a screen-shot control object from the output device handler.
screenshotControl | The screen-shot control object to remove. |
|
pure virtual |
Get a registered screen-shot control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a preferences control object to the output device handler.
preferencesControl | The preferences control object to add. |
|
pure virtual |
Remove a preferences control object from the output device handler.
preferencesControl | The preferences control object to remove. |
|
pure virtual |
Get a registered preferences control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a telephony control object to the output device handler.
telephonyControl | The telephony control object to add. |
|
pure virtual |
Remove a telephony control object from the output device handler.
telephonyControl | The telephony control object to remove. |
|
pure virtual |
Get a registered telephony control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a media control object to the output device handler.
mediaControl | The media control object to add. |
|
pure virtual |
Remove a media control object from the output device handler.
mediaControl | The media control object to remove. |
|
pure virtual |
Get a registered media control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a music player control object to the output device handler.
musicPlayerControl | The music player control object to add. |
|
pure virtual |
Remove a music player control object from the output device handler.
musicPlayerControl | The music player control object to remove. |
|
pure virtual |
Get a registered music player control object.
index | The zero-based index of the control. |
|
pure virtual |
Add a custom control object to the output device handler.
The identifier of the custom control is the control's name.
customControl | The custom control object to add. |
|
pure virtual |
Add a custom control object to the output device handler.
name | The identifier of the custom control. |
customControl | The custom control object to add. |
|
pure virtual |
Remove a custom control object from the output device handler.
name | The identifier of the custom control to remove. |
|
pure virtual |
Remove a custom control object from the output device handler.
customControl | The custom control object to remove. |
|
pure virtual |
Get a registered custom control object by name.
name | The identifier of the custom control. |
|
pure virtual |
Get the number of registered custom controls.
|
pure virtual |
Get a registered custom control object by index.
A valid device index is [0 .. GetNumberOfCustomControls() - 1].
index | The zero-based index of the control. |