X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..6f9b81232eef61285f2e6556a8df7680870ec84a:/docs/latex/wx/httag.tex diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex index 04ce4fb345..4a3d548f0c 100644 --- a/docs/latex/wx/httag.tex +++ b/docs/latex/wx/httag.tex @@ -5,22 +5,77 @@ \section{\class{wxHtmlTag}}\label{wxhtmltag} -This class represents single HTML tag. +This class represents a single HTML tag. It is used by \helpref{tag handlers}{handlers}. \wxheading{Derived from} wxObject +\wxheading{Include files} + + + \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}} -Constructor. You'll probably never have to construct wxHtmlTag object -yourself. Feel free to ignore the constructor parameters... -(have a look at lib/htmlparser.cpp if you're interested in creating it) +Constructor. You will probably never have to construct a wxHtmlTag object +yourself. Feel free to ignore the constructor parameters. +Have a look at src/html/htmlpars.cpp if you're interested in creating it. + +\membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams} + +\constfunc{const wxString\&}{GetAllParams}{\void} + +Returns a string containing all parameters. + +Example : tag contains {\tt }. Call to +tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}. + + +\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos} + +\constfunc{int}{GetBeginPos}{\void} + +Returns beginning position of the text {\it between} this tag and paired +ending tag. +See explanation (returned position is marked with `|'): + +\begin{verbatim} +bla bla bla bla bla intenal text bla bla + | +\end{verbatim} + + +\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1} + +\constfunc{int}{GetEndPos1}{\void} + +Returns ending position of the text {\it between} this tag and paired +ending tag. +See explanation (returned position is marked with `|'): + +\begin{verbatim} +bla bla bla bla bla intenal text bla bla + | +\end{verbatim} + + +\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2} + +\constfunc{int}{GetEndPos2}{\void} + +Returns ending position 2 of the text {\it between} this tag and paired +ending tag. +See explanation (returned position is marked with `|'): + +\begin{verbatim} +bla bla bla bla bla intenal text bla bla + | +\end{verbatim} \membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname} @@ -30,28 +85,17 @@ Returns tag's name. The name is always in uppercase and it doesn't contain '<' or '/' characters. (So the name of {\tt } tag is "FONT" and name of {\tt } is "TABLE") -\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam} - -\constfunc{bool}{HasParam}{\param{const wxString\& }{par}} - -Returns TRUE if the tag has parameter of the given name. -Example : {\tt } has two parameters named -"SIZE" and "COLOR". - -\wxheading{Parameters} - -\docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!} \membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam} \constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}} -Retuns the value of the parameter. You should check whether the -param exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. +Returns the value of the parameter. You should check whether the +parameter exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first. \wxheading{Parameters} -\docparam{par}{The parameter's name in uppercase} +\docparam{par}{The parameter's name.} \docparam{with\_commas}{TRUE if you want to get commas as well. See example.} @@ -69,43 +113,25 @@ dummy = tag.GetParam("COLOR", TRUE); // dummy == "\"#0000FF\"" -- see the difference!! \end{verbatim} -\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam} +\membersection{wxHtmlTag::GetParamAsColour}\label{wxhtmltaggetparamascolour} -\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck} +\constfunc{bool}{GetParamAsColour}{\param{const wxString\& }{par}, \param{wxColour *}{clr}} -This method scans given parameter. Usage is exatly the same as sscanf's -usage except that you don't pass string but param name as the first parameter. +Interprets tag parameter {\it par} as colour specification and saves its value +into wxColour variable pointed by {\it clr}. -\wxheading{Parameters} - -\docparam{par}{The name of tag you wanna query (in uppercase)} - -\docparam{format}{scanf()-like format string.} - -\wxheading{Cygwin and Mingw32} - -If you're using Cygwin beta 20 or Mingw32 compiler please remember -that ScanParam() is only partially implemented!! The problem is -that under Cygnus' GCC vsscanf() function is not implemented. I workarounded -this in a way which causes that you can use only one parameter in ... -(and only one \% in {\it format}) - -\membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams} - -\constfunc{const wxString\&}{GetAllParams}{\void} - -Returns string with all params. - -Example : tag contains {\tt }. Call to -tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}. +Returns TRUE on success and FALSE if {\it par} is not colour specification or +if the tag has no such parameter. -\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending} +\membersection{wxHtmlTag::GetParamAsInt}\label{wxhtmltaggetparamasint} -\constfunc{bool}{IsEnding}{\void} +\constfunc{bool}{GetParamAsInt}{\param{const wxString\& }{par}, \param{int *}{value}} -Returns TRUE if this tag is ending one. -({\tt } is ending tag, {\tt } is not) +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} @@ -128,42 +154,40 @@ In this example tags HTML and BODY have ending tags, first P and BR doesn't have ending tag while the second P has. The third P tag (which is ending itself) of course doesn't have ending tag. -\membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos} +\membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam} -\constfunc{int}{GetBeginPos}{\void} +\constfunc{bool}{HasParam}{\param{const wxString\& }{par}} -Returns beginning position of the text {\it between} this tag and paired -ending tag. -See explanation (returned position is marked with '^'): +Returns TRUE if the tag has parameter of the given name. +Example : {\tt } has two parameters named +"SIZE" and "COLOR". -\begin{verbatim} -bla bla bla bla bla intenal text bla bla - ^ -\end{verbatim} +\wxheading{Parameters} -\membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1} +\docparam{par}{the parameter you're looking for.} -\constfunc{int}{GetEndPos1}{\void} +\membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending} -Returns ending position of the text {\it between} this tag and paired -ending tag. -See explanation (returned position is marked with '^'): +\constfunc{bool}{IsEnding}{\void} -\begin{verbatim} -bla bla bla bla bla intenal text bla bla - ^ -\end{verbatim} +Returns TRUE if this tag is ending one. +({\tt } is ending tag, {\tt } is not) -\membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2} +\membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam} -\constfunc{int}{GetEndPos2}{\void} +\constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const wxChar *}{format}, \param{void *}{value}} -Returns ending position 2 of the text {\it between} this tag and paired -ending tag. -See explanation (returned position is marked with '^'): +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 +in {\it format}). -\begin{verbatim} -bla bla bla bla bla intenal text bla bla - ^ -\end{verbatim} + +\wxheading{Parameters} + +\docparam{par}{The name of tag you want to query} + +\docparam{format}{scanf()-like format string.} + +\docparam{value}{pointer to a variable to store value in }