don't call wxYield() from EnsureVisible(), this is too dangerous - and unnecessary...

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

diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index 4eb02251932da41b43ff743530a42fbc89a21768..cfdb392f39cdd9a833ec9e9ad4af0c616be89bbd 100644 (file)
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -7,19 +7,21 @@
 
 This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and
 its mail goal is to parse HTML input so that it can be displayed in
 
 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
+\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{See Also}
 
 \helpref{Handlers overview}{handlers}
 \wxheading{See Also}
 
 \helpref{Handlers overview}{handlers}


@@ -52,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}
 


@@ -78,18 +80,18 @@ 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}
 know the height of the current font, call {\tt GetDC -> GetCharWidth()}
 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}


@@ -109,6 +111,14 @@ 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
+to do conversion between \helpref{input encoding}{wxhtmlwinparsergetinputencoding} 
+and \helpref{output encoding}{wxhtmlwinparsergetoutputencoding}.
+

 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \constfunc{int}{GetFontBold}{\void}
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \constfunc{int}{GetFontBold}{\void}


@@ -121,7 +131,6 @@ 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}


@@ -134,7 +143,6 @@ Returns TRUE if actual font is fixed face, FALSE otherwise.
 
 Returns TRUE if actual font is italic, FALSE otherwise.
 
 
 Returns TRUE if actual font is italic, FALSE otherwise.
 

-

 \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
 
 \constfunc{int}{GetFontSize}{\void}
 \membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
 
 \constfunc{int}{GetFontSize}{\void}


@@ -147,21 +155,33 @@ Returns actual font size (HTML size varies from -2 to +4)
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 

+\membersection{wxHtmlWinParser::GetInputEncoding}\label{wxhtmlwinparsergetinputencoding}
+
+\constfunc{wxFontEncoding}{GetInputEncoding}{\void}
+
+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}
+
+\constfunc{wxFontEncoding}{GetOutputEncoding}{\void}
+
+Returns output encoding, i.e. closest match to document's input encoding
+that is supported by operating system.

 
 \membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
 
 
 \membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
 


@@ -171,37 +191,33 @@ 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)
 
 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}
 


@@ -213,7 +229,6 @@ 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}}


@@ -240,7 +255,6 @@ Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
 
 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}
 
 \func{void}{SetFontSize}{\param{int }{s}}
 \membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
 
 \func{void}{SetFontSize}{\param{int }{s}}


@@ -259,6 +273,14 @@ Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
 
 Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
 
 
 Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
 

+\membersection{wxHtmlWinParser::SetInputEncoding}\label{wxhtmlwinparsersetinputencoding}
+
+\func{void}{SetInputEncoding}{\param{wxFontEncoding }{enc}}
+
+Sets input encoding. The parser uses this information to build conversion
+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}}


@@ -271,6 +293,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.