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

%
% automatically generated by HelpGen from
% htmltag.tex at 14/Mar/99 20:13:37
%

\section{\class{wxHtmlTag}}\label{wxhtmltag}

This class represents a single HTML tag. 
It is used by \helpref{tag handlers}{handlers}.

\wxheading{Derived from}

wxObject

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

\membersection{wxHtmlTag::wxHtmlTag}\label{wxhtmltagwxhtmltag}

\func{}{wxHtmlTag}{\param{const wxString\& }{source}, \param{int }{pos}, \param{int }{end\_pos}, \param{wxHtmlTagsCache* }{cache}}

Constructor. You'll probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters.
Have a look at lib/htmlparser.cpp if you're interested in creating it.

\membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams}

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

Returns string with all params. 

Example : tag contains {\tt <FONT SIZE=+2 COLOR="\#000000">}. Call to
tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}.

\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos}

\constfunc{int}{GetBeginPos}{\void}

Returns beginning position of the text {\it between} this tag and paired
ending tag. 
See explanation (returned position is marked with '^'):

\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
                   ^
\end{verbatim}

\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1}

\constfunc{int}{GetEndPos1}{\void}

Returns ending position of the text {\it between} this tag and paired
ending tag.
See explanation (returned position is marked with '^'):

\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
                                        ^
\end{verbatim}

\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}

\constfunc{int}{GetEndPos2}{\void}

Returns ending position 2 of the text {\it between} this tag and paired
ending tag.
See explanation (returned position is marked with '^'):

\begin{verbatim}
bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
                                               ^
\end{verbatim}

\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname}

\constfunc{wxString}{GetName}{\void}

Returns tag's name. The name is always in uppercase and it doesn't contain
'<' or '/' characters. (So the name of {\tt <FONT SIZE=+2>} tag is "FONT"
and name of {\tt </table>} is "TABLE")

\membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}

\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}}

Retuns the value of the parameter. You should check whether the
param exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first.

\wxheading{Parameters}

\docparam{par}{The parameter's name in uppercase}

\docparam{with\_commas}{TRUE if you want to get commas as well. See example.}

\wxheading{Example}

\begin{verbatim}
...
/* you have wxHtmlTag variable tag which is equal to
   HTML tag <FONT SIZE=+2 COLOR="#0000FF"> */
dummy = tag.GetParam("SIZE");
   // dummy == "+2"
dummy = tag.GetParam("COLOR");
   // dummy == "#0000FF"
dummy = tag.GetParam("COLOR", TRUE);
   // dummy == "\"#0000FF\"" -- see the difference!!
\end{verbatim}

\membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending}

\constfunc{bool}{HasEnding}{\void}

Returns TRUE if this tag is paired with ending tag, FALSE otherwise.

See the example of HTML document:

\begin{verbatim}
<html><body>
Hello<p>
How are you?
<p align=center>This is centered...</p>
Oops<br>Oooops!
</body></html>
\end{verbatim}

In this example tags HTML and BODY have ending tags, first P and BR 
doesn't have ending tag while the second P has. The third P tag (which
is ending itself) of course doesn't have ending tag.

\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam}

\constfunc{bool}{HasParam}{\param{const wxString\& }{par}}

Returns TRUE if the tag has parameter of the given name. 
Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
"SIZE" and "COLOR".

\wxheading{Parameters}

\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!}

\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending}

\constfunc{bool}{IsEnding}{\void}

Returns TRUE if this tag is ending one.
({\tt </FONT>} is ending tag, {\tt <FONT>} is not)

\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}

\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}

This method scans given parameter. Usage is exactly the same as sscanf's 
usage except that you don't pass string but param name as the first parameter.

\wxheading{Parameters}

\docparam{par}{The name of tag you want to query (in uppercase)}

\docparam{format}{scanf()-like format string.}

\wxheading{Cygwin and Mingw32}

If you're using Cygwin beta 20 or Mingw32 compiler please remember
that ScanParam() is only partially implemented! The problem is
that under Cygnus' GCC vsscanf() function is not implemented. I worked around
this in a way which causes that you can use only one parameter in ...
(and only one \% in {\it format}).
Commit	Line	Data
704a4b75 VS	1	%
	2	% automatically generated by HelpGen from
	3	% htmltag.tex at 14/Mar/99 20:13:37
	4	%
	5
704a4b75 VS	6	\section{\class{wxHtmlTag}}\label{wxhtmltag}
704a4b75 VS	7
448af9a4	8	This class represents a single HTML tag.
704a4b75 VS	9	It is used by \helpref{tag handlers}{handlers}.
704a4b75 VS	10
704a4b75 VS	11	\wxheading{Derived from}
	12
	13	wxObject
	14
	15	\latexignore{\rtfignore{\wxheading{Members}}}
	16
704a4b75 VS	17	\membersection{wxHtmlTag::wxHtmlTag}\label{wxhtmltagwxhtmltag}
	18
	19	\func{}{wxHtmlTag}{\param{const wxString\& }{source}, \param{int }{pos}, \param{int }{end\_pos}, \param{wxHtmlTagsCache* }{cache}}
	20
448af9a4 JS	21	Constructor. You'll probably never have to construct a wxHtmlTag object
	22	yourself. Feel free to ignore the constructor parameters.
	23	Have a look at lib/htmlparser.cpp if you're interested in creating it.
704a4b75	24
559fe022	25	\membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams}
704a4b75	26
559fe022	27	\constfunc{const wxString\&}{GetAllParams}{\void}
704a4b75	28
559fe022	29	Returns string with all params.
704a4b75	30
559fe022 VS	31	Example : tag contains {\tt <FONT SIZE=+2 COLOR="\#000000">}. Call to
559fe022 VS	32	tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}.
704a4b75	33
559fe022	34	\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos}
704a4b75	35
559fe022	36	\constfunc{int}{GetBeginPos}{\void}
704a4b75	37
559fe022 VS	38	Returns beginning position of the text {\it between} this tag and paired
	39	ending tag.
	40	See explanation (returned position is marked with '^'):
704a4b75	41
559fe022 VS	42	\begin{verbatim}
	43	bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
	44	^
	45	\end{verbatim}
	46
	47	\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1}
	48
	49	\constfunc{int}{GetEndPos1}{\void}
	50
	51	Returns ending position of the text {\it between} this tag and paired
	52	ending tag.
	53	See explanation (returned position is marked with '^'):
	54
	55	\begin{verbatim}
	56	bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
	57	^
	58	\end{verbatim}
	59
	60	\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}
	61
	62	\constfunc{int}{GetEndPos2}{\void}
	63
	64	Returns ending position 2 of the text {\it between} this tag and paired
	65	ending tag.
	66	See explanation (returned position is marked with '^'):
	67
	68	\begin{verbatim}
	69	bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
	70	^
	71	\end{verbatim}
	72
	73	\membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname}
	74
	75	\constfunc{wxString}{GetName}{\void}
	76
	77	Returns tag's name. The name is always in uppercase and it doesn't contain
	78	'<' or '/' characters. (So the name of {\tt <FONT SIZE=+2>} tag is "FONT"
	79	and name of {\tt </table>} is "TABLE")
704a4b75 VS	80
	81	\membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}
	82
	83	\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}}
	84
	85	Retuns the value of the parameter. You should check whether the
	86	param exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first.
	87
	88	\wxheading{Parameters}
	89
	90	\docparam{par}{The parameter's name in uppercase}
	91
	92	\docparam{with\_commas}{TRUE if you want to get commas as well. See example.}
	93
	94	\wxheading{Example}
	95
	96	\begin{verbatim}
	97	...
	98	/* you have wxHtmlTag variable tag which is equal to
	99	HTML tag <FONT SIZE=+2 COLOR="#0000FF"> */
	100	dummy = tag.GetParam("SIZE");
	101	// dummy == "+2"
	102	dummy = tag.GetParam("COLOR");
	103	// dummy == "#0000FF"
	104	dummy = tag.GetParam("COLOR", TRUE);
	105	// dummy == "\"#0000FF\"" -- see the difference!!
	106	\end{verbatim}
	107
704a4b75 VS	108	\membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending}
	109
	110	\constfunc{bool}{HasEnding}{\void}
	111
	112	Returns TRUE if this tag is paired with ending tag, FALSE otherwise.
	113
	114	See the example of HTML document:
	115
	116	\begin{verbatim}
	117	<html><body>
	118	Hello<p>
	119	How are you?
	120	<p align=center>This is centered...</p>
	121	Oops<br>Oooops!
	122	</body></html>
	123	\end{verbatim}
	124
	125	In this example tags HTML and BODY have ending tags, first P and BR
	126	doesn't have ending tag while the second P has. The third P tag (which
	127	is ending itself) of course doesn't have ending tag.
	128
559fe022	129	\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam}
704a4b75	130
559fe022	131	\constfunc{bool}{HasParam}{\param{const wxString\& }{par}}
704a4b75	132
559fe022 VS	133	Returns TRUE if the tag has parameter of the given name.
	134	Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
	135	"SIZE" and "COLOR".
704a4b75	136
559fe022	137	\wxheading{Parameters}
704a4b75	138
559fe022	139	\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!}
704a4b75	140
559fe022	141	\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending}
704a4b75	142
559fe022	143	\constfunc{bool}{IsEnding}{\void}
704a4b75	144
559fe022 VS	145	Returns TRUE if this tag is ending one.
559fe022 VS	146	({\tt </FONT>} is ending tag, {\tt <FONT>} is not)
704a4b75	147
559fe022	148	\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}
704a4b75	149
559fe022	150	\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}
704a4b75	151
448af9a4	152	This method scans given parameter. Usage is exactly the same as sscanf's
559fe022 VS	153	usage except that you don't pass string but param name as the first parameter.
	154
	155	\wxheading{Parameters}
	156
448af9a4	157	\docparam{par}{The name of tag you want to query (in uppercase)}
559fe022 VS	158
	159	\docparam{format}{scanf()-like format string.}
	160
	161	\wxheading{Cygwin and Mingw32}
	162
	163	If you're using Cygwin beta 20 or Mingw32 compiler please remember
448af9a4 JS	164	that ScanParam() is only partially implemented! The problem is
448af9a4 JS	165	that under Cygnus' GCC vsscanf() function is not implemented. I worked around
559fe022	166	this in a way which causes that you can use only one parameter in ...
448af9a4	167	(and only one \% in {\it format}).
704a4b75	168