HtmlViewerCustomGui Class Reference

#include <customgui_htmlviewer.h>

Inheritance diagram for HtmlViewerCustomGui:

Detailed Description

HTML viewer custom GUI (CUSTOMGUI_HTMLVIEWER). Can view both local and internet HTML files using the http protocol.

Warning

HTML viewer custom GUI cannot be used in modal dialogs.

Public Member Functions
void	ExecuteJavaScript (const maxon::String &script)
void	PostWebMessage (const maxon::String &message)
void	SetWebMessageCallback (HtmlViewerCustomGuiWebMessageCallback *callback, const maxon::String &urlPartial, void *user_data)
void	SetUrl (const maxon::String &url, Int32 encoding)
void	SetText (const maxon::String &url)
void	DoAction (Int32 action)
void	SetURLCallback (HtmlViewerCustomGuiURLCallback *callback, void *user_data)
String	GetTextArea (const maxon::String &id)
void	SetResourceRequestInterceptCallback (HtmlViewerCustomGuiResourceRequestInterceptCallback *callback, void *user_data)
Public Member Functions inherited from BaseCustomGui< 200000114 >
Int32	GetWidth ()
Int32	GetHeight ()
void	Redraw ()
Bool	LayoutChanged ()
Bool	Activate ()
Bool	SetDefaultForResEdit ()
Bool	SetData (const TriState< GeData > &tristate)
TriState< GeData >	GetData ()
void	SetLayoutMode (Int32 mode)
Int32	GetLayoutMode ()
Bool	SupportLayoutSwitch ()
Public Member Functions inherited from _BaseCustomGui
Int32	GetWidth (Int32 plugid)
Int32	GetHeight (Int32 plugid)
void	Redraw (Int32 plugid)
Bool	LayoutChanged (Int32 plugid)
Bool	Activate (Int32 plugid)
Bool	SetDefaultForResEdit (Int32 plugid)
Bool	SetData (Int32 plugid, const TriState< GeData > &tristate)
TriState< GeData >	GetData (Int32 plugid)
void	SetLayoutMode (Int32 plugid, Int32 mode)
Int32	GetLayoutMode (Int32 plugid)
Bool	SupportLayoutSwitch (Int32 plugid)

Static Public Member Functions
static String	FilenameToURL (const Filename &f, Int32 *encoding)

Private Member Functions
	HtmlViewerCustomGui ()
	~HtmlViewerCustomGui ()

Additional Inherited Members
Static Public Attributes inherited from BaseCustomGui< 200000114 >
static constexpr Int32	VALUE

Constructor & Destructor Documentation

HtmlViewerCustomGui()

HtmlViewerCustomGui ( )

private

~HtmlViewerCustomGui()

~HtmlViewerCustomGui ( )

private

Member Function Documentation

ExecuteJavaScript()

void ExecuteJavaScript

(

const maxon::String &

script

)

Executes JavaScript code in the HTML viewer context.

Parameters

[in]

script

The JavaScript code to execute.

PostWebMessage()

void PostWebMessage

(

const maxon::String &

message

)

Posts a web message to the HTML viewer's JavaScript context.

Parameters

[in]

message

The message to send to JavaScript.

SetWebMessageCallback()

void SetWebMessageCallback	(	HtmlViewerCustomGuiWebMessageCallback *	callback,
		const maxon::String &	urlPartial,
		void *	user_data
	)

Sets a callback for web messages sent from the HTML viewer's JavaScript context.

Parameters

[in]	callback	The callback function to handle web messages.
[in]	urlPartial	A partial URL to filter which messages trigger the callback.
[in]	user_data	User data pointer passed to the callback.

SetUrl()

void SetUrl	(	const maxon::String &	url,
		Int32	encoding
	)

Sets the HTML viewer URL.

Parameters

[in]	url	The new URL.
[in]	encoding	The URL encoding: URL_ENCODING

SetText()

void SetText

(

const maxon::String &

url

)

Sets the HTML viewer text.

Parameters

[in]

url

The new text.

DoAction()

void DoAction

(

Int32

action

)

Do an action in the HTML viewer.

Parameters

[in]

action

The action: WEBPAGE

SetURLCallback()

void SetURLCallback	(	HtmlViewerCustomGuiURLCallback *	callback,
		void *	user_data
	)

Registers the URL callback.

Parameters

[in]	callback	The callback, or nullptr to disable it.
[in]	user_data	The user data. The caller owns the pointed data.

GetTextArea()

String GetTextArea

(

const maxon::String &

id

)

Deprecated. Always return an empty string.

FilenameToURL()

static String FilenameToURL ( const Filename &  f, Int32 *  encoding  )

static

Converts a filename into an URL string.

Parameters

[in]	f	The filename.
[out]	encoding	Assigned the URL encoding: URL_ENCODING

Returns

The URL of the filename.

SetResourceRequestInterceptCallback()

void SetResourceRequestInterceptCallback	(	HtmlViewerCustomGuiResourceRequestInterceptCallback *	callback,
		void *	user_data
	)

Registers the resource request interception callback.

Parameters

[in]	callback	The callback, or nullptr to disable it.
[in]	user_data	The user data. The caller owns the pointed data.