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...
	~CustomControlable () override
	The destructor.
const String &	GetName () const override
	Default implementation of IControlable::GetName(). More...
void	FrameUpdate () override
	Default implementation of IControlable::FrameUpdate().
void	LogicUpdate () override
	Default implementation of IControlable::LogicUpdate().
void	ConfigChanged (const IAppConfiguration *appConfig) override
	Default implementation of IControlable::ConfigChanged(). More...
Bool	Init (IPlatform *platform) override
	Default implementation of ICustomControlable::Init(). More...
Bool	DeInit () override
	Default implementation of ICustomControlable::DeInit(). More...
void	PauseEngine () override
	Default implementation of ICustomControlable::PauseEngine().
void	ContinueEngine () override
	Default implementation of ICustomControlable::ContinueEngine().
void	SuspendEngine () override
	Default implementation of ICustomControlable::SuspendEngine().
void	ResumeEngine () override
	Default implementation of ICustomControlable::ResumeEngine().
Bool	AppFinishLaunching (void *launchOptions) override
	Default implementation of ICustomControlable::AppFinishLaunching(). More...
Bool	AppOpenURL (String url, String sourceApplication, void *annotation) override
	Default implementation of ICustomControlable::AppOpenURL(). More...
Bool	AppOpenURL (String url, void *options) override
	Default implementation of ICustomControlable::AppOpenURL(). More...
void	AppReceiveNotification (void *notification) override
	Default implementation of ICustomControlable::AppReceiveNotification(). More...
void	AppRegisterForRemoteNotification (const ConstData &deviceToken, void *error) override
	Default implementation of ICustomControlable::AppRegisterForRemoteNotification(). More...
void	AppRegisterUserNotificationSettings (void *notificationSettings) override
	Default implementation of ICustomControlable::AppRegisterUserNotificationSettings(). More...
void	AppHandleActionWithIdentifier (const String &identifier, void *notification, void *userInfo) override
	Default implementation of ICustomControlable::AppHandleActionWithIdentifier(). More...
FetchResult	AppReceiveRemoteNotification (void *userInfo) override
	Default implementation of ICustomControlable::AppReceiveRemoteNotification(). More...
FetchResult	AppPerformBackgroundFetch () override
	Default implementation of ICustomControlable::AppPerformBackgroundFetch(). More...
void	AppHandleEventsForBackgroundURLSession (const String &identifier) override
	Default implementation of ICustomControlable::AppHandleEventsForBackgroundURLSession(). More...
void	AppWillTerminate () override
	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

controlName

The name of the control.

Member Function Documentation

GetName()

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

inlineoverridevirtual

Default implementation of IControlable::GetName().

Returns

The controlable's name.

Implements Murl::IControlable.

ConfigChanged()

void Murl::CustomControlable::ConfigChanged ( const IAppConfiguration *  appConfig )

inlineoverridevirtual

Default implementation of IControlable::ConfigChanged().

Parameters

appConfig

The application configuration object.

Implements Murl::IControlable.

Init()

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

inlineoverridevirtual

Default implementation of ICustomControlable::Init().

Parameters

platform

A pointer to the platform.

Returns

true if successful.

Implements Murl::ICustomControlable.

DeInit()

Bool Murl::CustomControlable::DeInit ( )

inlineoverridevirtual

Default implementation of ICustomControlable::DeInit().

Returns

true if successful.

Implements Murl::ICustomControlable.

AppFinishLaunching()

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppFinishLaunching().

Parameters

launchOptions

The launch options.

Returns

false if not used, true if the launchOptions have been processed.

Implements Murl::ICustomControlable.

AppOpenURL() [1/2]

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppOpenURL().

Parameters

url	The url string.
sourceApplication	The source application string.
annotation	A 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]

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppOpenURL().

Parameters

url	The url string.
options	A dictionary of launch options.

Returns

false if not used, true if the url has been processed.

Implements Murl::ICustomControlable.

AppReceiveNotification()

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppReceiveNotification().

Parameters

notification

Encapsulates details about the notification (UILocalNotification*).

Implements Murl::ICustomControlable.

AppRegisterForRemoteNotification()

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppRegisterForRemoteNotification().

Parameters

deviceToken	The device token.
error	An optional error (NSError*) or null.

Implements Murl::ICustomControlable.

AppRegisterUserNotificationSettings()

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppRegisterUserNotificationSettings().

Parameters

notificationSettings

The user notification settings (UIUserNotificationSettings*).

Implements Murl::ICustomControlable.

AppHandleActionWithIdentifier()

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppHandleActionWithIdentifier().

Parameters

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

Implements Murl::ICustomControlable.

AppReceiveRemoteNotification()

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

inlineoverridevirtual

Default implementation of ICustomControlable::AppReceiveRemoteNotification().

Parameters

userInfo

Encapsulates details about the notification (NSDictionary*).

Returns

A result that indicates whether content was available.

Implements Murl::ICustomControlable.

References Murl::ICustomControlable::FETCHRESULT_NONE.

AppPerformBackgroundFetch()

FetchResult Murl::CustomControlable::AppPerformBackgroundFetch ( )

inlineoverridevirtual

Default implementation of ICustomControlable::AppPerformBackgroundFetch().

Returns

A result that indicates whether content was available.

Implements Murl::ICustomControlable.

References Murl::ICustomControlable::FETCHRESULT_NONE.

AppHandleEventsForBackgroundURLSession()

void Murl::CustomControlable::AppHandleEventsForBackgroundURLSession ( const String &  identifier )

inlineoverridevirtual

Default implementation of ICustomControlable::AppHandleEventsForBackgroundURLSession().

Parameters

identifier

The 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