<wx/html/htmltag.h>
+\wxheading{Library}
+
+\helpref{wxHtml}{librarieslist}
+
\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}}
+\func{}{wxHtmlTag}{\param{wxHtmlTag *}{parent}, \param{const wxString\& }{source},
+\param{int }{pos}, \param{int }{end\_pos},
+\param{wxHtmlTagsCache* }{cache}, \param{wxHtmlEntitiesParser *}{entParser}}
Constructor. You will probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters.
See explanation (returned position is marked with `|'):
\begin{verbatim}
-bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
+bla bla bla <MYTAG> bla bla internal text</MYTAG> bla bla
|
\end{verbatim}
See explanation (returned position is marked with `|'):
\begin{verbatim}
-bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
+bla bla bla <MYTAG> bla bla internal text</MYTAG> bla bla
|
\end{verbatim}
See explanation (returned position is marked with `|'):
\begin{verbatim}
-bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
+bla bla bla <MYTAG> bla bla internal text</MYTAG> bla bla
|
\end{verbatim}
\membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}
-\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}}
+\constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_quotes = false}}
Returns the value of the parameter. You should check whether the
parameter exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first.
\docparam{par}{The parameter's name.}
-\docparam{with\_commas}{TRUE if you want to get commas as well. See example.}
+\docparam{with\_quotes}{true if you want to get quotes as well. See example.}
\wxheading{Example}
// dummy == "+2"
dummy = tag.GetParam("COLOR");
// dummy == "#0000FF"
-dummy = tag.GetParam("COLOR", TRUE);
+dummy = tag.GetParam("COLOR", true);
// dummy == "\"#0000FF\"" -- see the difference!!
\end{verbatim}
Interprets tag parameter {\it par} as colour specification and saves its value
into wxColour variable pointed by {\it clr}.
-Returns TRUE on success and FALSE if {\it par} is not colour specification or
+Returns true on success and false if {\it par} is not colour specification or
if the tag has no such parameter.
\membersection{wxHtmlTag::GetParamAsInt}\label{wxhtmltaggetparamasint}
Interprets tag parameter {\it par} as an integer and saves its value
into int variable pointed by {\it value}.
-Returns TRUE on success and FALSE if {\it par} is not an integer or
+Returns true on success and false if {\it par} is not an integer or
if the tag has no such parameter.
\membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending}
\constfunc{bool}{HasEnding}{\void}
-Returns TRUE if this tag is paired with ending tag, FALSE otherwise.
+Returns true if this tag is paired with ending tag, false otherwise.
See the example of HTML document:
\constfunc{bool}{HasParam}{\param{const wxString\& }{par}}
-Returns TRUE if the tag has parameter of the given name.
+Returns true if the tag has a parameter of the given name.
Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
"SIZE" and "COLOR".
\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
+This method scans the given parameter. Usage is exactly the same as sscanf's
+usage except that you don't pass a string but a parameter name as the first
+argument
+and 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{par}{The name of the tag you want to query}
\docparam{format}{scanf()-like format string.}
-\docparam{value}{pointer to a variable to store value in }
+\docparam{value}{pointer to a variable to store the value in }