[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{Library}

\helpref{wxHtml}{librarieslist}

\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.
Commit	Line	Data
704a4b75 VS	1	%
	2	% automatically generated by HelpGen from
	3	% htmltaghandler.tex at 18/Mar/99 19:20:29
	4	%
	5
704a4b75 VS	6	\section{\class{wxHtmlTagHandler}}\label{wxhtmltaghandler}
	7
	8	\wxheading{Derived from}
	9
9704b250 VS	10	\helpref{wxObject}{wxobject}
	11
	12	\wxheading{Include files}
	13
	14	<wx/html/htmlpars.h>
704a4b75	15
a7af285d VZ	16	\wxheading{Library}
	17
	18	\helpref{wxHtml}{librarieslist}
	19
704a4b75 VS	20	\wxheading{See Also}
	21
	22	\helpref{Overview}{handlers},
	23	\helpref{wxHtmlTag}{wxhtmltag}
	24
704a4b75 VS	25	\latexignore{\rtfignore{\wxheading{Members}}}
	26
	27	\membersection{wxHtmlTagHandler::m\_Parser}\label{wxhtmltaghandlermparser}
	28
	29	{\bf wxHtmlParser* m\_Parser}
	30
	31	This attribute is used to access parent parser. It is protected so that
	32	it can't be accessed by user but can be accessed from derived classes.
	33
	34	\membersection{wxHtmlTagHandler::wxHtmlTagHandler}\label{wxhtmltaghandlerwxhtmltaghandler}
	35
	36	\func{}{wxHtmlTagHandler}{\void}
	37
	38	Constructor.
	39
704a4b75 VS	40	\membersection{wxHtmlTagHandler::GetSupportedTags}\label{wxhtmltaghandlergetsupportedtags}
	41
	42	\func{virtual wxString}{GetSupportedTags}{\void}
	43
	44	Returns list of supported tags. The list is in uppercase and tags
	45	are delimited by ','. Example : {\tt "I,B,FONT,P" }
	46
704a4b75 VS	47	\membersection{wxHtmlTagHandler::HandleTag}\label{wxhtmltaghandlerhandletag}
	48
	49	\func{virtual bool}{HandleTag}{\param{const wxHtmlTag\& }{tag}}
	50
	51	This is the core method of each handler. It is called each time
2edb0bde	52	one of supported tags is detected. {\it tag} contains all necessary
704a4b75 VS	53	info (see \helpref{wxHtmlTag}{wxhtmltag} for details).
	54
	55	\wxheading{Return value}
	56
cc81d32f VS	57	true if \helpref{ParseInner}{wxhtmltaghandlerparseinner} was called,
cc81d32f VS	58	false otherwise.
704a4b75 VS	59
	60	\wxheading{Example}
	61
	62	\begin{verbatim}
	63	bool MyHandler::HandleTag(const wxHtmlTag& tag)
	64	{
	65	...
	66	// change state of parser (e.g. set bold face)
	67	ParseInner(tag);
	68	...
	69	// restore original state of parser
	70	}
	71	\end{verbatim}
	72
2edb0bde	73	You shouldn't call ParseInner if the tag is not paired with an ending one.
704a4b75	74
704a4b75 VS	75	\membersection{wxHtmlTagHandler::ParseInner}\label{wxhtmltaghandlerparseinner}
	76
	77	\func{void}{ParseInner}{\param{const wxHtmlTag\& }{tag}}
	78
	79	This method calls parser's \helpref{DoParsing}{wxhtmlparserdoparsing} method
2edb0bde	80	for the string between this tag and the paired ending tag:
704a4b75 VS	81
	82	\begin{verbatim}
	83	...<A HREF="x.htm">Hello, world!</A>...
	84	\end{verbatim}
	85
22d6efa8 JS	86	In this example, a call to ParseInner (with {\it tag} pointing to A tag)
	87	will parse 'Hello, world!'.
	88
559fe022 VS	89	\membersection{wxHtmlTagHandler::SetParser}\label{wxhtmltaghandlersetparser}
	90
	91	\func{virtual void}{SetParser}{\param{wxHtmlParser }{*parser}}
	92
	93	Assigns {\it parser} to this handler. Each {\bf instance} of handler
	94	is guaranteed to be called only from the parser.
	95