1999-07-10 17:17:24 -04:00
%
% automatically generated by HelpGen from
% htmlwindow.tex at 14/Mar/99 20:13:37
%
\section { \class { wxHtmlWindow} } \label { wxhtmlwindow}
wxHtmlWindow is probably the only class you will directly use
unless you want to do something special (like adding new tag
1999-10-25 09:46:48 -04:00
handlers or MIME filters).
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
The purpose of this class is to display HTML pages (either local
file or downloaded via HTTP protocol) in a window. The width
of the window is constant - given in the constructor - and virtual height
is changed dynamically depending on page size.
2000-03-14 19:21:49 -05:00
Once the window is created you can set its content by calling
2003-01-26 18:20:00 -05:00
\helpref { SetPage(text)} { wxhtmlwindowsetpage} ,
\helpref { LoadPage(filename)} { wxhtmlwindowloadpage} or
\helpref { LoadFile} { wxhtmlwindowloadfile} .
1999-07-10 17:17:24 -04:00
2002-02-17 09:52:35 -05:00
\wxheading { Note}
wxHtmlWindow uses the \helpref { wxImage} { wximage} class for displaying images.
Don't forget to initialize all image formats you need before loading any page!
(See \helpref { wxInitAllImageHandlers} { wxinitallimagehandlers} and
\helpref { wxImage::AddHandler} { wximageaddhandler} .)
1999-07-10 17:17:24 -04:00
\wxheading { Derived from}
2000-02-27 16:06:58 -05:00
\helpref { wxScrolledWindow} { wxscrolledwindow}
1999-07-10 17:17:24 -04:00
\wxheading { Include files}
2000-02-27 16:06:58 -05:00
<wx/html/htmlwin.h>
1999-07-10 17:17:24 -04:00
2003-06-05 17:32:56 -04:00
\wxheading { Window styles}
\twocolwidtha { 5cm}
\begin { twocollist} \itemsep =0pt
\twocolitem { \windowstyle { wxHW\_ SCROLLBAR\_ NEVER} } { Never display scrollbars, not
even when the page is larger than the window.}
2004-02-27 11:56:52 -05:00
\twocolitem { \windowstyle { wxHW\_ SCROLLBAR\_ AUTO} } { Display scrollbars only if
2003-06-05 17:32:56 -04:00
page's size exceeds window's size.}
2004-02-27 11:56:52 -05:00
\twocolitem { \windowstyle { wxHW\_ NO\_ SELECTION} } { Don't allow the user to select
2003-06-05 17:32:56 -04:00
text.}
\end { twocollist}
2006-10-29 15:26:03 -05:00
\wxheading { Event handling}
To process input from a wxHtmlWindow, use these event handler macros to direct input to member
functions that take a \helpref { wxHtmlCellEvent} { wxhtmlcellevent} argument or a \helpref { wxHtmlLinkEvent} { wxhtmllinkevent} .
\twocolwidtha { 7cm}
\begin { twocollist} \itemsep =0pt
2006-11-18 12:41:32 -05:00
\twocolitem { { \bf EVT\_ HTML\_ CELL\_ CLICKED(id, func)} } { A \helpref { wxHtmlCell} { wxhtmlcell} was clicked.}
2006-12-02 13:17:33 -05:00
\twocolitem { { \bf EVT\_ HTML\_ CELL\_ HOVER(id, func)} } { The mouse passed over a \helpref { wxHtmlCell} { wxhtmlcell} .}
2006-11-18 12:41:32 -05:00
\twocolitem { { \bf EVT\_ HTML\_ LINK\_ CLICKED(id, func)} } { A \helpref { wxHtmlCell} { wxhtmlcell} which contains an hyperlink was clicked.}
2006-10-29 15:26:03 -05:00
\end { twocollist}
\wxheading { See also}
\helpref { wxHtmlLinkEvent} { wxhtmllinkevent} , \helpref { wxHtmlCellEvent} { wxhtmlcellevent}
1999-07-10 17:17:24 -04:00
\membersection { wxHtmlWindow::wxHtmlWindow} \label { wxhtmlwindowwxhtmlwindow}
\func { } { wxHtmlWindow} { \void }
Default constructor.
2005-04-01 07:35:41 -05:00
\func { } { wxHtmlWindow} { \param { wxWindow } { *parent} , \param { wxWindowID } { id = -1} , \param { const wxPoint\& } { pos = wxDefaultPosition} , \param { const wxSize\& } { size = wxDefaultSize} , \param { long } { style = wxHW\_ DEFAULT\_ STYLE} , \param { const wxString\& } { name = "htmlWindow"} }
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
Constructor. The parameters are the same as for the \helpref { wxScrolledWindow} { wxscrolledwindow} constructor.
1999-07-10 17:17:24 -04:00
\wxheading { Parameters}
2003-06-05 17:32:56 -04:00
\docparam { style} { Window style. See \helpref { wxHtmlWindow} { wxhtmlwindow} .}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::AddFilter} \label { wxhtmlwindowaddfilter}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\func { static void} { AddFilter} { \param { wxHtmlFilter } { *filter} }
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
Adds \helpref { input filter} { filters} to the static list of available
filters. These filters are present by default:
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
\begin { itemize} \itemsep =0pt
1999-10-16 11:38:26 -04:00
\item { \tt text/html} MIME type
\item { \tt image/*} MIME types
\item Plain Text filter (this filter is used if no other filter matches)
\end { itemize}
1999-07-10 17:17:24 -04:00
2001-10-14 18:20:05 -04:00
\membersection { wxHtmlWindow::AppendToPage} \label { wxhtmlwindowappendtopage}
\func { bool} { AppendToPage} { \param { const wxString\& } { source} }
Appends HTML fragment to currently displayed text and refreshes the window.
\wxheading { Parameters}
\docparam { source} { HTML code fragment}
\wxheading { Return value}
2003-01-17 19:16:34 -05:00
false if an error occurred, true otherwise.
2001-10-14 18:20:05 -04:00
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::GetInternalRepresentation} \label { wxhtmlwindowgetinternalrepresentation}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\constfunc { wxHtmlContainerCell*} { GetInternalRepresentation} { \void }
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
Returns pointer to the top-level container.
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
See also: \helpref { Cells Overview} { cells} ,
\helpref { Printing Overview} { printing}
1999-07-10 17:17:24 -04:00
2000-01-25 19:50:29 -05:00
\membersection { wxHtmlWindow::GetOpenedAnchor} \label { wxhtmlwindowgetopenedanchor}
\func { wxString} { GetOpenedAnchor} { \void }
Returns anchor within currently opened page
(see \helpref { GetOpenedPage} { wxhtmlwindowgetopenedpage} ).
If no page is opened or if the displayed page wasn't
produced by call to LoadPage, empty string is returned.
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::GetOpenedPage} \label { wxhtmlwindowgetopenedpage}
\func { wxString} { GetOpenedPage} { \void }
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.
1999-11-28 13:24:57 -05:00
\membersection { wxHtmlWindow::GetOpenedPageTitle} \label { wxhtmlwindowgetopenedpagetitle}
\func { wxString} { GetOpenedPageTitle} { \void }
Returns title of the opened page or wxEmptyString if current page does not contain { \tt <TITLE>} tag.
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::GetRelatedFrame} \label { wxhtmlwindowgetrelatedframe}
\constfunc { wxFrame*} { GetRelatedFrame} { \void }
Returns the related frame.
\membersection { wxHtmlWindow::HistoryBack} \label { wxhtmlwindowhistoryback}
\func { bool} { HistoryBack} { \void }
Moves back to the previous page. (each page displayed using
\helpref { LoadPage} { wxhtmlwindowloadpage} is stored in history list.)
2000-10-10 18:07:16 -04:00
\membersection { wxHtmlWindow::HistoryCanBack} \label { wxhtmlwindowhistorycanback}
\func { bool} { HistoryCanBack} { \void }
Returns true if it is possible to go back in the history (i.e. HistoryBack()
won't fail).
\membersection { wxHtmlWindow::HistoryCanForward} \label { wxhtmlwindowhistorycanforward}
\func { bool} { HistoryCanForward} { \void }
Returns true if it is possible to go forward in the history (i.e. HistoryBack()
won't fail).
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::HistoryClear} \label { wxhtmlwindowhistoryclear}
\func { void} { HistoryClear} { \void }
Clears history.
\membersection { wxHtmlWindow::HistoryForward} \label { wxhtmlwindowhistoryforward}
\func { bool} { HistoryForward} { \void }
Moves to next page in history.
1999-07-10 17:17:24 -04:00
2003-01-26 18:20:00 -05:00
\membersection { wxHtmlWindow::LoadFile} \label { wxhtmlwindowloadfile}
\func { virtual bool} { LoadFile} { \param { const wxFileName\& } { filename} }
Loads HTML page from file and displays it.
\wxheading { Return value}
false if an error occurred, true otherwise
\wxheading { See also}
\helpref { LoadPage} { wxhtmlwindowloadpage}
1999-07-10 17:17:24 -04:00
\membersection { wxHtmlWindow::LoadPage} \label { wxhtmlwindowloadpage}
2001-06-09 15:11:24 -04:00
\func { virtual bool} { LoadPage} { \param { const wxString\& } { location} }
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
Unlike SetPage this function first loads HTML page from { \it location}
1999-07-10 17:17:24 -04:00
and then displays it. See example:
\begin { verbatim}
2003-01-26 18:20:00 -05:00
htmlwin->LoadPage("help/myproject/index.htm");
1999-07-10 17:17:24 -04:00
\end { verbatim}
\wxheading { Parameters}
\docparam { location} { The address of document. See \helpref { wxFileSystem} { wxfilesystem} for details on address format and behaviour of "opener".}
\wxheading { Return value}
2003-01-17 19:16:34 -05:00
false if an error occurred, true otherwise
1999-07-10 17:17:24 -04:00
2003-01-26 18:20:00 -05:00
\wxheading { See also}
\helpref { LoadFile} { wxhtmlwindowloadfile}
2001-08-31 17:19:23 -04:00
\membersection { wxHtmlWindow::OnCellClicked} \label { wxhtmlwindowoncellclicked}
2006-04-13 18:08:28 -04:00
\func { virtual bool} { OnCellClicked} { \param { wxHtmlCell } { *cell} , \param { wxCoord } { x} , \param { wxCoord } { y} , \param { const wxMouseEvent\& } { event} }
2001-08-31 17:19:23 -04:00
This method is called when a mouse button is clicked inside wxHtmlWindow.
2006-10-29 15:26:03 -05:00
The default behaviour is to emit a \helpref { wxHtmlCellEvent} { wxhtmlcellevent}
and, if the event was not processed or skipped, call
\helpref { OnLinkClicked} { wxhtmlwindowonlinkclicked} if the cell contains an
2001-08-31 17:19:23 -04:00
hypertext link.
2006-10-29 15:26:03 -05:00
Overloading this method is deprecated; intercept the event instead.
2001-08-31 17:19:23 -04:00
\wxheading { Parameters}
\docparam { cell} { The cell inside which the mouse was clicked, always a simple
2006-05-28 19:56:51 -04:00
(i.e. non-container) cell}
2001-08-31 17:19:23 -04:00
\docparam { x, y} { The logical coordinates of the click point}
\docparam { event} { The mouse event containing other information about the click}
2006-04-13 18:08:28 -04:00
\wxheading { Return value}
\true if a link was clicked, \false otherwise.
2001-08-31 17:19:23 -04:00
\membersection { wxHtmlWindow::OnCellMouseHover} \label { wxhtmlwindowoncellmousehover}
\func { virtual void} { OnCellMouseHover} { \param { wxHtmlCell } { *cell} , \param { wxCoord } { x} , \param { wxCoord } { y} }
This method is called when a mouse moves over an HTML cell.
2006-10-29 15:26:03 -05:00
Default behaviour is to emit a \helpref { wxHtmlCellEvent} { wxhtmlcellevent} .
Overloading this method is deprecated; intercept the event instead.
2001-08-31 17:19:23 -04:00
\wxheading { Parameters}
\docparam { cell} { The cell inside which the mouse is currently, always a simple
2006-05-28 19:56:51 -04:00
(i.e. non-container) cell}
2001-08-31 17:19:23 -04:00
\docparam { x, y} { The logical coordinates of the click point}
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::OnLinkClicked} \label { wxhtmlwindowonlinkclicked}
1999-07-10 17:17:24 -04:00
2000-02-07 05:14:56 -05:00
\func { virtual void} { OnLinkClicked} { \param { const wxHtmlLinkInfo\& } { link} }
1999-07-10 17:17:24 -04:00
2006-10-29 15:26:03 -05:00
Called when user clicks on hypertext link. Default behaviour is to emit a
\helpref { wxHtmlLinkEvent} { wxhtmllinkevent} and, if the event was not processed
or skipped, call \helpref { LoadPage} { wxhtmlwindowloadpage} and do nothing else.
Overloading this method is deprecated; intercept the event instead.
1999-07-10 17:17:24 -04:00
1999-12-23 16:12:23 -05:00
Also see \helpref { wxHtmlLinkInfo} { wxhtmllinkinfo} .
2002-01-19 18:23:28 -05:00
\membersection { wxHtmlWindow::OnOpeningURL} \label { wxhtmlwindowonopeningurl}
2002-01-27 14:03:10 -05:00
\func { virtual wxHtmlOpeningStatus} { OnOpeningURL} { \param { wxHtmlURLType } { type} ,\param { const wxString\& } { url} , \param { wxString *} { redirect} }
2002-01-19 18:23:28 -05:00
Called when an URL is being opened (either when the user clicks on a link or
2002-01-27 14:03:10 -05:00
an image is loaded). The URL will be opened only if OnOpeningURL returns
{ \tt wxHTML\_ OPEN} . This method is called by
\helpref { wxHtmlParser::OpenURL} { wxhtmlparseropenurl} .
You can override OnOpeningURL to selectively block some
URLs (e.g. for security reasons) or to redirect them elsewhere. Default
behaviour is to always return { \tt wxHTML\_ OPEN} .
2002-01-19 18:23:28 -05:00
2002-01-27 14:03:10 -05:00
\wxheading { Parameters}
\docparam { type} { Indicates type of the resource. Is one of
\begin { twocollist} \itemsep =0pt
\twocolitem { { \bf wxHTML\_ URL\_ PAGE} } { Opening a HTML page.}
\twocolitem { { \bf wxHTML\_ URL\_ IMAGE} } { Opening an image.}
\twocolitem { { \bf wxHTML\_ URL\_ OTHER} } { Opening a resource that doesn't fall into
any other category.}
\end { twocollist} }
\docparam { url} { URL being opened.}
\docparam { redirect} { Pointer to wxString variable that must be filled with an
URL if OnOpeningURL returns { \tt wxHTML\_ REDIRECT} .}
\wxheading { Return value}
\begin { twocollist} \itemsep =0pt
\twocolitem { { \bf wxHTML\_ OPEN} } { Open the URL.}
\twocolitem { { \bf wxHTML\_ BLOCK} } { Deny access to the URL, \helpref { wxHtmlParser::OpenURL} { wxhtmlparseropenurl} will return NULL.}
\twocolitem { { \bf wxHTML\_ REDIRECT} } { Don't open { \it url} , redirect to another
URL. OnOpeningURL must fill { \it *redirect} with the new URL. OnOpeningURL will
be called again on returned URL.}
\end { twocollist}
1999-11-28 13:24:57 -05:00
\membersection { wxHtmlWindow::OnSetTitle} \label { wxhtmlwindowonsettitle}
\func { virtual void} { OnSetTitle} { \param { const wxString\& } { title} }
Called on parsing { \tt <TITLE>} tag.
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::ReadCustomization} \label { wxhtmlwindowreadcustomization}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\func { virtual void} { ReadCustomization} { \param { wxConfigBase } { *cfg} , \param { wxString } { path = wxEmptyString} }
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
This reads custom settings from wxConfig. It uses the path 'path'
if given, otherwise it saves info into currently selected path.
The values are stored in sub-path { \tt wxHtmlWindow}
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
Read values: all things set by SetFonts, SetBorders.
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\wxheading { Parameters}
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
\docparam { cfg} { wxConfig from which you want to read the configuration.}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\docparam { path} { Optional path in config tree. If not given current path is used.}
1999-07-10 17:17:24 -04:00
2004-02-11 07:01:31 -05:00
\membersection { wxHtmlWindow::SelectAll} \label { wxhtmlwindowselectall}
\func { void} { SelectAll} { \void }
Selects all text in the window.
\wxheading { See also}
\helpref { SelectLine} { wxhtmlwindowselectline} ,
\helpref { SelectWord} { wxhtmlwindowselectword}
2004-07-16 14:35:30 -04:00
\membersection { wxHtmlWindow::SelectionToText} \label { wxhtmlwindowselectiontotext}
\func { wxString} { SelectionToText} { \void }
Returns current selection as plain text. Returns empty string if no text
is currently selected.
2004-02-11 07:01:31 -05:00
\membersection { wxHtmlWindow::SelectLine} \label { wxhtmlwindowselectline}
\func { void} { SelectLine} { \param { const wxPoint\& } { pos} }
Selects the line of text that \arg { pos} points at. Note that \arg { pos}
is relative to the top of displayed page, not to window's origin, use
\helpref { CalcUnscrolledPosition} { wxscrolledwindowcalcunscrolledposition}
to convert physical coordinate.
\wxheading { See also}
\helpref { SelectAll} { wxhtmlwindowselectall} ,
\helpref { SelectWord} { wxhtmlwindowselectword}
\membersection { wxHtmlWindow::SelectWord} \label { wxhtmlwindowselectword}
\func { void} { SelectWord} { \param { const wxPoint\& } { pos} }
Selects the word at position \arg { pos} . Note that \arg { pos}
is relative to the top of displayed page, not to window's origin, use
\helpref { CalcUnscrolledPosition} { wxscrolledwindowcalcunscrolledposition}
to convert physical coordinate.
\wxheading { See also}
\helpref { SelectAll} { wxhtmlwindowselectall} ,
\helpref { SelectLine} { wxhtmlwindowselectline}
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::SetBorders} \label { wxhtmlwindowsetborders}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\func { void} { SetBorders} { \param { int } { b} }
This function sets the space between border of window and HTML contents. See image:
1999-12-24 18:40:13 -05:00
\helponly { \image { } { border.bmp} }
1999-07-10 17:17:24 -04:00
\wxheading { Parameters}
1999-10-16 11:38:26 -04:00
\docparam { b} { indentation from borders in pixels}
1999-07-10 17:17:24 -04:00
\membersection { wxHtmlWindow::SetFonts} \label { wxhtmlwindowsetfonts}
2005-09-24 17:43:15 -04:00
\func { void} { SetFonts} { \param { const wxString\& } { normal\_ face} , \param { const wxString\& } { fixed\_ face} , \param { const int } { *sizes = NULL} }
1999-07-10 17:17:24 -04:00
This function sets font sizes and faces.
\wxheading { Parameters}
1999-10-25 09:46:48 -04:00
\docparam { normal\_ face} { This is face name for normal (i.e. non-fixed) font.
2002-06-07 16:15:28 -04:00
It can be either empty string (then the default face is chosen) or
1999-07-10 17:17:24 -04:00
platform-specific face name. Examples are "helvetica" under Unix or
"Times New Roman" under Windows.}
1999-10-25 09:46:48 -04:00
\docparam { fixed\_ face} { The same thing for fixed face ( <TT>..</TT> )}
1999-07-10 17:17:24 -04:00
\docparam { sizes} { This is an array of 7 items of { \it int} type.
The values represent size of font with HTML size from -2 to +4
2003-03-16 15:30:26 -05:00
( <FONT SIZE=-2> to <FONT SIZE=+4> ). Default sizes are used if { \it sizes}
is NULL.}
1999-07-10 17:17:24 -04:00
\wxheading { Defaults}
2003-03-16 15:30:26 -05:00
Default font sizes are defined by constants wxHTML\_ FONT\_ SIZE\_ 1,
wxHTML\_ FONT\_ SIZE\_ 2, ..., wxHTML\_ FONT\_ SIZE\_ 7. Note that they differ among
platforms. Default face names are empty strings.
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::SetPage} \label { wxhtmlwindowsetpage}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\func { bool} { SetPage} { \param { const wxString\& } { source} }
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
Sets HTML page and display it. This won't { \bf load} the page!!
It will display the { \it source} . See example:
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\begin { verbatim}
htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
\end { verbatim}
1999-10-25 09:46:48 -04:00
If you want to load a document from some location use
1999-10-16 11:38:26 -04:00
\helpref { LoadPage} { wxhtmlwindowloadpage} instead.
1999-07-10 17:17:24 -04:00
\wxheading { Parameters}
1999-10-16 11:38:26 -04:00
\docparam { source} { The HTML document source to be displayed.}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\wxheading { Return value}
1999-07-10 17:17:24 -04:00
2003-01-17 19:16:34 -05:00
false if an error occurred, true otherwise.
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::SetRelatedFrame} \label { wxhtmlwindowsetrelatedframe}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\func { void} { SetRelatedFrame} { \param { wxFrame* } { frame} , \param { const wxString\& } { format} }
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
Sets the frame in which page title will be displayed. { \it format} is format of
1999-10-16 11:38:26 -04:00
frame title, e.g. "HtmlHelp : \% s". It must contain exactly one \% s. This
\% s is substituted with HTML page title.
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\membersection { wxHtmlWindow::SetRelatedStatusBar} \label { wxhtmlwindowsetrelatedstatusbar}
1999-07-10 17:17:24 -04:00
1999-10-16 11:38:26 -04:00
\func { void} { SetRelatedStatusBar} { \param { int } { bar} }
{ \bf After} calling \helpref { SetRelatedFrame} { wxhtmlwindowsetrelatedframe} ,
this sets statusbar slot where messages will be displayed.
(Default is -1 = no messages.)
\wxheading { Parameters}
\docparam { bar} { statusbar slot number (0..n)}
1999-07-10 17:17:24 -04:00
2004-07-16 14:35:30 -04:00
\membersection { wxHtmlWindow::ToText} \label { wxhtmlwindowtotext}
\func { wxString} { ToText} { \void }
Returns content of currently displayed page as plain text.
1999-11-28 13:24:57 -05:00
1999-07-10 17:17:24 -04:00
\membersection { wxHtmlWindow::WriteCustomization} \label { wxhtmlwindowwritecustomization}
\func { virtual void} { WriteCustomization} { \param { wxConfigBase } { *cfg} , \param { wxString } { path = wxEmptyString} }
Saves custom settings into wxConfig. It uses the path 'path'
if given, otherwise it saves info into currently selected path.
1999-10-25 09:46:48 -04:00
Regardless of whether the path is given or not, the function creates sub-path
{ \tt wxHtmlWindow} .
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
Saved values: all things set by SetFonts, SetBorders.
1999-07-10 17:17:24 -04:00
\wxheading { Parameters}
1999-10-25 09:46:48 -04:00
\docparam { cfg} { wxConfig to which you want to save the configuration.}
1999-07-10 17:17:24 -04:00
1999-10-25 09:46:48 -04:00
\docparam { path} { Optional path in config tree. If not given, the current path is used.}
1999-07-10 17:17:24 -04:00
2006-10-29 15:26:03 -05:00
\section { \class { wxHtmlLinkEvent} } \label { wxhtmllinkevent}
This event class is used for the events generated by \helpref { wxHtmlWindow} { wxhtmlwindow} .
\wxheading { Derived from}
\helpref { wxCommandEvent} { wxcommandevent} \\
\helpref { wxEvent} { wxevent} \\
\helpref { wxObject} { wxobject}
\wxheading { Include files}
<wx/html/htmlwin.h>
\wxheading { Event handling}
To process input from a wxHtmlLinkEvent, use one of these event handler macros to
direct input to member function that take a \helpref { wxHtmlLinkEvent} { wxhtmllinkevent} argument:
\twocolwidtha { 7cm}
\begin { twocollist}
2006-11-18 12:41:32 -05:00
\twocolitem { { \bf EVT\_ HTML\_ LINK\_ CLICKED(id, func)} } { User clicked on an hyperlink.}
2006-10-29 15:26:03 -05:00
\end { twocollist}
\latexignore { \rtfignore { \wxheading { Members} } }
\membersection { wxHtmlLinkEvent::wxHtmlLinkEvent} \label { wxhtmllinkeventctor}
\func { } { wxHyperlinkEvent} { \param { int} { id} , \param { const wxHtmlLinkInfo \& } { linkinfo} }
The constructor is not normally used by the user code.
\membersection { wxHtmlLinkEvent::GetLinkInfo} \label { wxhtmllinkeventgetlinkinfo}
\constfunc { const wxHtmlLinkInfo & } { GetLinkInfo} { \void }
Returns the \helpref { wxHtmlLinkInfo} { wxhtmllinkinfo} which contains info about the cell clicked and the hyperlink it contains.
\section { \class { wxHtmlCellEvent} } \label { wxhtmlcellevent}
This event class is used for the events generated by \helpref { wxHtmlWindow} { wxhtmlwindow} .
\wxheading { Derived from}
\helpref { wxCommandEvent} { wxcommandevent} \\
\helpref { wxEvent} { wxevent} \\
\helpref { wxObject} { wxobject}
\wxheading { Include files}
<wx/html/htmlwin.h>
\wxheading { Event handling}
To process input from a wxHtmlCellEvent, use one of these event handler macros to
direct input to member function that take a \helpref { wxHtmlCellEvent} { wxhtmlcellevent} argument:
\twocolwidtha { 7cm}
\begin { twocollist}
2006-11-18 12:41:32 -05:00
\twocolitem { { \bf EVT\_ HTML\_ CELL\_ HOVER(id, func)} } { User moved the mouse over a \helpref { wxHtmlCell} { wxhtmlcell} .}
\twocolitem { { \bf EVT\_ HTML\_ CELL\_ CLICKED(id, func)} } { User clicked on a \helpref { wxHtmlCell} { wxhtmlcell} . When handling this event, remember to use \helpref { wxHtmlCell::SetLinkClicked(true)} { wxhtmlcelleventsetlinkclicked} if the cell contains a link.}
2006-10-29 15:26:03 -05:00
\end { twocollist}
\latexignore { \rtfignore { \wxheading { Members} } }
\membersection { wxHtmlCellEvent::wxHtmlCellEvent} \label { wxhtmlcelleventctor}
\func { } { wxHtmlCellEvent} { \param { wxEventType} { commandType} , \param { int} { id} , \param { wxHtmlCell *} { cell} , \param { const wxPoint \& } { point} }
The constructor is not normally used by the user code.
\membersection { wxHtmlCellEvent::GetCell} \label { wxhtmlcelleventgetcell}
\constfunc { wxHtmlCell *} { GetCell} { \void }
Returns the \helpref { wxHtmlCellEvent} { wxhtmlcellevent} associated with the event.
\membersection { wxHtmlCellEvent::GetPoint} \label { wxhtmlcelleventgetpoint}
\constfunc { wxPoint} { GetPoint} { \void }
Returns the \helpref { wxPoint} { wxpoint} associated with the event.
\membersection { wxHtmlCellEvent::SetLinkClicked} \label { wxhtmlcelleventsetlinkclicked}
\func { bool} { SetLinkClicked} { \param { bool} { linkclicked} }
Call this function with { \tt linkclicked} set to \true if the cell which has been clicked contained a link or
\false otherwise (which is the default). With this function the event handler can return info to the
wxHtmlWindow which sent the event.
\membersection { wxHtmlCellEvent::GetLinkClicked} \label { wxhtmlcelleventgetlinkclicked}
\constfunc { bool} { GetLinkClicked} { \void }
Returns \true if \helpref { SetLinkClicked(true)} { wxhtmlcelleventsetlinkclicked} has previously been called;
\false otherwise.