[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

\wxheading{Include files}

<wx/html/htmltag.h>

\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 will probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters.
Have a look at src/html/htmlpars.cpp if you're interested in creating it.

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

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

Returns a string containing all parameters.

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}}

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

\wxheading{Parameters}

\docparam{par}{The parameter's name.}

\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.}

\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 wxChar *}{format}, \param{void *}{value}}

This method scans given parameter. Usage is exactly the same as sscanf's 
usage except that you don't pass string but parameter name as the first parameter
and that you can only retrieve one value (i.e. you can use only one "\%" element
in {\it format}).


\wxheading{Parameters}

\docparam{par}{The name of tag you want to query}

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

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