c4d.gui.HtmlViewerCustomGui

HtmlViewer GUI (CUSTOMGUI_HTMLVIEWER). Can view both local and Internet HTML files using the http protocol.

Note

HTML viewer GUI elements can not be used in modal dialogs.

Definition

class c4d.gui.HtmlViewerCustomGui

• HtmlViewerCustomGui.SetText()
• HtmlViewerCustomGui.SetUrl()

• HtmlViewerCustomGui.SetURLCallback()
• HtmlViewerCustomGui.DoAction()
• HtmlViewerCustomGui.GetTextArea()

Inheritance

• c4d.gui.BaseCustomGui

  • c4d.gui.HtmlViewerCustomGui

Members

HtmlViewerCustomGui.SetText(url)

Set the HTML viewer text.

Parameters:str – New text.

HtmlViewerCustomGui.SetUrl(url, encoding)

Set the HTML viewer URL.

Parameters:

• url (str) – New URL.
• encoding (int) –

  Encoding:

  URL_ENCODING_UTF16	A string containing umlauts and spaces. The last # following the last slash is regarded as start of the anchor (the anchor following the hash mark must be escaped!)
  URL_ENCODING_ESCAPED	String contains an escaped url (all umlauts, spaces and other stuff that does not belong there is % according to RFC 2396.)

HtmlViewerCustomGui.SetURLCallback(callback[, user_data])

Set the URL callback.

Parameters:

• callback (function(user_data, url, encoding) : user_data: not used, always None - url: str - encoding: int) – New callback, or None to disable callback.
• user_data (any) – User data. - Not used currently, limitation of the implementation.

HtmlViewerCustomGui.DoAction(action)

Do an action in the HTML viewer.

Parameters:action (int) –

Action:

WEBPAGE_GOBACK	Go back.
WEBPAGE_GOFORWARD	Go forward.
WEBPAGE_GOHOME	Go home.
WEBPAGE_SEARCH	Search.
WEBPAGE_REFRESH	Refresh.
WEBPAGE_STOP	Stop

HtmlViewerCustomGui.GetTextArea(id)

Private legacy. Always return an empty string.