X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc6e1950f57a44e30542076b10a6ea792cccbd82..1648d51bcb7633efde873b986b4a9e2af005f119:/docs/latex/wx/httag.tex
diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex
index c9db5ff1db..6f4297fba3 100644
--- a/docs/latex/wx/httag.tex
+++ b/docs/latex/wx/httag.tex
@@ -45,7 +45,7 @@ ending tag.
See explanation (returned position is marked with `|'):
\begin{verbatim}
-bla bla bla bla bla intenal text bla bla
+bla bla bla bla bla internal text bla bla
|
\end{verbatim}
@@ -59,7 +59,7 @@ ending tag.
See explanation (returned position is marked with `|'):
\begin{verbatim}
-bla bla bla bla bla intenal text bla bla
+bla bla bla bla bla internal text bla bla
|
\end{verbatim}
@@ -73,7 +73,7 @@ ending tag.
See explanation (returned position is marked with `|'):
\begin{verbatim}
-bla bla bla bla bla intenal text bla bla
+bla bla bla bla bla internal text bla bla
|
\end{verbatim}
@@ -88,7 +88,7 @@ and name of {\tt } is "TABLE")
\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\_commas = false}}
Returns the value of the parameter. You should check whether the
parameter exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first.
@@ -97,7 +97,7 @@ 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\_commas}{true if you want to get commas as well. See example.}
\wxheading{Example}
@@ -109,15 +109,35 @@ dummy = tag.GetParam("SIZE");
// 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}
+\membersection{wxHtmlTag::GetParamAsColour}\label{wxhtmltaggetparamascolour}
+
+\constfunc{bool}{GetParamAsColour}{\param{const wxString\& }{par}, \param{wxColour *}{clr}}
+
+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
+if the tag has no such parameter.
+
+\membersection{wxHtmlTag::GetParamAsInt}\label{wxhtmltaggetparamasint}
+
+\constfunc{bool}{GetParamAsInt}{\param{const wxString\& }{par}, \param{int *}{value}}
+
+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
+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:
@@ -138,7 +158,7 @@ is ending itself) of course doesn't have ending tag.
\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 } has two parameters named
"SIZE" and "COLOR".
@@ -150,24 +170,25 @@ Example : {\tt } has two parameters named
\constfunc{bool}{IsEnding}{\void}
-Returns TRUE if this tag is ending one.
+Returns true if this tag is ending one.
({\tt } is ending tag, {\tt } 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 }