wxApp destructor is virtual [ patch 1283503 ]

[wxWidgets.git] / docs / latex / wx / htwindow.tex

diff --git a/docs/latex/wx/htwindow.tex b/docs/latex/wx/htwindow.tex
index 0d367e91cf990754db48e41bbbb3372b9268ae0a..52bf97972fb5a6d3862540b1e12491e77b7f7c47 100644 (file)
--- a/docs/latex/wx/htwindow.tex
+++ b/docs/latex/wx/htwindow.tex
@@ -33,20 +33,31 @@ Don't forget to initialize all image formats you need before loading any page!
 
 <wx/html/htmlwin.h>
 
+\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}
+
 \membersection{wxHtmlWindow::wxHtmlWindow}\label{wxhtmlwindowwxhtmlwindow}
 
 \func{}{wxHtmlWindow}{\void}
 
 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.
 
 \wxheading{Parameters}
 
-\docparam{style}{wxHW\_SCROLLBAR\_NEVER,  or wxHW\_SCROLLBAR\_AUTO. 
-Affects the appearance of vertical scrollbar in the window.}
+\docparam{style}{Window style. See \helpref{wxHtmlWindow}{wxhtmlwindow}.}
 
 \membersection{wxHtmlWindow::AddFilter}\label{wxhtmlwindowaddfilter}
 
@@ -283,6 +294,52 @@ Read values: all things set by SetFonts, SetBorders.
 
 \docparam{path}{Optional path in config tree. If not given current path is used.}
 
+\membersection{wxHtmlWindow::SelectAll}\label{wxhtmlwindowselectall}
+
+\func{void}{SelectAll}{\void}
+
+Selects all text in the window.
+
+\wxheading{See also}
+
+\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}}
+
+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}
+
 \membersection{wxHtmlWindow::SetBorders}\label{wxhtmlwindowsetborders}
 
 \func{void}{SetBorders}{\param{int }{b}}
@@ -297,7 +354,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}}
+\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}}
 
 This function sets font sizes and faces.
 
@@ -312,24 +369,14 @@ platform-specific face name. Examples are "helvetica" under Unix or
 
 \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> )}
+( <FONT SIZE=-2> to <FONT SIZE=+4> ). Default sizes are used if {\it sizes}
+is NULL.}
 
 \wxheading{Defaults}
 
-Under wxGTK:
-
-\begin{verbatim}
-    SetFonts("", "", {10, 12, 14, 16, 19, 24, 32});
-\end{verbatim}
-
-Under Windows:
-
-\begin{verbatim}
-    SetFonts("", "", {7, 8, 10, 12, 16, 22, 30});
-\end{verbatim}
-
-Although it seems different the fact is that the fonts are of approximately
-same size under both platforms (due to wxMSW / wxGTK inconsistency)
+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}
 
@@ -373,6 +420,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}