X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa482912e420a40e9f2e55a0f5407562826dd15e..36d55705af108772d5ecf9b5ebcc3e651c840b3d:/docs/latex/wx/htwinprs.tex?ds=sidebyside diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex index feea123a7c..930306a5af 100644 --- a/docs/latex/wx/htwinprs.tex +++ b/docs/latex/wx/htwinprs.tex @@ -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{wxWindow }{*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} @@ -80,7 +82,7 @@ Returns default horizontal alignment. \constfunc{int}{GetCharHeight}{\void} -Returns (average) char height in standard font. It's used as DC-independent metrics. +Returns (average) char height in standard font. It is used as DC-independent metrics. {\bf Note:} This function doesn't return the {\it actual} height. If you want to know the height of the current font, call {\tt GetDC -> GetCharHeight()}. @@ -89,7 +91,7 @@ know the height of the current font, call {\tt GetDC -> GetCharHeight()}. \constfunc{int}{GetCharWidth}{\void} -Returns average char width in standard font. It's used as DC-independent metrics. +Returns average char width in standard font. It is used as DC-independent metrics. {\bf Note:} This function doesn't return the {\it actual} width. If you want to know the height of the current font, call {\tt GetDC -> GetCharWidth()} @@ -98,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} @@ -123,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} @@ -135,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} @@ -153,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} @@ -185,7 +187,7 @@ that is supported by operating system. \membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow} -\func{wxWindow*}{GetWindow}{\void} +\func{wxHtmlWindow*}{GetWindow}{\void} Returns associated window (wxHtmlWindow). This may be NULL! (You should always test if it is non-NULL. For example {\tt TITLE} handler sets window @@ -233,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} @@ -247,13 +249,13 @@ inside {\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} @@ -265,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}