X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ec59d2ccea39b0225f49e6dd326d4d11940d656d..4e9da8b79e9218bf194f70af9b5ad706967c0099:/docs/latex/wx/htwindow.tex diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex index d38a1e0d8d..eddfc34f44 100644 --- a/docs/latex/wx/htwindow.tex +++ b/docs/latex/wx/htwindow.tex @@ -51,7 +51,7 @@ text.} 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 the same as for the \helpref{wxScrolledWindow}{wxscrolledwindow} constructor. @@ -197,7 +197,7 @@ 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}} +\func{virtual bool}{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 @@ -207,12 +207,16 @@ hypertext link. \wxheading{Parameters} \docparam{cell}{The cell inside which the mouse was clicked, always a simple -(i.e. non container) cell} +(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} + +\true if a link was clicked, \false otherwise. + \membersection{wxHtmlWindow::OnCellMouseHover}\label{wxhtmlwindowoncellmousehover} \func{virtual void}{OnCellMouseHover}{\param{wxHtmlCell }{*cell}, \param{wxCoord }{x}, \param{wxCoord }{y}} @@ -222,7 +226,7 @@ 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} +(i.e. non-container) cell} \docparam{x, y}{The logical coordinates of the click point} @@ -305,6 +309,13 @@ Selects all text in the window. \helpref{SelectLine}{wxhtmlwindowselectline}, \helpref{SelectWord}{wxhtmlwindowselectword} +\membersection{wxHtmlWindow::SelectionToText}\label{wxhtmlwindowselectiontotext} + +\func{wxString}{SelectionToText}{\void} + +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}} @@ -347,7 +358,7 @@ This function sets the space between border of window and HTML contents. See ima \membersection{wxHtmlWindow::SetFonts}\label{wxhtmlwindowsetfonts} -\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}} +\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}} This function sets font sizes and faces. @@ -413,6 +424,11 @@ this sets statusbar slot where messages will be displayed. \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}