X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ea8fe90e650f3c73ed90b7e9e36ee4f35bb34c07..2cd78b2a875c3b7abd8a9f1025e164124fae0088:/docs/latex/wx/htwindow.tex diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index d7456b77c5..6a7d4ba917 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -3,29 +3,67 @@ % 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 -handlers or MIME filters) +handlers or MIME filters). + +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. +Once the window is created you can set its content by calling +\helpref{SetPage(text)}{wxhtmlwindowsetpage}, +\helpref{LoadPage(filename)}{wxhtmlwindowloadpage} or +\helpref{LoadFile}{wxhtmlwindowloadfile}. -Purpose of this class is to display HTML page (either local -file or downloaded via HTTP protocol) in a window. Width -of window is constant - given in constructor - virtual height -is changed dynamicly depending on page size. -Once the window is created you can set it's content by calling -\helpref{SetPage(text)}{wxhtmlwindowsetpage} or -\helpref{LoadPage(filename)}{wxhtmlwindowloadpage}. +\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}.) \wxheading{Derived from} -wxScrolledWindow +\helpref{wxScrolledWindow}{wxscrolledwindow} \wxheading{Include files} - + + +\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.} +\twocolitem{\windowstyle{wxHW\_SCROLLBAR\_AUTO}}{Display scrollbars only if +page's size exceeds window's size.} +\twocolitem{\windowstyle{wxHW\_NO\_SELECTION}}{Don't allow the user to select +text.} +\end{twocollist} + + +\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 +\twocolitem{{\bf EVT\_HTML\_CELL\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} was clicked.} +\twocolitem{{\bf EVT\_HTML\_CELL\_HOVER(id, func)}}{The mouse passed over a \helpref{wxHtmlCell}{wxhtmlcell}.} +\twocolitem{{\bf EVT\_HTML\_LINK\_CLICKED(id, func)}}{A \helpref{wxHtmlCell}{wxhtmlcell} which contains an hyperlink was clicked.} +\end{twocollist} + + +\wxheading{See also} + +\helpref{wxHtmlLinkEvent}{wxhtmllinkevent}, \helpref{wxHtmlCellEvent}{wxhtmlcellevent} + + \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow} @@ -33,50 +71,136 @@ wxScrolledWindow Default constructor. -\func{}{wxHtmlWindow}{\param{wxWindow }{*parent}, \param{wxWindowID }{id = -1}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxHW_SCROLLBAR_AUTO}, \param{const wxString\& }{name = "htmlWindow"}} +\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"}} -Constructor. The parameters are same as in wxScrollWindow ctor. -(Too lazy to document it once again... :-) +Constructor. The parameters are the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor. \wxheading{Parameters} -\docparam{style}{wxHW_SCROLLBAR_NEVER, or wxHW_SCROLLBAR_AUTO. -Affects appearance of vertical scrollbar in the window.} +\docparam{style}{Window style. See \helpref{wxHtmlWindow}{wxhtmlwindow}.} +\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter} +\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}} -\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage} +Adds \helpref{input filter}{filters} to the static list of available +filters. These filters are present by default: -\func{bool}{SetPage}{\param{const wxString\& }{source}} +\begin{itemize}\itemsep=0pt +\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} -Sets HTML page and display it. This won't {\bf load} the page!! -It will display the {\it source}. See example: +\membersection{wxHtmlWindow::AppendToPage}\label{wxhtmlwindowappendtopage} -\begin{verbatim} -htmlwin -> SetPage("Hello, world!"); -\end{verbatim} +\func{bool}{AppendToPage}{\param{const wxString\& }{source}} -If you want to load document from some location use -\helpref{LoadPage}{wxhtmlwindowloadpage} instead. +Appends HTML fragment to currently displayed text and refreshes the window. \wxheading{Parameters} -\docparam{source}{The HTML document source to be displayed.} +\docparam{source}{HTML code fragment} + +\wxheading{Return value} + +false if an error occurred, true otherwise. + +\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation} + +\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void} + +Returns pointer to the top-level container. + +See also: \helpref{Cells Overview}{cells}, +\helpref{Printing Overview}{printing} + +\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. + + +\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. + +\membersection{wxHtmlWindow::GetOpenedPageTitle}\label{wxhtmlwindowgetopenedpagetitle} + +\func{wxString}{GetOpenedPageTitle}{\void} + +Returns title of the opened page or wxEmptyString if current page does not contain {\tt } tag. + +\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.) + +\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). + + +\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. + +\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 occured, TRUE otherwise +false if an error occurred, true otherwise + +\wxheading{See also} + +\helpref{LoadPage}{wxhtmlwindowloadpage} \membersection{wxHtmlWindow::LoadPage}\label{wxhtmlwindowloadpage} -\func{bool}{LoadPage}{\param{const wxString\& }{location}} +\func{virtual bool}{LoadPage}{\param{const wxString\& }{location}} -Unlike SetPage this function first loads HTML page from {\it location} +Unlike SetPage this function first loads HTML page from {\it location} and then displays it. See example: \begin{verbatim} -htmlwin -> SetPage("help/myproject/index.htm"); +htmlwin->LoadPage("help/myproject/index.htm"); \end{verbatim} \wxheading{Parameters} @@ -85,93 +209,169 @@ htmlwin -> SetPage("help/myproject/index.htm"); \wxheading{Return value} -FALSE if an error occured, TRUE otherwise +false if an error occurred, true otherwise +\wxheading{See also} +\helpref{LoadFile}{wxhtmlwindowloadfile} -\membersection{wxHtmlWindow::GetOpenedPage}\label{wxhtmlwindowgetopenedpage} +\membersection{wxHtmlWindow::OnCellClicked}\label{wxhtmlwindowoncellclicked} -\func{wxString}{GetOpenedPage}{\void} +\func{virtual bool}{OnCellClicked}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxMouseEvent\& }{event}} -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. +This method is called when a mouse button is clicked inside wxHtmlWindow. +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 +hypertext link. +Overloading this method is deprecated; intercept the event instead. -\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} -\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}} +\wxheading{Parameters} -Sets frame in which page title will be displayed. {\it format} is format of -frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This -\%s is substituted with HTML page title. +\docparam{cell}{The cell inside which the mouse was clicked, always a simple +(i.e. non-container) cell} +\docparam{x, y}{The logical coordinates of the click point} +\docparam{event}{The mouse event containing other information about the click} +\wxheading{Return value} -\membersection{wxHtmlWindow::GetRelatedFrame}\label{wxhtmlwindowgetrelatedframe} +\true if a link was clicked, \false otherwise. -\constfunc{wxFrame*}{GetRelatedFrame}{\void} +\membersection{wxHtmlWindow::OnCellMouseHover}\label{wxhtmlwindowoncellmousehover} -Returns the related frame. +\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. +Default behaviour is to emit a \helpref{wxHtmlCellEvent}{wxhtmlcellevent}. +Overloading this method is deprecated; intercept the event instead. -\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} +\wxheading{Parameters} -\func{void}{SetRelatedStatusBar}{\param{int }{bar}} +\docparam{cell}{The cell inside which the mouse is currently, always a simple +(i.e. non-container) cell} -{\bf After} calling \helpref{SetRelatedFrame}{wxhtmlwindowsetrelatedframe}, -this sets statusbar slot where messages will be displayed. -(Default is -1 = no messages.) +\docparam{x, y}{The logical coordinates of the click point} + +\membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} + +\func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}} + +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. + +Also see \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}. + +\membersection{wxHtmlWindow::OnOpeningURL}\label{wxhtmlwindowonopeningurl} + +\func{virtual wxHtmlOpeningStatus}{OnOpeningURL}{\param{wxHtmlURLType }{type},\param{const wxString\& }{url}, \param{wxString *}{redirect}} + +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 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}. \wxheading{Parameters} -\docparam{bar}{statusbar slot number (0..n)} +\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}} -\membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts} +\docparam{url}{URL being opened.} -\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{int }{*sizes}} +\docparam{redirect}{Pointer to wxString variable that must be filled with an +URL if OnOpeningURL returns {\tt wxHTML\_REDIRECT}.} -This function sets font sizes and faces. +\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} + +\membersection{wxHtmlWindow::OnSetTitle}\label{wxhtmlwindowonsettitle} + +\func{virtual void}{OnSetTitle}{\param{const wxString\& }{title}} + +Called on parsing {\tt <TITLE>} tag. + + +\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization} + +\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}} + +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} + +Read values: all things set by SetFonts, SetBorders. \wxheading{Parameters} -\docparam{normal_face}{This is face name for normal (i.e. non-fixed) font. -It can be either empty string (then the default face is choosen) or -platform-specific face name. Examples are "helvetica" under Unix or -"Times New Roman" under Windows.} +\docparam{cfg}{wxConfig from which you want to read the configuration.} -\docparam{normal_italic_mode}{This is either wxSLANT or wxITALIC. -It determines how -italic (<I>..</I>) text is handled. See wxFont documentation for -details. For example you should use wxSLANT in conjuction with -"helvetica" face or wxITALIC with "times" face.} +\docparam{path}{Optional path in config tree. If not given current path is used.} -\docparam{fixed_face}{The same thing for fixed face ( <TT>..</TT> )} +\membersection{wxHtmlWindow::SelectAll}\label{wxhtmlwindowselectall} -\docparam{fixed_italic_mode}{The same thing for fixed face.} +\func{void}{SelectAll}{\void} -\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 -( <FONT SIZE=-2> to <FONT SIZE=+4> )} +Selects all text in the window. -\wxheading{Defaults} +\wxheading{See also} -Under wxGTK: +\helpref{SelectLine}{wxhtmlwindowselectline}, +\helpref{SelectWord}{wxhtmlwindowselectword} -\begin{verbatim} - SetFonts("", wxSLANT, "", wxSLANT, {10, 12, 14, 16, 19, 24, 32}); -\end{verbatim} +\membersection{wxHtmlWindow::SelectionToText}\label{wxhtmlwindowselectiontotext} -Under Windows: +\func{wxString}{SelectionToText}{\void} -\begin{verbatim} - SetFonts("", wxSLANT, "", wxSLANT, {7, 8, 10, 12, 16, 22, 30}); -\end{verbatim} +Returns current selection as plain text. Returns empty string if no text +is currently selected. + +\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} -Athough it seems different the fact is that the fonts are of approximately -same size under both platforms (due to wxMSW / wxGTK inconsistency) +\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} \membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders} @@ -179,29 +379,85 @@ same size under both platforms (due to wxMSW / wxGTK inconsistency) This function sets the space between border of window and HTML contents. See image: -\image{}{border.bmp} +\helponly{\image{}{border.bmp}} \wxheading{Parameters} \docparam{b}{indentation from borders in pixels} +\membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts} -\membersection{wxHtmlWindow::ReadCustomization}\label{wxhtmlwindowreadcustomization} +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} -\func{virtual void}{ReadCustomization}{\param{wxConfigBase }{*cfg}, \param{wxString }{path = wxEmptyString}} +This function sets font sizes and faces. -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} +\wxheading{Parameters} + +\docparam{normal\_face}{This is face name for normal (i.e. non-fixed) font. +It can be either empty string (then the default face is chosen) or +platform-specific face name. Examples are "helvetica" under Unix or +"Times New Roman" under Windows.} + +\docparam{fixed\_face}{The same thing for fixed face ( <TT>..</TT> )} + +\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 +( <FONT SIZE=-2> to <FONT SIZE=+4> ). Default sizes are used if {\it sizes} +is NULL.} -Read values : all things set by SetFonts, SetBorders. +\wxheading{Defaults} + +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. + +\membersection{wxHtmlWindow::SetPage}\label{wxhtmlwindowsetpage} + +\func{bool}{SetPage}{\param{const wxString\& }{source}} + +Sets HTML page and display it. This won't {\bf load} the page!! +It will display the {\it source}. See example: + +\begin{verbatim} +htmlwin -> SetPage("<html><body>Hello, world!</body></html>"); +\end{verbatim} + +If you want to load a document from some location use +\helpref{LoadPage}{wxhtmlwindowloadpage} instead. \wxheading{Parameters} -\docparam{cfg}{wxConfig from which you wanna read configuration} +\docparam{source}{The HTML document source to be displayed.} -\docparam{path}{Optional path in config tree. If not given current path is used.} +\wxheading{Return value} + +false if an error occurred, true otherwise. +\membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe} + +\func{void}{SetRelatedFrame}{\param{wxFrame* }{frame}, \param{const wxString\& }{format}} + +Sets the frame in which page title will be displayed. {\it format} is format of +frame title, e.g. "HtmlHelp : \%s". It must contain exactly one \%s. This +\%s is substituted with HTML page title. + +\membersection{wxHtmlWindow::SetRelatedStatusBar}\label{wxhtmlwindowsetrelatedstatusbar} + +\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)} + +\membersection{wxHtmlWindow::ToText}\label{wxhtmlwindowtotext} + +\func{wxString}{ToText}{\void} + +Returns content of currently displayed page as plain text. \membersection{wxHtmlWindow::WriteCustomization}\label{wxhtmlwindowwritecustomization} @@ -209,69 +465,130 @@ Read values : all things set by SetFonts, SetBorders. Saves custom settings into wxConfig. It uses the path 'path' if given, otherwise it saves info into currently selected path. -Regardless path is given or not the function creates sub-path -{\tt wxHtmlWindow} +Regardless of whether the path is given or not, the function creates sub-path +{\tt wxHtmlWindow}. -Saved values : all things set by SetFonts, SetBorders. +Saved values: all things set by SetFonts, SetBorders. \wxheading{Parameters} -\docparam{cfg}{wxConfig to which you wanna save configuration} +\docparam{cfg}{wxConfig to which you want to save the configuration.} -\docparam{path}{Optional path in config tree. If not given current path is used.} +\docparam{path}{Optional path in config tree. If not given, the current path is used.} -\membersection{wxHtmlWindow::GetInternalRepresentation}\label{wxhtmlwindowgetinternalrepresentation} -\constfunc{wxHtmlContainerCell*}{GetInternalRepresentation}{\void} -Returns pointer to the top-level container. -See also : -\helpref{Cells Overview}{cells}, -\helpref{Printing Overview}{printing} -\membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter} +\section{\class{wxHtmlLinkEvent}}\label{wxhtmllinkevent} -\func{static void}{AddFilter}{\param{wxHtmlFilter }{*filter}} +This event class is used for the events generated by \helpref{wxHtmlWindow}{wxhtmlwindow}. -Adds \helpref{input filter}{filters} to the static list of available -filters. These filters are present by default: +\wxheading{Derived from} -\begin{itemize} -\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} +\helpref{wxCommandEvent}{wxcommandevent}\\ +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} +\wxheading{Include files} -\membersection{wxHtmlWindow::HistoryBack}\label{wxhtmlwindowhistoryback} +<wx/html/htmlwin.h> -\func{bool}{HistoryBack}{\void} +\wxheading{Event handling} -Moves back to the previous page. (each page displayed using -\helpref{LoadPage}{wxhtmlwindowloadpage} is stored in history list.) +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} +\twocolitem{{\bf EVT\_HTML\_LINK\_CLICKED(id, func)}}{User clicked on an hyperlink.} +\end{twocollist} -\membersection{wxHtmlWindow::HistoryForward}\label{wxhtmlwindowhistoryforward} -\func{bool}{HistoryForward}{\void} +\latexignore{\rtfignore{\wxheading{Members}}} -Moves to next page in history. +\membersection{wxHtmlLinkEvent::wxHtmlLinkEvent}\label{wxhtmllinkeventctor} -\membersection{wxHtmlWindow::HistoryClear}\label{wxhtmlwindowhistoryclear} +\func{}{wxHyperlinkEvent}{\param{int}{ id}, \param{const wxHtmlLinkInfo \&}{ linkinfo}} -\func{void}{HistoryClear}{\void} +The constructor is not normally used by the user code. -Clears history. +\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} +\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.} +\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{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} -\func{virtual void}{OnLinkClicked}{\param{const wxString\& }{link}} +\membersection{wxHtmlCellEvent::GetLinkClicked}\label{wxhtmlcelleventgetlinkclicked} -Called when user clicks on hypertext link. Default behaviour is to call -\helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else. +\constfunc{bool}{GetLinkClicked}{\void} +Returns \true if \helpref{SetLinkClicked(true)}{wxhtmlcelleventsetlinkclicked} has previously been called; +\false otherwise.