document GetAnimation() (patch 1695722)

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

%
% automatically generated by HelpGen from
% htmltaghandler.tex at 18/Mar/99 19:20:29
%

\section{\class{wxHtmlTagHandler}}\label{wxhtmltaghandler}

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/html/htmlpars.h>

\wxheading{See Also}

\helpref{Overview}{handlers},
\helpref{wxHtmlTag}{wxhtmltag}

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

\membersection{wxHtmlTagHandler::m\_Parser}\label{wxhtmltaghandlermparser}

{\bf wxHtmlParser* m\_Parser}

This attribute is used to access parent parser. It is protected so that
it can't be accessed by user but can be accessed from derived classes.

\membersection{wxHtmlTagHandler::wxHtmlTagHandler}\label{wxhtmltaghandlerwxhtmltaghandler}

\func{}{wxHtmlTagHandler}{\void}

Constructor.

\membersection{wxHtmlTagHandler::GetSupportedTags}\label{wxhtmltaghandlergetsupportedtags}

\func{virtual wxString}{GetSupportedTags}{\void}

Returns list of supported tags. The list is in uppercase and tags
are delimited by ','. Example : {\tt "I,B,FONT,P" }

\membersection{wxHtmlTagHandler::HandleTag}\label{wxhtmltaghandlerhandletag}

\func{virtual bool}{HandleTag}{\param{const wxHtmlTag\& }{tag}}

This is the core method of each handler. It is called each time
one of supported tags is detected. {\it tag} contains all necessary
info (see \helpref{wxHtmlTag}{wxhtmltag} for details).

\wxheading{Return value}

true if \helpref{ParseInner}{wxhtmltaghandlerparseinner} was called,
false otherwise.

\wxheading{Example}

\begin{verbatim}
bool MyHandler::HandleTag(const wxHtmlTag& tag)
{
    ...
    // change state of parser (e.g. set bold face)
    ParseInner(tag);
    ...
    // restore original state of parser
}
\end{verbatim}

You shouldn't call ParseInner if the tag is not paired with an ending one.

\membersection{wxHtmlTagHandler::ParseInner}\label{wxhtmltaghandlerparseinner}

\func{void}{ParseInner}{\param{const wxHtmlTag\& }{tag}}

This method calls parser's \helpref{DoParsing}{wxhtmlparserdoparsing} method
for the string between this tag and the paired ending tag:

\begin{verbatim}
...<A HREF="x.htm">Hello, world!</A>...
\end{verbatim}

In this example, a call to ParseInner (with {\it tag} pointing to A tag)
will parse 'Hello, world!'.

\membersection{wxHtmlTagHandler::SetParser}\label{wxhtmltaghandlersetparser}

\func{virtual void}{SetParser}{\param{wxHtmlParser }{*parser}}

Assigns {\it parser} to this handler. Each {\bf instance} of handler 
is guaranteed to be called only from the parser.