]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/htwinprs.tex
silence gcc warnings about values not handled in switch
[wxWidgets.git] / docs / latex / wx / htwinprs.tex
index 473a8cd0ea8ca66c3eb0c07cba75ddf9b2c22f9b..930306a5afc36cfacd859ad2f7bfa9086c2d1ec8 100644 (file)
@@ -6,7 +6,7 @@
 \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
 
 This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
-its mail goal is to parse HTML input so that it can be displayed in
+its main goal is to parse HTML input so that it can be displayed in
 \helpref{wxHtmlWindow}{wxhtmlwindow}. It uses a special 
 \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
 
@@ -32,10 +32,12 @@ The product of parsing is a wxHtmlCell (resp. wxHtmlContainer) object.
 
 \func{}{wxHtmlWinParser}{\void}
 
-\func{}{wxHtmlWinParser}{\param{wxHtmlWindow }{*wnd}}
+\func{}{wxHtmlWinParser}{\param{wxHtmlWindowInterface }{*wndIface}}
 
 Constructor. Don't use the default one, use constructor with
-{\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})
+{\it wndIface} parameter ({\it wndIface} is a pointer to interface object for
+the associated \helpref{wxHtmlWindow}{wxhtmlwindow} or other HTML rendering
+window such as \helpref{wxHtmlListBox}{wxhtmllistbox}).
 
 \membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
 
@@ -43,14 +45,6 @@ Constructor. Don't use the default one, use constructor with
 
 Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.
 
-\membersection{wxHtmlWinParser::CanOpenURL}\label{wxhtmlwinparsercanopenurl}
-
-\func{virtual bool}{CanOpenURL}{\param{const wxString\& }{url}}
-
-Call this function to determine whether you are allowed to open given URL. 
-Default behaviour is to call \helpref{wxHtmlWindow::OnOpeningURL}{wxhtmlwindowonopeningurl}
-of the associated wxHtmlWindow object.
-
 \membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer}
 
 \func{wxHtmlContainerCell*}{CloseContainer}{\void}
@@ -106,7 +100,7 @@ know the height of the current font, call {\tt GetDC -> GetCharWidth()}
 
 \constfunc{wxHtmlContainerCell*}{GetContainer}{\void}
 
-Returns pointer to the currectly opened container (see \helpref{Overview}{cells}).
+Returns pointer to the currently opened container (see \helpref{Overview}{cells}).
 Common use:
 
 \begin{verbatim}
@@ -131,7 +125,7 @@ and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
 
 \constfunc{int}{GetFontBold}{\void}
 
-Returns TRUE if actual font is bold, FALSE otherwise.
+Returns true if actual font is bold, false otherwise.
 
 \membersection{wxHtmlWinParser::GetFontFace}\label{wxhtmlwinparsergetfontface}
 
@@ -143,13 +137,13 @@ Returns actual font face name.
 
 \constfunc{int}{GetFontFixed}{\void}
 
-Returns TRUE if actual font is fixed face, FALSE otherwise.
+Returns true if actual font is fixed face, false otherwise.
 
 \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic}
 
 \constfunc{int}{GetFontItalic}{\void}
 
-Returns TRUE if actual font is italic, FALSE otherwise.
+Returns true if actual font is italic, false otherwise.
 
 \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
 
@@ -161,7 +155,7 @@ Returns actual font size (HTML size varies from -2 to +4)
 
 \constfunc{int}{GetFontUnderlined}{\void}
 
-Returns TRUE if actual font is underlined, FALSE otherwise.
+Returns true if actual font is underlined, false otherwise.
 
 \membersection{wxHtmlWinParser::GetInputEncoding}\label{wxhtmlwinparsergetinputencoding}
 
@@ -241,7 +235,7 @@ inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
 
 \func{void}{SetFontBold}{\param{int }{x}}
 
-Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
+Sets bold flag of actualfont. {\it x} is either true of false.
 
 \membersection{wxHtmlWinParser::SetFontFace}\label{wxhtmlwinparsersetfontface}
 
@@ -255,13 +249,13 @@ inside {\tt <TT>} tag or not).
 
 \func{void}{SetFontFixed}{\param{int }{x}}
 
-Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
+Sets fixed face flag of actualfont. {\it x} is either true of false.
 
 \membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic}
 
 \func{void}{SetFontItalic}{\param{int }{x}}
 
-Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
+Sets italic flag of actualfont. {\it x} is either true of false.
 
 \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
 
@@ -273,13 +267,14 @@ Sets actual font size (HTML size varies from 1 to 7)
 
 \func{void}{SetFontUnderlined}{\param{int }{x}}
 
-Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
+Sets underlined flag of actualfont. {\it x} is either true of false.
 
 \membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}
 
-\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes}}
+\func{void}{SetFonts}{\param{const wxString\& }{normal\_face}, \param{const wxString\& }{fixed\_face}, \param{const int }{*sizes = NULL}}
 
-Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
+Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
+detailed description.
 
 \membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}