X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..6aaee6afdcde7c9e677f642303d4988a66cb9dc9:/docs/latex/wx/httag.tex diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex index f349b9906b..2ed4d07300 100644 --- a/docs/latex/wx/httag.tex +++ b/docs/latex/wx/httag.tex @@ -16,11 +16,17 @@ wxObject +\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. @@ -88,7 +94,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\_quotes = false}} Returns the value of the parameter. You should check whether the parameter exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. @@ -97,7 +103,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\_quotes}{true if you want to get quotes as well. See example.} \wxheading{Example} @@ -109,7 +115,7 @@ 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} @@ -120,7 +126,7 @@ dummy = tag.GetParam("COLOR", TRUE); 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} @@ -130,14 +136,14 @@ if the tag has no such parameter. 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: @@ -158,7 +164,7 @@ is ending itself) of course doesn't have ending tag. \constfunc{bool}{HasParam}{\param{const wxString\& }{par}} -Returns TRUE if the tag has a 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". @@ -166,13 +172,6 @@ Example : {\tt } 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 } 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}}