X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/704a4b7524e05d7bf4d208eb1b30be9989abef4c..6fa588a864944a7f45641425c22e4971a93c8fe2:/docs/latex/wx/htwinprs.tex
diff --git a/docs/latex/wx/htwinprs.tex b/docs/latex/wx/htwinprs.tex
index 7737ad0a82..6d3e4aab61 100644
--- a/docs/latex/wx/htwinprs.tex
+++ b/docs/latex/wx/htwinprs.tex
@@ -3,10 +3,8 @@
% htmlwinparser.tex at 14/Mar/99 20:13:37
%
-
\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
@@ -20,7 +18,6 @@ its mail goal is to parse HTML input so that it can be displayed in
\helpref{delete GetTempData()}{wxhtmlparsergettempdata}!
\end{enumerate}
-
\wxheading{Derived from}
\helpref{wxHtmlParser}{wxhtmlparser}
@@ -40,59 +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})
+\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
-\membersection{wxHtmlWinParser::SetDC}\label{wxhtmlwinparsersetdc}
-
-\func{virtual void}{SetDC}{\param{wxDC }{*dc}}
-
-Sets the DC. This must be called before \helpref{Parse}{wxhtmlparserparse}!
-
-\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc}
+\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}
-\func{wxDC*}{GetDC}{\void}
+Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.
-Returns pointer to the DC used during parsing.
+\membersection{wxHtmlWinParser::CloseContainer}\label{wxhtmlwinparserclosecontainer}
-\membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight}
+\func{wxHtmlContainerCell*}{CloseContainer}{\void}
-\constfunc{int}{GetCharHeight}{\void}
+Closes the container, sets actual container to the parent one
+and returns pointer to it (see \helpref{Overview}{cells}).
-Returns (average) char height in standard font. It's used as DC-independent metrics.
+\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}
-{\bf Note:} This function doesn't return {\it actual} height. If you wanna
-know height of current font, call {\tt GetDC -> GetCharHeight()}
+\func{virtual wxFont*}{CreateCurrentFont}{\void}
-\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
+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.)
-\constfunc{int}{GetCharWidth}{\void}
+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!
-Returns average char width in standard font. It's used as DC-independent metrics.
+\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}
-{\bf Note:} This function doesn't return {\it actual} width. If you wanna
-know height of current font, call {\tt GetDC -> GetCharWidth()}
+\constfunc{const wxColour\&}{GetActualColor}{\void}
-\membersection{wxHtmlWinParser::GetWindow}\label{wxhtmlwinparsergetwindow}
+Returns actual text color.
-\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::SetFonts}\label{wxhtmlwinparsersetfonts}
+\membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight}
-\func{void}{SetFonts}{\param{wxString }{normal\_face}, \param{int }{normal\_italic\_mode}, \param{wxString }{fixed\_face}, \param{int }{fixed\_italic\_mode}, \param{int }{*sizes}}
+\constfunc{int}{GetCharHeight}{\void}
-Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}
+Returns (average) char height in standard font. It's used as DC-independent metrics.
+{\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()}.
-\membersection{wxHtmlWinParser::AddModule}\label{wxhtmlwinparseraddmodule}
+\membersection{wxHtmlWinParser::GetCharWidth}\label{wxhtmlwinparsergetcharwidth}
-\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}
+\constfunc{int}{GetCharWidth}{\void}
-Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.
+Returns average char width in standard font. It's used as DC-independent metrics.
+{\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}
@@ -105,41 +108,11 @@ Common use:
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}
@@ -147,11 +120,11 @@ Sets actual font size (HTML size varies from -2 to +4)
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}
@@ -160,11 +133,11 @@ Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.
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}
@@ -172,29 +145,43 @@ Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.
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 } and {\tt } 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}
@@ -203,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.
-\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 } and {\tt } 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}
@@ -243,19 +246,9 @@ wxEmptyString otherwise.
Sets actual hypertext link. wxEmptyString means no link.
-\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}
+\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}
-\func{virtual wxFont*}{CreateCurrentFont}{\void}
+\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}
-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.)
+Sets color of hypertext link.
-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!