![]() |
Murl Engine API
Version 2018.3
|
The ICustomControlable interface. More...
#include <murl_i_custom_controlable.h>
The ICustomControlable interface.
The ICustomControlable is the base class for implementing custom control objects which can be registered to the Output::IDeviceHandler.
Public Member Functions | |
virtual Bool | Init (IPlatform *platform)=0 |
Initialize the control. More... | |
virtual Bool | DeInit ()=0 |
De-initialize the control. More... | |
virtual void | PauseEngine ()=0 |
The engine is paused. More... | |
virtual void | ContinueEngine ()=0 |
The engine is continued. More... | |
virtual void | SuspendEngine ()=0 |
The engine is suspended. More... | |
virtual void | ResumeEngine ()=0 |
The engine is resumed. More... | |
![]() | |
virtual const String & | GetName () const =0 |
Get the controlable's name. More... | |
virtual void | FrameUpdate ()=0 |
Is executed in the platform thread context each frame tick. | |
virtual void | LogicUpdate ()=0 |
Is executed in the logic thread context each logic tick. | |
virtual void | ConfigChanged (const IAppConfiguration *appConfig)=0 |
Notification of changed configuration. More... | |
iOS / OSX application delegates | |
Application delegate methods are called by iOS and OSX platform only. CustomControlable implementations for other platforms should leave these methods empty. | |
enum | FetchResult { FETCHRESULT_NONE, FETCHRESULT_NEWDATA, FETCHRESULT_NODATA, FETCHRESULT_FAILED } |
Enumeration to indicate the result of a background fetch operation. More... | |
virtual Bool | AppFinishLaunching (void *launchOptions)=0 |
The app application did finish launching. More... | |
virtual Bool | AppOpenURL (String url, String sourceApplication, void *annotation)=0 |
The application is opened by an url. More... | |
virtual Bool | AppOpenURL (String url, void *options)=0 |
The application is opened by an url with options. More... | |
virtual void | AppReceiveNotification (void *notification)=0 |
The application received a local notification. More... | |
virtual void | AppRegisterForRemoteNotification (const ConstData &deviceToken, void *error)=0 |
The application is registered for push notifications. More... | |
virtual void | AppRegisterUserNotificationSettings (void *notificationSettings)=0 |
The application is registered for user notifications. More... | |
virtual void | AppHandleActionWithIdentifier (const String &identifier, void *notification, void *userInfo)=0 |
Perform the custom action specified by a local or remote notification. More... | |
virtual FetchResult | AppReceiveRemoteNotification (void *userInfo)=0 |
The application received a push notification. More... | |
virtual FetchResult | AppPerformBackgroundFetch ()=0 |
The application can perform a background fetch. More... | |
virtual void | AppHandleEventsForBackgroundURLSession (const String &identifier)=0 |
Events related to a URL session are waiting to be processed. More... | |
virtual void | AppWillTerminate ()=0 |
The application will terminate. More... | |
Enumeration to indicate the result of a background fetch operation.
|
pure virtual |
Initialize the control.
platform | A pointer to the platform. |
Implemented in Murl::CustomControlable.
|
pure virtual |
|
pure virtual |
The engine is paused.
Is called if the application will resign active.
Implemented in Murl::CustomControlable.
|
pure virtual |
The engine is continued.
Is called if the application did become active. This happens also at start of the application.
Implemented in Murl::CustomControlable.
|
pure virtual |
The engine is suspended.
Is called if the application did enter background.
Implemented in Murl::CustomControlable.
|
pure virtual |
The engine is resumed.
Is called if the application did enter foreground.
Implemented in Murl::CustomControlable.
|
pure virtual |
The app application did finish launching.
On iOS this method is called by UIApplicationDelegate didFinishLaunchingWithOptions. On OSX this method is called by NSApplicationDelegate applicationDidFinishLaunching.
launchOptions | The launch options iOS dictionary (NSDictionary*) or OSX notification (NSNotification*). |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application is opened by an url.
On iOS this method is called by UIApplicationDelegate openURL.
url | The url string. |
sourceApplication | The source application string. |
annotation | A property-list object supplied by the source application. |
Implemented in Murl::CustomControlable.
The application is opened by an url with options.
On iOS this method is called by UIApplicationDelegate openURL.
url | The url string. |
options | A dictionary of launch options. |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application received a local notification.
On iOS this method is called by UIApplicationDelegate didReceiveLocalNotification.
notification | Encapsulates details about the notification (UILocalNotification*). |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application is registered for push notifications.
On iOS / OSX this method is called by UIApplicationDelegate / NSApplicationDelegate didRegisterForRemoteNotificationsWithDeviceToken or in case of an error by didFailToRegisterForRemoteNotificationsWithError with an error parameter.
deviceToken | The device token. |
error | An optional error (NSError*) or null. |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application is registered for user notifications.
On iOS this method is called by UIApplicationDelegate didRegisterUserNotificationSettings.
notificationSettings | The user notification settings (UIUserNotificationSettings*). |
Implemented in Murl::CustomControlable.
|
pure virtual |
Perform the custom action specified by a local or remote notification.
On iOS this method is called by UIApplicationDelegate handleActionWithIdentifier. Depending on the notification either the parameter notification or userInfo is null.
identifier | The identifier string associated with the action. |
notification | The local notification object that was triggered (UILocalNotification*). |
userInfo | Dictionary containing information related to the remote notification (NSDictionary*). |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application received a push notification.
On iOS / OSX this method is called by UIApplicationDelegate / NSApplicationDelegate didReceiveRemoteNotification.
userInfo | Encapsulates details about the notification (NSDictionary*). |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application can perform a background fetch.
On iOS this method is called by UIApplicationDelegate performFetchWithCompletionHandler.
Implemented in Murl::CustomControlable.
|
pure virtual |
Events related to a URL session are waiting to be processed.
identifier | The identifier of the URL session requiring attention. |
Implemented in Murl::CustomControlable.
|
pure virtual |
The application will terminate.
On iOS / OSX this method is called by UIApplicationDelegate / NSApplicationDelegate applicationWillTerminate.
Implemented in Murl::CustomControlable.