X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/559fe022dbd5d4d961402b5c973e5225fa91f17f..d0c6b305af860aa4d8b3d16717e8855d0fd73b1f:/docs/latex/wx/httag.tex diff --git a/docs/latex/wx/httag.tex b/docs/latex/wx/httag.tex index 12bacbb808..91a4713494 100644 --- a/docs/latex/wx/httag.tex +++ b/docs/latex/wx/httag.tex @@ -5,22 +5,26 @@ \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 lib/htmlparser.cpp if you're interested in creating it. \membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams} @@ -31,43 +35,46 @@ Returns string with all params. 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 '^'): +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 '^'): +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 '^'): +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} @@ -78,6 +85,7 @@ 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::GetParam}\label{wxhtmltaggetparam} \constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}} @@ -145,25 +153,24 @@ Example : {\tt } has two parameters named 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 char *}{format}, fuck} -This method scans given parameter. Usage is exatly the same as sscanf's +This method scans given parameter. Usage is exactly the same as sscanf's usage except that you don't pass string but param name as the first parameter. \wxheading{Parameters} -\docparam{par}{The name of tag you wanna query (in uppercase)} +\docparam{par}{The name of tag you want to 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 +that ScanParam() is only partially implemented! The problem is +that under Cygnus' GCC vsscanf() function is not implemented. I worked around this in a way which causes that you can use only one parameter in ... -(and only one \% in {\it format}) +(and only one \% in {\it format}).