X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5656c6ef369f69d25e201cdfee727d2a8c2721b5..4c7852186d48a5b8f406462c2c3fa020f0a052bb:/docs/latex/wx/htwindow.tex diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index 2093c7c37b..884d185105 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -13,17 +13,17 @@ 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 +Once the window is created you can set its content by calling \helpref{SetPage(text)}{wxhtmlwindowsetpage} or \helpref{LoadPage(filename)}{wxhtmlwindowloadpage}. \wxheading{Derived from} -wxScrolledWindow +\helpref{wxScrolledWindow}{wxscrolledwindow} \wxheading{Include files} - + \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow} @@ -98,6 +98,21 @@ Returns the related frame. 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} @@ -112,7 +127,7 @@ Moves to next page in history. \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} and then displays it. See example: @@ -127,11 +142,42 @@ htmlwin -> SetPage("help/myproject/index.htm"); \wxheading{Return value} -FALSE if an error occured, TRUE otherwise +FALSE if an error occurred, TRUE otherwise + +\membersection{wxHtmlWindow::OnCellClicked}\label{wxhtmlwindowoncellclicked} + +\func{virtual void}{OnCellClicked}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxMouseEvent\& }{event}} + +This method is called when a mouse button is clicked inside wxHtmlWindow. +The default behaviour is to call +\helpref{OnLinkClicked}{wxhtmlwindowonlinkclicked} if the cell contains a +hypertext link. + +\wxheading{Parameters} + +\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} + +\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. + +\wxheading{Parameters} + +\docparam{cell}{The cell inside which the mouse is currently, always a simple +(i.e. non container) cell} + +\docparam{x, y}{The logical coordinates of the click point} \membersection{wxHtmlWindow::OnLinkClicked}\label{wxhtmlwindowonlinkclicked} -\func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo& }{link}} +\func{virtual void}{OnLinkClicked}{\param{const wxHtmlLinkInfo\& }{link}} Called when user clicks on hypertext link. Default behaviour is to call \helpref{LoadPage}{wxhtmlwindowloadpage} and do nothing else. @@ -230,7 +276,7 @@ If you want to load a document from some location use \wxheading{Return value} -FALSE if an error occured, TRUE otherwise. +FALSE if an error occurred, TRUE otherwise. \membersection{wxHtmlWindow::SetRelatedFrame}\label{wxhtmlwindowsetrelatedframe}