added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit

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

diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index 9e3237254516d8fa3dc6528c8c3818fef9178c68..5260ccd2d425f70d462b8569b61ce5248af43b05 100644 (file)
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -3,25 +3,21 @@
 % htmlwinparser.tex at 14/Mar/99 20:13:37
 %
 
 % htmlwinparser.tex at 14/Mar/99 20:13:37
 %
 

-

 \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
 
 This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
 \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
-\helpref{wxHtmlWindow}{wxhtmlwindow}. It uses special
+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}.
 
 \wxheading{Notes}
 
 \helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}.
 
 \wxheading{Notes}
 

-\begin{enumerate}
-\item Product of parsing is wxHtmlCell (resp. wxHtmlContainer) object.
-\end{enumerate}
+The product of parsing is a wxHtmlCell (resp. wxHtmlContainer) object.

 
 \wxheading{Derived from}
 
 \helpref{wxHtmlParser}{wxhtmlparser}
 
 
 \wxheading{Derived from}
 
 \helpref{wxHtmlParser}{wxhtmlparser}
 

-

 \wxheading{Include files}
 
 <wx/html/winpars.h>
 \wxheading{Include files}
 
 <wx/html/winpars.h>


@@ -36,10 +32,10 @@ its mail goal is to parse HTML input so that it can be displayed in
 
 \func{}{wxHtmlWinParser}{\void}
 
 
 \func{}{wxHtmlWinParser}{\void}
 

-\func{}{wxHtmlWinParser}{\param{wxWindow }{*wnd}}
+\func{}{wxHtmlWinParser}{\param{wxHtmlWindow }{*wnd}}

 
 Constructor. Don't use the default one, use constructor with
 
 Constructor. Don't use the default one, use constructor with

-{\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})
+{\it wnd} parameter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})

 
 \membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
 
 
 \membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
 


@@ -58,21 +54,21 @@ and returns pointer to it (see \helpref{Overview}{cells}).
 
 \func{virtual wxFont*}{CreateCurrentFont}{\void}
 
 
 \func{virtual wxFont*}{CreateCurrentFont}{\void}
 

-Creates font based on current setting (see
-\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
-\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
-\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
-\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
+Creates font based on current setting (see 
+\helpref{SetFontSize}{wxhtmlwinparsersetfontsize}, 
+\helpref{SetFontBold}{wxhtmlwinparsersetfontbold}, 
+\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic}, 
+\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed}, 

 \helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
 and returns pointer to it.
 \helpref{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
 and returns pointer to it.

-(If the font was already created only a pointer is returned.)
+If the font was already created only a pointer is returned.

 
 
 \membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
 
 \constfunc{const wxColour\&}{GetActualColor}{\void}
 
 
 
 \membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
 
 \constfunc{const wxColour\&}{GetActualColor}{\void}
 

-Returns actual text color.
+Returns actual text colour.

 
 \membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
 
 
 \membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
 


@@ -84,25 +80,25 @@ Returns default horizontal alignment.
 
 \constfunc{int}{GetCharHeight}{\void}
 
 
 \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 {\it actual} height. If you want to
+{\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()}.
 
 \membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
 
 \constfunc{int}{GetCharWidth}{\void}
 
 know the height of the current font, call {\tt GetDC -> GetCharHeight()}.
 
 \membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
 
 \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 {\it actual} width. If you want to
+{\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()}
 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
 
 \constfunc{wxHtmlContainerCell*}{GetContainer}{\void}
 
 know the height of the current font, call {\tt GetDC -> GetCharWidth()}
 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
 
 \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}
 Common use:
 
 \begin{verbatim}


@@ -115,20 +111,19 @@ m_WParser -> GetContainer() -> InsertCell(new ...);
 
 Returns pointer to the DC used during parsing.
 
 
 Returns pointer to the DC used during parsing.
 

-

 \membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter}
 
 \constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void}
 
 Returns \helpref{wxEncodingConverter}{wxencodingconverter} class used
 \membersection{wxHtmlWinParser::GetEncodingConverter}\label{wxhtmlwinparsergetencodingconverter}
 
 \constfunc{wxEncodingConverter *}{GetEncodingConverter}{\void}
 
 Returns \helpref{wxEncodingConverter}{wxencodingconverter} class used

-to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding}
+to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding} 

 and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \constfunc{int}{GetFontBold}{\void}
 
 and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \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}
 
 
 \membersection{wxHtmlWinParser::GetFontFace}\label{wxhtmlwinparsergetfontface}
 


@@ -136,19 +131,17 @@ Returns TRUE if actual font is bold, FALSE otherwise.
 
 Returns actual font face name.
 
 
 Returns actual font face name.
 

-

 \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
 
 \constfunc{int}{GetFontFixed}{\void}
 
 \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
 
 \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}
 
 
 \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}
 
 
 \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
 


@@ -160,7 +153,7 @@ Returns actual font size (HTML size varies from -2 to +4)
 
 \constfunc{int}{GetFontUnderlined}{\void}
 
 
 \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}
 
 
 \membersection{wxHtmlWinParser::GetInputEncoding}\label{wxhtmlwinparsergetinputencoding}
 


@@ -168,23 +161,20 @@ Returns TRUE if actual font is underlined, FALSE otherwise.
 
 Returns input encoding.
 
 
 Returns input encoding.
 

-

 \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
 
 \constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void}
 
 \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
 
 \constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void}
 

-Returns actual hypertext link. (This value has non-empty
+Returns actual hypertext link. (This value has a non-empty 

 \helpref{Href}{wxhtmllinkinfogethref} string
 if the parser is between {\tt <A>} and {\tt </A>} tags,
 wxEmptyString otherwise.)
 
 \helpref{Href}{wxhtmllinkinfogethref} string
 if the parser is between {\tt <A>} and {\tt </A>} tags,
 wxEmptyString otherwise.)
 

-

 \membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
 
 \constfunc{const wxColour\&}{GetLinkColor}{\void}
 
 \membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
 
 \constfunc{const wxColour\&}{GetLinkColor}{\void}
 

-Returns color of hypertext link text.
-
+Returns the colour of hypertext link text.

 
 \membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding}
 
 
 \membersection{wxHtmlWinParser::GetOutputEncoding}\label{wxhtmlwinparsergetoutputencoding}
 


@@ -195,43 +185,39 @@ that is supported by operating system.
 
 \membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
 
 
 \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
 title only if some window is associated, otherwise it does nothing)
 
 
 Returns associated window (wxHtmlWindow). This may be NULL! (You should always
 test if it is non-NULL. For example {\tt TITLE} handler sets window
 title only if some window is associated, otherwise it does nothing)
 

-

 \membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
 
 \func{wxHtmlContainerCell*}{OpenContainer}{\void}
 
 Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
 
 \membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
 
 \func{wxHtmlContainerCell*}{OpenContainer}{\void}
 
 Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
 

-

 \membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
 
 \func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
 
 \membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
 
 \func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
 

-Sets actual text color. Note: this DOESN'T change the color!
+Sets actual text colour. Note: this DOESN'T change the colour!

 You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 
 \func{void}{SetAlign}{\param{int }{a}}
 
 You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 
 \func{void}{SetAlign}{\param{int }{a}}
 

-Sets default horizontal alignment (see
+Sets default horizontal alignment (see 

 \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)
 Alignment of newly opened container is set to this value.
 
 \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)
 Alignment of newly opened container is set to this value.
 

-

 \membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
 
 \func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
 
 Allows you to directly set opened container. This is not recommended - you should use OpenContainer
 \membersection{wxHtmlWinParser::SetContainer}\label{wxhtmlwinparsersetcontainer}
 
 \func{wxHtmlContainerCell*}{SetContainer}{\param{wxHtmlContainerCell *}{c}}
 
 Allows you to directly set opened container. This is not recommended - you should use OpenContainer

-whereever possible.
-
+wherever possible.

 
 \membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
 
 
 \membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
 


@@ -243,12 +229,11 @@ DCs (e.g. printer) to adjust size of pixel metrics. (Many dimensions in
 HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
 inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
 
 HTML are given in pixels -- e.g. image sizes. 300x300 image would be only one
 inch wide on typical printer. With pixel\_scale = 3.0 it would be 3 inches.)
 

-

 \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
 
 \func{void}{SetFontBold}{\param{int }{x}}
 
 \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
 
 \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}
 
 
 \membersection{wxHtmlWinParser::SetFontFace}\label{wxhtmlwinparsersetfontface}
 


@@ -262,14 +247,13 @@ inside {\tt <TT>} tag or not).
 
 \func{void}{SetFontFixed}{\param{int }{x}}
 
 
 \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}}
 
 
 \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}
 
 
 \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
 


@@ -281,14 +265,14 @@ Sets actual font size (HTML size varies from 1 to 7)
 
 \func{void}{SetFontUnderlined}{\param{int }{x}}
 
 
 \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}
 
 
 \membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}
 

-\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes}}
-
-Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
+\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{wxString }{fixed\_face}, \param{const int }{*sizes = NULL}}

 
 

+Sets fonts. See \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts} for
+detailed description.

 
 \membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
 
 
 \membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
 


@@ -298,7 +282,6 @@ Sets input encoding. The parser uses this information to build conversion
 tables from document's encoding to some encoding supported by operating
 system.
 
 tables from document's encoding to some encoding supported by operating
 system.
 

-

 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 
 \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 
 \func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}


@@ -311,6 +294,5 @@ to wxEmptyString.
 
 \func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
 
 
 \func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
 

-Sets color of hypertext link.
-
+Sets colour of hypertext link.