Wx::HtmlWindow

HtmlWindow is a widget for displaying simple HTML. IT supports key HTML features like links, images, tables and headings, but does not support all the features of modern browsers such as CSS and Javascript. It’s well suited for creating hypertext-based applications, but not for creating a complete web browser.

Once the window is created you can set its content by calling set_page, load_page or load_file. The width of the window is constant – given in the constructor – and virtual height is changed dynamically depending on page size.

Derived from

ScrolledWindow

Window styles

Event handling

To process user interaction with an HtmlWindow, use these event handlers to direct input to blocks that take a HtmlCellEvent argument or a HtmlLinkEvent.

See also

HtmlLinkEvent, HtmlCellEvent

Methods

HtmlWindow.new

HtmlWindow.new(Window parent,  Integer id = -1, 
               Point pos = DEFAULT_POSITION, 
               Size size = DEFAULT_SIZE, 
               Integer style = HW_DEFAULT_STYLE, 
               String name = "htmlWindow")

Constructor. The parameters are the same as for the ScrolledWindow constructor.

Parameters

• style Window style. See HtmlWindow.

HtmlWindow#add_filter

add_filter(HtmlFilter filter)

Adds input filter to the static list of available filters. These filters are present by default:

• text/html MIME type
• image/* MIME types
• Plain Text filter (this filter is used if no other filter matches)

HtmlWindow#append_to_page

Boolean append_to_page(String source)

Appends HTML fragment to currently displayed text and refreshes the window.

Parameters

• source HTML code fragment

Return value

false if an error occurred, true otherwise.

HtmlWindow#get_internal_representation

HtmlContainerCell get_internal_representation()

Returns pointer to the top-level container.

See also: Cells Overview, Printing Overview

HtmlWindow#get_opened_anchor

String get_opened_anchor()

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

HtmlWindow#get_opened_page

String get_opened_page()

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.

HtmlWindow#get_opened_page_title

String get_opened_page_title()

Returns title of the opened page or EmptyString if current page does not contain <TITLE> tag.

HtmlWindow#get_related_frame

Frame get_related_frame()

Returns the related frame.

HtmlWindow#history_back

Boolean history_back()

Moves back to the previous page. (each page displayed using load_page is stored in history list.)

HtmlWindow#history_can_back

Boolean history_can_back()

Returns true if it is possible to go back in the history (i.e. HistoryBack() won’t fail).

HtmlWindow#history_can_forward

Boolean history_can_forward()

Returns true if it is possible to go forward in the history (i.e. HistoryBack() won’t fail).

HtmlWindow#history_clear

history_clear()

Clears history.

HtmlWindow#history_forward

Boolean history_forward()

Moves to next page in history.

HtmlWindow#load_file

Boolean load_file(FileName filename)

Loads HTML page from file and displays it.

Return value

false if an error occurred, true otherwise

See also

load_page

HtmlWindow#load_page

Boolean load_page(String location)

Unlike SetPage this function first loads HTML page from location and then displays it. See example:

htmlwin->LoadPage("help/myproject/index.htm");

Parameters

• location The address of document. See FileSystem for details on address format and behaviour of “opener”.

Return value

false if an error occurred, true otherwise

See also

load_file

HtmlWindow#on_opening_url

Boolean or String on_opening_url(String url)

This method is called whenever the HtmlWindow attempts to open a URL, either a page, or an image within a page. It can be used to block access to certain URLs, or rewrite them. This method should return true, if access to the URL should be allowed or false if it should be blocked. It may also return a string containing a new URL to which the request should be redirected.

Note that if redirecting, the method will immediately be called again with the new URL, so to avoid entering an endless loop, you should test for this and return true if no rewriting is to be done.

The default implementation in the standard Wx::HtmlWindow class always returns true, ie allow the URL.

HtmlWindow#on_set_title

on_set_title(String title)

Called on parsing