slight warnings in wxprinterdc docs about constructor confusion - see http://www...

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

diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex
index c9db5ff1dbec8d6c399863d8b680f386be9c8f91..c919c4011d0c90a45da394acbda80886da89d7f2 100644 (file)
--- a/docs/latex/wx/httag.tex
+++ b/docs/latex/wx/httag.tex
@@ -20,7 +20,9 @@ wxObject
 
 \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.
@@ -45,7 +47,7 @@ ending tag.
 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}
 
@@ -59,7 +61,7 @@ ending tag.
 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}
 
@@ -73,7 +75,7 @@ ending tag.
 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}
 
@@ -88,7 +90,7 @@ and name of {\tt </table>} 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 +99,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 +111,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 +160,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 <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
 "SIZE" and "COLOR".
 
@@ -146,28 +168,22 @@ Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
 
 \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 }