wxHtmlWindow

• proc clear_html_history( atom html_win )   
• func get_html_anchor( atom html_win )   
• func get_html_page( atom html_win )   
• proc get_html_page_title( atom html_win )   
• proc html_append( atom htmlwin, sequence source)   
• proc html_back( atom htmlwin )   
• proc html_forward( atom htmlwin )   
• proc load_html_file( atom htmlwin, sequence file)   
• proc load_html_page( atom htmlwin, sequence page )   
• func selection_to_text( atom htmlwin )   
• proc set_html_page( atom htmlwin, sequence source )   
• proc set_link_event( atom htmlwin, integer rid )   
• proc set_open_url_event( atom htmlwin, integer rid )   
• proc set_related_frame( atom html_win, atom frame, sequence format )   

• Controls

• wxHtmlLinkEvent
• wxHtmlLinkInfo

---

wxHtmlWindow

[proc]
clear_html_history ( atom html_win )

Category: wxHtmlWindow

Clears the history cache.

---

wxHtmlWindow

[func]
get_html_anchor ( atom html_win )

Category: wxHtmlWindow

Returns anchor within currently opened page (see get_html_page()). If no page is opened or if the displayed page wasn't produced by call to LoadPage, empty string is returned.

---

wxHtmlWindow

[func]
get_html_page ( atom html_win )

Category: wxHtmlWindow

Returns full location of the opened page. If no page is opened or if the displayed page wasn't produced by call to LoadPage, empty string is returned.

---

wxHtmlWindow

[proc]
get_html_page_title ( atom html_win )

Category: wxHtmlWindow

Returns the title of the currently opened page.

---

wxHtmlWindow

[proc]
html_append ( atom htmlwin, sequence source)

Category: wxHtmlWindow

This appends the HTML Source to the Control

---

wxHtmlWindow

[proc]
html_back ( atom htmlwin )

Category: wxHtmlWindow

Goes backward in the list of pages in an wxHtmlWindow's cache of viewed pages. If there is no page before the current page, then nothing will happen.

---

wxHtmlWindow

[proc]
html_forward ( atom htmlwin )

Category: wxHtmlWindow

Goes forward in the list of pages in an wxHtmlWindow's cache of viewed pages. If there is no page after the current page, then nothing will happen.

---

wxHtmlWindow

[proc]
load_html_file ( atom htmlwin, sequence file)

Category: wxHtmlWindow

Loads the specified file.

---

wxHtmlWindow

[proc]
load_html_page ( atom htmlwin, sequence page )

Category: wxHtmlWindow

This opens a specified html page into the designated wxHtmlWindow. If you want it to follow HTML links, you will need this the second part to be ahref.

---

wxHtmlWindow

[func]
selection_to_text ( atom htmlwin )

Category: wxHtmlWindow

---

wxHtmlWindow

[proc]
set_html_page ( atom htmlwin, sequence source )

Category: wxHtmlWindow

This sets the source of the displayed page to source.

---

wxHtmlWindow

[proc]
set_link_event ( atom htmlwin, integer rid )

Category: wxHtmlWindow

Note: This method is deprecated; intercept the event instead: wxEVT_COMMAND_HTML_LINK_CLICKED.

Set a callback for when the user clicks on a link in a wxHtmlWindow. The callback must be a procedure that takes 3 parameters:

• htmlwin: the wxHtmlWindow
• href: a sequence that will be the href for the link
• target: a sequence that contains the target for the link

If you trap this event, you must call load_html_page() in order for the link to execute.

---

wxHtmlWindow

[proc]
set_open_url_event ( atom htmlwin, integer rid )

Category: wxHtmlWindow

Set a call_back to be called when an URL is being opened (either when the user clicks on a link or an image is loaded). The URL will be opened only if the call back returns wxHTML_OPEN. This method is called by wxHtmlParser::OpenURL. You can use the call back to selectively block some URLs (e.g. for security reasons) or to redirect them elsewhere. Default behaviour is to always return wxHTML_OPEN.

Parameters

• type: Indicates type of the resource. Is one of wxHTML_URL_PAGE Opening a HTML page.
  • wxHTML_URL_IMAGE Opening an image.
  • wxHTML_URL_OTHER Opening a resource that doesn't fall into any other category.
• url: URL being opened.

Call back return value:

• wxHTML_OPEN Open the URL.
• wxHTML_BLOCK Deny access to the URL, wxHtmlParser::OpenURL will return NULL.
• {wxHTML_REDIRECT, redirect_url } Don't open url, redirect to another URL.

---

wxHtmlWindow

[proc]
set_related_frame ( atom html_win, atom frame, sequence format )

Category: wxHtmlWindow

Sets the frame in which page title will be displayed. format is format of frame title, e.g. "HtmlHelp : %s". It must contain exactly one %s. This %s is substituted with HTML page title. status_slot is the slot in the status bar where messages will be displayed (-1 means no messages).

---