Several changes and updates

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

%
% automatically generated by HelpGen from
% 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 
\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}

\wxheading{Derived from}

\helpref{wxHtmlParser}{wxhtmlparser}

\wxheading{See Also}

\helpref{Handlers overview}{handlers}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxHtmlWinParser::wxHtmlWinParser}\label{wxhtmlwinparserwxhtmlwinparser}

\func{}{wxHtmlWinParser}{\void}

\func{}{wxHtmlWinParser}{\param{wxWindow }{*wnd}}

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}

\func{virtual void}{SetDC}{\param{wxDC }{*dc}}

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

\membersection{wxHtmlWinParser::GetDC}\label{wxhtmlwinparsergetdc}

\func{wxDC*}{GetDC}{\void}

Returns pointer to the DC used during parsing.

\membersection{wxHtmlWinParser::GetCharHeight}\label{wxhtmlwinparsergetcharheight}

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

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 wanna
know height of 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.

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

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

\func{wxWindow*}{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)


\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{int }{*sizes}}

Sets fonts. This method is identical to \helpref{wxHtmlWindow::SetFonts}{wxhtmlwindowsetfonts}

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

\func{static void}{AddModule}{\param{wxHtmlTagsModule }{*module}}

Adds \helpref{module}{handlers} to the list of wxHtmlWinParser tag handler.

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

\constfunc{wxHtmlContainerCell*}{GetContainer}{\void}

Returns pointer to the currectly opened container (see \helpref{Overview}{cells}).
Common use:

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

\func{void}{SetFontSize}{\param{int }{s}}

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

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

\constfunc{int}{GetFontBold}{\void}

Returns TRUE if actual font is bold, FALSE otherwise.

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

\func{void}{SetFontBold}{\param{int }{x}}

Sets bold flag of actualfont. {\it x} is either TRUE of FALSE.

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

\constfunc{int}{GetFontItalic}{\void}

Returns TRUE if actual font is italic, FALSE otherwise.


\membersection{wxHtmlWinParser::SetFontItalic}\label{wxhtmlwinparsersetfontitalic}

\func{void}{SetFontItalic}{\param{int }{x}}

Sets italic flag of actualfont. {\it x} is either TRUE of FALSE.

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

\constfunc{int}{GetFontUnderlined}{\void}

Returns TRUE if actual font is underlined, FALSE otherwise.

\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::GetFontFixed}\label{wxhtmlwinparsergetfontfixed}

\constfunc{int}{GetFontFixed}{\void}

Returns TRUE if actual font is fixed face, FALSE otherwise.

\membersection{wxHtmlWinParser::SetFontFixed}\label{wxhtmlwinparsersetfontfixed}

\func{void}{SetFontFixed}{\param{int }{x}}

Sets fixed face flag of actualfont. {\it x} is either TRUE of FALSE.

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

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

Returns default horizontal alignment.

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

\func{void}{SetAlign}{\param{int }{a}}

Sets default horizontal alignment (see \helpref{wxHtmlContainerCell::SetAlignHor}{wxhtmlcontainercellsetalignhor}.
Alignment of newly opened container is set to this value.

\membersection{wxHtmlWinParser::GetLinkColor}\label{wxhtmlwinparsergetlinkcolor}

\constfunc{const wxColour\&}{GetLinkColor}{\void}

Returns color of hypertext link text.

\membersection{wxHtmlWinParser::SetLinkColor}\label{wxhtmlwinparsersetlinkcolor}

\func{void}{SetLinkColor}{\param{const wxColour\& }{clr}}

Sets color of hypertext link.

\membersection{wxHtmlWinParser::GetActualColor}\label{wxhtmlwinparsergetactualcolor}

\constfunc{const wxColour\&}{GetActualColor}{\void}

Returns actual text color.

\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::GetLink}\label{wxhtmlwinparsergetlink}

\constfunc{const wxString\&}{GetLink}{\void}

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::SetLink}\label{wxhtmlwinparsersetlink}

\func{void}{SetLink}{\param{const wxString\& }{link}}

Sets actual hypertext link. wxEmptyString means no link.

\membersection{wxHtmlWinParser::CreateCurrentFont}\label{wxhtmlwinparsercreatecurrentfont}

\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{SetFontUnderlined}{wxhtmlwinparsersetfontunderlined})
and returns pointer to it.
(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!