wxHtmlWindow
Implements methods from the following classes
wxScrolledWindow
Methods
wxHtmlWindow
Default ctor.
AppendToPage
Appends HTML fragment to currently displayed text and refreshes the window.
GetInternalRepresentation
Returns pointer to the top-level container.
GetOpenedAnchor
Returns anchor within currently opened page (see wxHtmlWindow::GetOpenedPage).
GetOpenedPage
Returns full location of the opened page.
GetOpenedPageTitle
Returns title of the opened page or wxEmptyString if the current page does not contain
tag.
GetRelatedFrame
Returns the related frame.
HistoryBack
Moves back to the previous page.
HistoryCanBack
Returns true if it is possible to go back in the history i.e.
HistoryCanForward
Returns true if it is possible to go forward in the history i.e.
HistoryClear
Clears history.
HistoryForward
Moves to next page in history.
LoadFile
Loads an HTML page from a file and displays it.
LoadPage
Unlike SetPage() this function first loads the HTML page from location and then displays it.
OnCellClicked
This method is called when a mouse button is clicked inside wxHtmlWindow.
OnCellMouseHover
This method is called when a mouse moves over an HTML cell.
OnLinkClicked
Called when user clicks on hypertext link.
OnSetTitle
Called on parsing
tag.
SelectAll
Selects all text in the window.
SelectLine
Selects the line of text that pos points at.
SelectWord
Selects the word at position pos.
SelectionToText
Returns the current selection as plain text.
SetBorders
This function sets the space between border of window and HTML contents.
SetFonts
This function sets font sizes and faces.
SetPage
Sets the source of a page and displays it, for example:
SetRelatedFrame
Sets the frame in which page title will be displayed.
SetRelatedStatusBar
After calling SetRelatedFrame(), this sets statusbar slot where messages will be displayed.
SetStandardFonts
Sets default font sizes and/or default font size.
ToText
Returns content of currently displayed page as plain text.
WriteCustomization
Saves custom settings into wxConfig.
Static Methods
AddFilter
Adds input filter to the static list of available filters.
wxHtmlWindow
wxHtmlWindow
( )
Default ctor.
wxHtmlWindow
(
wxWindow
&
$parent
,
integer
$id
=
wxID_ANY
,
wxPoint
$pos
=
wxDefaultPosition
,
wxSize
$size
=
wxDefaultSize
,
integer
$style
=
wxHW_DEFAULT_STYLE
,
string
$name
=
"htmlWindow"
)
Constructor.
AddFilter
static
AddFilter
(
wxHtmlFilter
&
$filter
)
Adds input filter to the static list of available filters.
AppendToPage
bool
AppendToPage
(
string
$source
)
Appends HTML fragment to currently displayed text and refreshes the window.
GetInternalRepresentation
wxHtmlContainerCell
&
GetInternalRepresentation
( )
Returns pointer to the top-level container.
GetOpenedAnchor
string
GetOpenedAnchor
( )
Returns anchor within currently opened page (see wxHtmlWindow::GetOpenedPage).
GetOpenedPage
string
GetOpenedPage
( )
Returns full location of the opened page.
GetOpenedPageTitle
string
GetOpenedPageTitle
( )
Returns title of the opened page or wxEmptyString if the current page does not contain
tag.
GetRelatedFrame
wxFrame
&
GetRelatedFrame
( )
Returns the related frame.
HistoryBack
bool
HistoryBack
( )
Moves back to the previous page.
HistoryCanBack
bool
HistoryCanBack
( )
Returns true if it is possible to go back in the history i.e.
HistoryCanForward
bool
HistoryCanForward
( )
Returns true if it is possible to go forward in the history i.e.
HistoryClear
HistoryClear
( )
Clears history.
HistoryForward
bool
HistoryForward
( )
Moves to next page in history.
LoadFile
bool
LoadFile
(
wxFileName
$filename
)
Loads an HTML page from a file and displays it.
LoadPage
bool
LoadPage
(
string
$location
)
Unlike SetPage() this function first loads the HTML page from location and then displays it.
OnCellClicked
bool
OnCellClicked
(
wxHtmlCell
&
$cell
,
integer
$x
,
integer
$y
,
wxMouseEvent
$event
)
This method is called when a mouse button is clicked inside wxHtmlWindow.
OnCellMouseHover
OnCellMouseHover
(
wxHtmlCell
&
$cell
,
integer
$x
,
integer
$y
)
This method is called when a mouse moves over an HTML cell.
OnLinkClicked
OnLinkClicked
(
wxHtmlLinkInfo
$link
)
Called when user clicks on hypertext link.
OnSetTitle
OnSetTitle
(
string
$title
)
Called on parsing
tag.
SelectAll
SelectAll
( )
Selects all text in the window.
SelectLine
SelectLine
(
wxPoint
$pos
)
Selects the line of text that pos points at.
SelectWord
SelectWord
(
wxPoint
$pos
)
Selects the word at position pos.
SelectionToText
string
SelectionToText
( )
Returns the current selection as plain text.
SetBorders
SetBorders
(
integer
$b
)
This function sets the space between border of window and HTML contents.
SetFonts
SetFonts
(
string
$normal_face
,
string
$fixed_face
,
array
$sizes
=
NULL
)
This function sets font sizes and faces.
SetPage
bool
SetPage
(
string
$source
)
Sets the source of a page and displays it, for example:
SetRelatedFrame
SetRelatedFrame
(
wxFrame
&
$frame
,
string
$format
)
Sets the frame in which page title will be displayed.
SetRelatedStatusBar
SetRelatedStatusBar
(
integer
$index
)
After calling SetRelatedFrame(), this sets statusbar slot where messages will be displayed.
SetRelatedStatusBar
(
wxStatusBar
&
$statusbar
,
integer
$index
)
Sets the associated statusbar where messages will be displayed.
SetStandardFonts
SetStandardFonts
(
integer
$size
=
-1
,
string
$normal_face
=
wxEmptyString
,
string
$fixed_face
=
wxEmptyString
)
Sets default font sizes and/or default font size.
ToText
string
ToText
( )
Returns content of currently displayed page as plain text.
WriteCustomization
WriteCustomization
(
wxConfigBase
&
$cfg
,
string
$path
=
wxEmptyString
)
Saves custom settings into wxConfig.