Murl::CustomControlable Class Reference

The CustomControlable default implementation class. More...

#include "murl_custom_controlable.h"

Inheritance diagram for Murl::CustomControlable:

Public Member Functions

 CustomControlable (const String &controlName)
 Constructor taking the name of the control. More...
 
virtual ~CustomControlable ()
 The destructor.
 
virtual const StringGetName () const
 Default implementation of IControlable::GetName(). More...
 
virtual void FrameUpdate ()
 Default implementation of IControlable::FrameUpdate().
 
virtual void LogicUpdate ()
 Default implementation of IControlable::LogicUpdate().
 
virtual void ConfigChanged (const IAppConfiguration *appConfig)
 Default implementation of IControlable::ConfigChanged(). More...
 
virtual Bool Init (IPlatform *platform)
 Default implementation of ICustomControlable::Init(). More...
 
virtual Bool DeInit ()
 Default implementation of ICustomControlable::DeInit(). More...
 
virtual void PauseEngine ()
 Default implementation of ICustomControlable::PauseEngine().
 
virtual void ContinueEngine ()
 Default implementation of ICustomControlable::ContinueEngine().
 
virtual void SuspendEngine ()
 Default implementation of ICustomControlable::SuspendEngine().
 
virtual void ResumeEngine ()
 Default implementation of ICustomControlable::ResumeEngine().
 
virtual Bool AppFinishLaunching (void *launchOptions)
 Default implementation of ICustomControlable::AppFinishLaunching(). More...
 
virtual Bool AppOpenURL (String url, String sourceApplication, void *annotation)
 Default implementation of ICustomControlable::AppOpenURL(). More...
 
virtual Bool AppOpenURL (String url, void *options)
 Default implementation of ICustomControlable::AppOpenURL(). More...
 
virtual void AppReceiveNotification (void *notification)
 Default implementation of ICustomControlable::AppReceiveNotification(). More...
 
virtual void AppRegisterForRemoteNotification (const ConstData &deviceToken, void *error)
 Default implementation of ICustomControlable::AppRegisterForRemoteNotification(). More...
 
virtual void AppRegisterUserNotificationSettings (void *notificationSettings)
 Default implementation of ICustomControlable::AppRegisterUserNotificationSettings(). More...
 
virtual void AppHandleActionWithIdentifier (const String &identifier, void *notification, void *userInfo)
 Default implementation of ICustomControlable::AppHandleActionWithIdentifier(). More...
 
virtual FetchResult AppReceiveRemoteNotification (void *userInfo)
 Default implementation of ICustomControlable::AppReceiveRemoteNotification(). More...
 
virtual FetchResult AppPerformBackgroundFetch ()
 Default implementation of ICustomControlable::AppPerformBackgroundFetch(). More...
 
virtual void AppHandleEventsForBackgroundURLSession (const String &identifier)
 Default implementation of ICustomControlable::AppHandleEventsForBackgroundURLSession(). More...
 
virtual void AppWillTerminate ()
 Default implementation of ICustomControlable::AppWillTerminate().
 
- Public Member Functions inherited from Murl::ICustomControlable

Additional Inherited Members

- Public Types inherited from Murl::ICustomControlable
enum  FetchResult { FETCHRESULT_NONE, FETCHRESULT_NEWDATA, FETCHRESULT_NODATA, FETCHRESULT_FAILED }
 Enumeration to indicate the result of a background fetch operation. More...
 

Detailed Description

The CustomControlable default implementation class.

The CustomControlable should be used as the base class for implementing a custom control object to get default implelentations for all methods.

Constructor & Destructor Documentation

◆ CustomControlable()

Murl::CustomControlable::CustomControlable ( const String controlName)
inline

Constructor taking the name of the control.

Parameters
controlNameThe name of the control.

Member Function Documentation

◆ GetName()

virtual const String& Murl::CustomControlable::GetName ( ) const
inlinevirtual

Default implementation of IControlable::GetName().

Returns
The controlable's name.

Implements Murl::IControlable.

◆ ConfigChanged()

virtual void Murl::CustomControlable::ConfigChanged ( const IAppConfiguration appConfig)
inlinevirtual

Default implementation of IControlable::ConfigChanged().

Parameters
appConfigThe application configuration object.

Implements Murl::IControlable.

◆ Init()

virtual Bool Murl::CustomControlable::Init ( IPlatform *  platform)
inlinevirtual

Default implementation of ICustomControlable::Init().

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

Implements Murl::ICustomControlable.

◆ DeInit()

virtual Bool Murl::CustomControlable::DeInit ( )
inlinevirtual

Default implementation of ICustomControlable::DeInit().

Returns
true if successful.

Implements Murl::ICustomControlable.

◆ AppFinishLaunching()

virtual Bool Murl::CustomControlable::AppFinishLaunching ( void *  launchOptions)
inlinevirtual

Default implementation of ICustomControlable::AppFinishLaunching().

Parameters
launchOptionsThe launch options.
Returns
false if not used, true if the launchOptions have been processed.

Implements Murl::ICustomControlable.

◆ AppOpenURL() [1/2]

virtual Bool Murl::CustomControlable::AppOpenURL ( String  url,
String  sourceApplication,
void *  annotation 
)
inlinevirtual

Default implementation of ICustomControlable::AppOpenURL().

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.

Implements Murl::ICustomControlable.

◆ AppOpenURL() [2/2]

virtual Bool Murl::CustomControlable::AppOpenURL ( String  url,
void *  options 
)
inlinevirtual

Default implementation of ICustomControlable::AppOpenURL().

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

Implements Murl::ICustomControlable.

◆ AppReceiveNotification()

virtual void Murl::CustomControlable::AppReceiveNotification ( void *  notification)
inlinevirtual

Default implementation of ICustomControlable::AppReceiveNotification().

Parameters
notificationEncapsulates details about the notification (UILocalNotification*).

Implements Murl::ICustomControlable.

◆ AppRegisterForRemoteNotification()

virtual void Murl::CustomControlable::AppRegisterForRemoteNotification ( const ConstData deviceToken,
void *  error 
)
inlinevirtual

Default implementation of ICustomControlable::AppRegisterForRemoteNotification().

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

Implements Murl::ICustomControlable.

◆ AppRegisterUserNotificationSettings()

virtual void Murl::CustomControlable::AppRegisterUserNotificationSettings ( void *  notificationSettings)
inlinevirtual

Default implementation of ICustomControlable::AppRegisterUserNotificationSettings().

Parameters
notificationSettingsThe user notification settings (UIUserNotificationSettings*).

Implements Murl::ICustomControlable.

◆ AppHandleActionWithIdentifier()

virtual void Murl::CustomControlable::AppHandleActionWithIdentifier ( const String identifier,
void *  notification,
void *  userInfo 
)
inlinevirtual

Default implementation of ICustomControlable::AppHandleActionWithIdentifier().

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*).

Implements Murl::ICustomControlable.

◆ AppReceiveRemoteNotification()

virtual FetchResult Murl::CustomControlable::AppReceiveRemoteNotification ( void *  userInfo)
inlinevirtual

Default implementation of ICustomControlable::AppReceiveRemoteNotification().

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

Implements Murl::ICustomControlable.

References Murl::ICustomControlable::FETCHRESULT_NONE.

◆ AppPerformBackgroundFetch()

virtual FetchResult Murl::CustomControlable::AppPerformBackgroundFetch ( )
inlinevirtual

Default implementation of ICustomControlable::AppPerformBackgroundFetch().

Returns
A result that indicates whether content was available.

Implements Murl::ICustomControlable.

References Murl::ICustomControlable::FETCHRESULT_NONE.

◆ AppHandleEventsForBackgroundURLSession()

virtual void Murl::CustomControlable::AppHandleEventsForBackgroundURLSession ( const String identifier)
inlinevirtual

Default implementation of ICustomControlable::AppHandleEventsForBackgroundURLSession().

Parameters
identifierThe identifier of the URL session requiring attention.

Implements Murl::ICustomControlable.


The documentation for this class was generated from the following file:
  • murl_custom_controlable.h


Copyright © 2011-2018 Spraylight GmbH.