Minor tweek for WXPM

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

diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index 6bb22d25c6c099f262ef44b8f6a519c78e9ee1ac..6d3e4aab6197fac1f3f38224f960739da060920e 100644 (file)
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -37,56 +37,65 @@ its mail goal is to parse HTML input so that it can be displayed in
 Constructor. Don't use the default one, use constructor with
 {\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})
 
 Constructor. Don't use the default one, use constructor with
 {\it wnd} paremeter ({\it wnd} is pointer to associated \helpref{wxHtmlWindow}{wxhtmlwindow})
 

-\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
+\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}

 
 

-\func{virtual void}{SetDC}{\param{wxDC }{*dc}}
+\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}

 
 

-Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
+Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.

 
 

-\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc}
+\membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer}

 
 

-\func{wxDC*}{GetDC}{\void}
+\func{wxHtmlContainerCell*}{CloseContainer}{\void}

 
 

-Returns pointer to the DC used during parsing.
+Closes the container, sets actual container to the parent one
+and returns pointer to it (see \helpref{Overview}{cells}).

 
 

-\membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight}
+\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}

 
 

-\constfunc{int}{GetCharHeight}{\void}
+\func{virtual wxFont*}{CreateCurrentFont}{\void}

 
 

-Returns (average) char height in standard font. It's used as DC-independent metrics.
+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.
+(If the font was already created only a pointer is returned.)

 
 

-{\bf Note:} This function doesn't return {\it actual} height. If you wanna
-know height of current font, call {\tt GetDC -> GetCharHeight()}
+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::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
+\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}

 
 

-\constfunc{int}{GetCharWidth}{\void}
+\constfunc{const wxColour\&}{GetActualColor}{\void}

 
 

-Returns average char width in standard font. It's used as DC-independent metrics.
+Returns actual text color.

 
 

-{\bf Note:} This function doesn't return {\it actual} width. If you wanna
-know height of current font, call {\tt GetDC -> GetCharWidth()}
+\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}

 
 

-\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
+\constfunc{int}{GetAlign}{\void}

 
 

-\func{wxWindow*}{GetWindow}{\void}
+Returns default horizontal alignment.

 
 

-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::GetCharHeight}\label{wxhtmlwinparsergetcharheight}

 
 

+\constfunc{int}{GetCharHeight}{\void}

 
 

-\membersection{wxHtmlWinParser::SetFonts}\label{wxhtmlwinparsersetfonts}
+Returns (average) char height in standard font. It's used as DC-independent metrics.

 
 

-\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}}
+{\bf Note:} This function doesn't return {\it actual} height. If you want to
+know the height of the current font, call {\tt GetDC -> GetCharHeight()}.

 
 

-Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
+\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}

 
 

-\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
+\constfunc{int}{GetCharWidth}{\void}

 
 

-\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}
+Returns average char width in standard font. It's used as DC-independent metrics.

 
 

-Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.
+{\bf Note:} This function doesn't return {\it actual} width. If you want to
+know the height of the current font, call {\tt GetDC -> GetCharWidth()}

 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
 
 
 \membersection{wxHtmlWinParser::GetContainer}\label{wxhtmlwinparsergetcontainer}
 


@@ -99,39 +108,11 @@ Common use:
 m_WParser -> GetContainer() -> InsertCell(new ...);
 \end{verbatim}
 
 m_WParser -> GetContainer() -> InsertCell(new ...);
 \end{verbatim}
 

-\membersection{wxHtmlWinParser::OpenContainer}\label{wxhtmlwinparseropencontainer}
-
-\func{wxHtmlContainerCell*}{OpenContainer}{\void}
-
-Opens new container and returns pointer to it (see \helpref{Overview}{cells}).
-
-%
-%\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::CloseContainer}\label{wxhtmlwinparserclosecontainer}
-
-\func{wxHtmlContainerCell*}{CloseContainer}{\void}
-
-Closes the container, sets actual container to the parent one
-and returns pointer to it (see \helpref{Overview}{cells}).
-
-\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}
-
-\constfunc{int}{GetFontSize}{\void}
-
-Returns actual font size (HTML size varies from -2 to +4)
-
-\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}
+\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc}

 
 

-\func{void}{SetFontSize}{\param{int }{s}}
+\func{wxDC*}{GetDC}{\void}

 
 

-Sets actual font size (HTML size varies from -2 to +4)
+Returns pointer to the DC used during parsing.

 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 
 
 \membersection{wxHtmlWinParser::GetFontBold}\label{wxhtmlwinparsergetfontbold}
 


@@ -139,11 +120,11 @@ Sets actual font size (HTML size varies from -2 to +4)
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 
 
 Returns TRUE if actual font is bold, FALSE otherwise.
 

-\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}
+\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}

 
 

-\func{void}{SetFontBold}{\param{int }{x}}
+\constfunc{int}{GetFontFixed}{\void}

 
 

-Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
+Returns TRUE if actual font is fixed face, FALSE otherwise.

 
 \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic}
 
 
 \membersection{wxHtmlWinParser::GetFontItalic}\label{wxhtmlwinparsergetfontitalic}
 


@@ -152,11 +133,11 @@ Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
 Returns TRUE if actual font is italic, FALSE otherwise.
 
 
 Returns TRUE if actual font is italic, FALSE otherwise.
 
 

-\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic}
+\membersection{wxHtmlWinParser::GetFontSize}\label{wxhtmlwinparsergetfontsize}

 
 

-\func{void}{SetFontItalic}{\param{int }{x}}
+\constfunc{int}{GetFontSize}{\void}

 
 

-Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
+Returns actual font size (HTML size varies from -2 to +4)

 
 \membersection{wxHtmlWinParser::GetFontUnderlined}\label{wxhtmlwinparsergetfontunderlined}
 
 
 \membersection{wxHtmlWinParser::GetFontUnderlined}\label{wxhtmlwinparsergetfontunderlined}
 


@@ -164,29 +145,43 @@ Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 
 
 Returns TRUE if actual font is underlined, FALSE otherwise.
 

-\membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}
+\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}

 
 

-\func{void}{SetFontUnderlined}{\param{int }{x}}
+\constfunc{const wxString\&}{GetLink}{\void}

 
 

-Sets underlined flag of actualfont. {\it x} is either TRUE of FALSE.
+Returns actual hypertext link. (This value is non-empty string
+if the parser is between {\tt <A>} and {\tt </A>} tags,
+wxEmptyString otherwise.

 
 

-\membersection{wxHtmlWinParser::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}

 
 

-\constfunc{int}{GetFontFixed}{\void}
+\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}

 
 

-Returns TRUE if actual font is fixed face, FALSE otherwise.
+\constfunc{const wxColour\&}{GetLinkColor}{\void}

 
 

-\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}
+Returns color of hypertext link text.

 
 

-\func{void}{SetFontFixed}{\param{int }{x}}
+\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}

 
 

-Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.
+\func{wxWindow*}{GetWindow}{\void}

 
 

-\membersection{wxHtmlWinParser::GetAlign}\label{wxhtmlwinparsergetalign}
+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)

 
 

-\constfunc{int}{GetAlign}{\void}

 
 

-Returns default horizontal alignment.
+\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}}
+
+Sets actual text color. Note: this DOESN'T change the color! 
+You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.

 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 
 
 \membersection{wxHtmlWinParser::SetAlign}\label{wxhtmlwinparsersetalign}
 


@@ -195,39 +190,55 @@ Returns default horizontal alignment.
 Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
 Alignment of newly opened container is set to this value.
 
 Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
 Alignment of newly opened container is set to this value.
 

-\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}
+%\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.
+%

 
 

-\constfunc{const wxColour\&}{GetLinkColor}{\void}
+\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}

 
 

-Returns color of hypertext link text.
+\func{virtual void}{SetDC}{\param{wxDC }{*dc}}

 
 

-\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
+Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!

 
 

-\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
+\membersection{wxHtmlWinParser::SetFontBold}\label{wxhtmlwinparsersetfontbold}

 
 

-Sets color of hypertext link.
+\func{void}{SetFontBold}{\param{int }{x}}

 
 

-\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
+Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.

 
 

-\constfunc{const wxColour\&}{GetActualColor}{\void}
+\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}

 
 

-Returns actual text color.
+\func{void}{SetFontFixed}{\param{int }{x}}

 
 

-\membersection{wxHtmlWinParser::SetActualColor}\label{wxhtmlwinparsersetactualcolor}
+Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.

 
 

-\func{void}{SetActualColor}{\param{const wxColour\& }{clr}}
+\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic}

 
 

-Sets actual text color. Note: this DOESN'T change the color! 
-You must create \helpref{wxHtmlColourCell}{wxhtmlcolourcell} yourself.
+\func{void}{SetFontItalic}{\param{int }{x}}

 
 

-\membersection{wxHtmlWinParser::GetLink}\label{wxhtmlwinparsergetlink}
+Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.

 
 

-\constfunc{const wxString\&}{GetLink}{\void}
+\membersection{wxHtmlWinParser::SetFontSize}\label{wxhtmlwinparsersetfontsize}

 
 

-Returns actual hypertext link. (This value is non-empty string
-if the parser is between {\tt <A>} and {\tt </A>} tags,
-wxEmptyString otherwise.
+\func{void}{SetFontSize}{\param{int }{s}}
+
+Sets actual font size (HTML size varies from -2 to +4)
+
+\membersection{wxHtmlWinParser::SetFontUnderlined}\label{wxhtmlwinparsersetfontunderlined}

 
 

+\func{void}{SetFontUnderlined}{\param{int }{x}}
+
+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{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{const int }{*sizes}}
+
+Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}

 
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 
 
 \membersection{wxHtmlWinParser::SetLink}\label{wxhtmlwinparsersetlink}
 


@@ -235,20 +246,9 @@ wxEmptyString otherwise.
 
 Sets actual hypertext link. wxEmptyString means no link.
 
 
 Sets actual hypertext link. wxEmptyString means no link.
 

-\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}
-
-\func{virtual wxFont*}{CreateCurrentFont}{\void}
+\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}

 
 

-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.
-(If the font was already created only a pointer is returned.)
+\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}

 
 

-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!
+Sets color of hypertext link.