Murl::IWebControl Interface Reference

The IWebControl interface. More...

#include "murl_i_web_control.h"

Inheritance diagram for Murl::IWebControl:

Public Member Functions
virtual Bool	OpenUrlInSystemBrowser (const String &url)=0
	Open a url in the system's default browser. More...
virtual IUrlRequest *	CreateUrlRequest ()=0
	Create a url-request object. More...
virtual void	DestroyUrlRequest (IUrlRequest *&urlRequest)=0
	Destroy a url-request object. More...
virtual IEMail *	CreateEMail (const String &subject, const String &message)=0
	Create a e-mail object. More...
virtual IEMail *	CreateEMail (const String &subject, const String &message, const String &recipientAddress)=0
	Create a e-mail object. More...
virtual void	DestroyEMail (IEMail *&eMail)=0
	Destroy a e-mail object. More...
Public Member Functions inherited from Murl::IControlable
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...

Detailed Description

The IWebControl interface.

Member Function Documentation

OpenUrlInSystemBrowser()

virtual Bool Murl::IWebControl::OpenUrlInSystemBrowser ( const String &  url )

pure virtual

Open a url in the system's default browser.

Parameters

url	The url string to open.

Returns

true if successful.

CreateUrlRequest()

virtual IUrlRequest* Murl::IWebControl::CreateUrlRequest ( )

pure virtual

Create a url-request object.

Returns

The url-request object or null if creation failed.

DestroyUrlRequest()

virtual void Murl::IWebControl::DestroyUrlRequest ( IUrlRequest *&  urlRequest )

pure virtual

Destroy a url-request object.

Parameters

urlRequest

A reference to the url-request object to destroy. After destruction the pointer is set to null.

CreateEMail() [1/2]

virtual IEMail* Murl::IWebControl::CreateEMail ( const String &  subject, const String &  message  )

pure virtual

Create a e-mail object.

Parameters

subject	The subject string for the e-mail object.
message	The message string for the e-mail object.

Returns

The e-mail object or null if creation failed

The e-mail object or null if sending e-mail is not configured.

CreateEMail() [2/2]

virtual IEMail* Murl::IWebControl::CreateEMail ( const String &  subject, const String &  message, const String &  recipientAddress  )

pure virtual

Create a e-mail object.

Parameters

subject	The subject string for the e-mail object.
message	The message string for the e-mail object.
recipientAddress	The recipient address string for the e-mail object.

Returns

The e-mail object or null if sending e-mail is not configured.

DestroyEMail()

virtual void Murl::IWebControl::DestroyEMail ( IEMail *&  eMail )

pure virtual

Destroy a e-mail object.

Parameters

eMail

A reference to the e-mail object to destroy. After destruction the pointer is set to null.

---

The documentation for this interface was generated from the following file:

• murl_i_web_control.h