Murl::ICustomControlable Interface Referenceabstract

The ICustomControlable interface. More...

#include "murl_i_custom_controlable.h"

Inheritance diagram for Murl::ICustomControlable:

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...
 
- Public Member Functions inherited from Murl::IControlable
virtual const StringGetName () 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...
 

Detailed Description

The ICustomControlable interface.

The ICustomControlable is the base class for implementing custom control objects which can be registered to the Output::IDeviceHandler.

Member Enumeration Documentation

◆ FetchResult

Enumeration to indicate the result of a background fetch operation.

Enumerator
FETCHRESULT_NONE 

The control does not support the operation.

FETCHRESULT_NEWDATA 

New data was successfully downloaded.

FETCHRESULT_NODATA 

There was no new data to download.

FETCHRESULT_FAILED 

An attempt to download data was made but that attempt failed.

Member Function Documentation

◆ Init()

virtual Bool Murl::ICustomControlable::Init ( IPlatform *  platform)
pure virtual

Initialize the control.

Parameters
platformA pointer to the platform.
Returns
true if successful.

Implemented in Murl::CustomControlable.

◆ DeInit()

virtual Bool Murl::ICustomControlable::DeInit ( )
pure virtual

De-initialize the control.

Returns
true if successful.

Implemented in Murl::CustomControlable.

◆ PauseEngine()

virtual void Murl::ICustomControlable::PauseEngine ( )
pure virtual

The engine is paused.

Is called if the application will resign active.

Implemented in Murl::CustomControlable.

◆ ContinueEngine()

virtual void Murl::ICustomControlable::ContinueEngine ( )
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.

◆ SuspendEngine()

virtual void Murl::ICustomControlable::SuspendEngine ( )
pure virtual

The engine is suspended.

Is called if the application did enter background.

Implemented in Murl::CustomControlable.

◆ ResumeEngine()

virtual void Murl::ICustomControlable::ResumeEngine ( )
pure virtual

The engine is resumed.

Is called if the application did enter foreground.

Implemented in Murl::CustomControlable.

◆ AppFinishLaunching()

virtual Bool Murl::ICustomControlable::AppFinishLaunching ( void *  launchOptions)
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.

Parameters
launchOptionsThe launch options iOS dictionary (NSDictionary*) or OSX notification (NSNotification*).
Returns
false if not used, true if the launchOptions have been processed.

Implemented in Murl::CustomControlable.

◆ AppOpenURL() [1/2]

virtual Bool Murl::ICustomControlable::AppOpenURL ( String  url,
String  sourceApplication,
void *  annotation 
)
pure virtual

The application is opened by an url.

On iOS this method is called by UIApplicationDelegate openURL.

Parameters
urlThe url string.
sourceApplicationThe source application string.
annotationA property-list object supplied by the source application.
Returns
false if not used, true if the url has been processed.

Implemented in Murl::CustomControlable.

◆ AppOpenURL() [2/2]

virtual Bool Murl::ICustomControlable::AppOpenURL ( String  url,
void *  options 
)
pure virtual

The application is opened by an url with options.

On iOS this method is called by UIApplicationDelegate openURL.

Parameters
urlThe url string.
optionsA dictionary of launch options.
Returns
false if not used, true if the url has been processed.

Implemented in Murl::CustomControlable.

◆ AppReceiveNotification()

virtual void Murl::ICustomControlable::AppReceiveNotification ( void *  notification)
pure virtual

The application received a local notification.

On iOS this method is called by UIApplicationDelegate didReceiveLocalNotification.

Parameters
notificationEncapsulates details about the notification (UILocalNotification*).

Implemented in Murl::CustomControlable.

◆ AppRegisterForRemoteNotification()

virtual void Murl::ICustomControlable::AppRegisterForRemoteNotification ( const ConstData deviceToken,
void *  error 
)
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.

Parameters
deviceTokenThe device token.
errorAn optional error (NSError*) or null.

Implemented in Murl::CustomControlable.

◆ AppRegisterUserNotificationSettings()

virtual void Murl::ICustomControlable::AppRegisterUserNotificationSettings ( void *  notificationSettings)
pure virtual

The application is registered for user notifications.

On iOS this method is called by UIApplicationDelegate didRegisterUserNotificationSettings.

Parameters
notificationSettingsThe user notification settings (UIUserNotificationSettings*).

Implemented in Murl::CustomControlable.

◆ AppHandleActionWithIdentifier()

virtual void Murl::ICustomControlable::AppHandleActionWithIdentifier ( const String identifier,
void *  notification,
void *  userInfo 
)
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.

Parameters
identifierThe identifier string associated with the action.
notificationThe local notification object that was triggered (UILocalNotification*).
userInfoDictionary containing information related to the remote notification (NSDictionary*).

Implemented in Murl::CustomControlable.

◆ AppReceiveRemoteNotification()

virtual FetchResult Murl::ICustomControlable::AppReceiveRemoteNotification ( void *  userInfo)
pure virtual

The application received a push notification.

On iOS / OSX this method is called by UIApplicationDelegate / NSApplicationDelegate didReceiveRemoteNotification.

Parameters
userInfoEncapsulates details about the notification (NSDictionary*).
Returns
A result that indicates whether content was available.

Implemented in Murl::CustomControlable.

◆ AppPerformBackgroundFetch()

virtual FetchResult Murl::ICustomControlable::AppPerformBackgroundFetch ( )
pure virtual

The application can perform a background fetch.

On iOS this method is called by UIApplicationDelegate performFetchWithCompletionHandler.

Returns
A result that indicates whether content was available.

Implemented in Murl::CustomControlable.

◆ AppHandleEventsForBackgroundURLSession()

virtual void Murl::ICustomControlable::AppHandleEventsForBackgroundURLSession ( const String identifier)
pure virtual

Events related to a URL session are waiting to be processed.

Parameters
identifierThe identifier of the URL session requiring attention.

Implemented in Murl::CustomControlable.

◆ AppWillTerminate()

virtual void Murl::ICustomControlable::AppWillTerminate ( )
pure virtual

The application will terminate.

On iOS / OSX this method is called by UIApplicationDelegate / NSApplicationDelegate applicationWillTerminate.

Implemented in Murl::CustomControlable.


The documentation for this interface was generated from the following file:
  • murl_i_custom_controlable.h


Copyright © 2011-2018 Spraylight GmbH.