fixed bug in mouse handling

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

diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index 6d3e4aab6197fac1f3f38224f960739da060920e..cfdb392f39cdd9a833ec9e9ad4af0c616be89bbd 100644 (file)
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -5,23 +5,23 @@
 
 \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
 
 
 \section{\class{wxHtmlWinParser}}\label{wxhtmlwinparser}
 

-This class is derived from \helpref{wxHtmlParser}{wxhtmlparser} and 
+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 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.
-\item This parser produces temporary data! You should call 
-\helpref{delete GetTempData()}{wxhtmlparsergettempdata}!
-\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}


@@ -55,23 +55,20 @@ and returns pointer to it (see \helpref{Overview}{cells}).
 \func{virtual wxFont*}{CreateCurrentFont}{\void}
 
 Creates font based on current setting (see 
 \func{virtual wxFont*}{CreateCurrentFont}{\void}
 
 Creates font based on current setting (see 

-\helpref{SetFontSize}{wxhtmlwinparsersetfontsize},
-\helpref{SetFontBold}{wxhtmlwinparsersetfontbold},
-\helpref{SetFontItalic}{wxhtmlwinparsersetfontitalic},
-\helpref{SetFontFixed}{wxhtmlwinparsersetfontfixed},
+\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.

 
 

-Fonts created during parsing are temporary data and are not freed on DoneParser. 
-You must call \helpref{delete myparser->GetTempData();}{wxhtmlparsergettempdata}
-to free the memory!

 
 \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}
 


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


@@ -114,12 +111,26 @@ 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}
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 \constfunc{int}{GetFontBold}{\void}
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 

+\membersection{wxHtmlWinParser::GetFontFace}\label{wxhtmlwinparsergetfontface}
+
+\constfunc{wxString}{GetFontFace}{\void}
+
+Returns actual font face name.
+

 \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
 
 \constfunc{int}{GetFontFixed}{\void}
 \membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}
 
 \constfunc{int}{GetFontFixed}{\void}


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


@@ -145,20 +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}
 
 \membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
 

-\constfunc{const wxString\&}{GetLink}{\void}
+\constfunc{const wxHtmlLinkInfo\&}{GetLink}{\void}

 
 

-Returns actual hypertext link. (This value is non-empty string
+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,
 if the parser is between {\tt <A>} and {\tt </A>} tags,

-wxEmptyString otherwise.
-
+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}
 


@@ -168,41 +191,43 @@ 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 \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
+Sets default horizontal alignment (see 
+\helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.)

 Alignment of newly opened container is set to this value.
 
 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
-%whereever possible.
-%
+\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
+wherever possible.

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

-\func{virtual void}{SetDC}{\param{wxDC }{*dc}}
+\func{virtual void}{SetDC}{\param{wxDC }{*dc}, \param{double }{pixel\_scale = 1.0}}

 
 Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
 
 Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!

+{\it pixel\_scale}  can be used when rendering to high-resolution 
+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.)

 
 \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
 
 
 \membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
 


@@ -210,6 +235,14 @@ Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
 
 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}
+
+\func{void}{SetFontFace}{\param{const wxString\& }{face}}
+
+Sets current font face to {\it face}. This affects either fixed size
+font or proportional, depending on context (whether the parser is 
+inside {\tt <TT>} tag or not).
+

 \membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
 
 \func{void}{SetFontFixed}{\param{int }{x}}
 \membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
 
 \func{void}{SetFontFixed}{\param{int }{x}}


@@ -226,7 +259,7 @@ Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
 
 \func{void}{SetFontSize}{\param{int }{s}}
 
 
 \func{void}{SetFontSize}{\param{int }{s}}
 

-Sets actual font size (HTML size varies from -2 to +4)
+Sets actual font size (HTML size varies from 1 to 7)

 
 \membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
 
 
 \membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
 


@@ -236,19 +269,29 @@ 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{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{const int }{*sizes}}
+\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}
 
 
 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}
 
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 

-\func{void}{SetLink}{\param{const wxString\& }{link}}
+\func{void}{SetLink}{\param{const wxHtmlLinkInfo\& }{link}}

 
 

-Sets actual hypertext link. wxEmptyString means no link.
+Sets actual hypertext link. Empty link is represented
+by \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo} with {\it Href} equal
+to wxEmptyString.

 
 \membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
 
 \func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
 
 
 \membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
 
 \func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
 

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