git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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