c4d.gui.HtmlViewerCustomGui

class 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.

Methods Signatures

HtmlViewerCustomGui.SetText(self, url) Set the HTML viewer text.
HtmlViewerCustomGui.SetUrl(self, url, encoding) Set the HTML viewer URL.
HtmlViewerCustomGui.SetURLCallback(self, callback, user_data) Set the URL callback.
HtmlViewerCustomGui.DoAction(self, action) Do an action in the HTML viewer.

Inheritance

Parent Class:

Methods Documentation

HtmlViewerCustomGui.SetText(self, url)

Set the HTML viewer text.

Parameters:url (str) – New text.
HtmlViewerCustomGui.SetUrl(self, 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(self, 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(self, 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