HtmlViewerCustomGui Class Reference

#include <customgui_htmlviewer.h>

Inheritance diagram for HtmlViewerCustomGui:

详细描述

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

警告
HTML viewer custom GUI cannot be used in modal dialogs.

公共成员函数

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)
-  Public Member Functions inherited from BaseCustomGui< 200000114 >
Int32   GetWidth ()
Int32   GetHeight ()
void  Redraw ()
Bool   LayoutChanged ()
Bool   激活 ()
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   激活 ( 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 String   FilenameToURL (const Filename &f, Int32 *encoding)

私有成员函数

  HtmlViewerCustomGui ()
  ~HtmlViewerCustomGui ()

构造函数 & 析构函数文档编制

◆  HtmlViewerCustomGui()

HtmlViewerCustomGui () private

◆  ~HtmlViewerCustomGui()

~ HtmlViewerCustomGui () private

成员函数文档编制

◆  SetUrl()

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

Sets the HTML viewer URL.

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

◆  SetText()

void SetText ( const maxon::String url )

Sets the HTML viewer text.

参数
[in] url The new text.

◆  DoAction()

void DoAction ( Int32   action )

Do an action in the HTML viewer.

参数
[in] action The action: WEBPAGE

◆  SetURLCallback()

void SetURLCallback ( HtmlViewerCustomGuiURLCallback callback ,
void *  user_data  
)

Registers the URL callback.

参数
[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.

参数
[in] f The filename.
[out] encoding Assigned the URL encoding: URL_ENCODING
返回
The URL of the filename.