docs/latex/wx/httag.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % htmltag.tex at 14/Mar/99 20:13:37
   4 %
   5
   6 \section{\class{wxHtmlTag}}\label{wxhtmltag}
   7
   8 This class represents a single HTML tag.
   9 It is used by \helpref{tag handlers}{handlers}.
  10
  11 \wxheading{Derived from}
  12
  13 wxObject
  14
  15 \latexignore{\rtfignore{\wxheading{Members}}}
  16
  17 \membersection{wxHtmlTag::wxHtmlTag}\label{wxhtmltagwxhtmltag}
  18
  19 \func{}{wxHtmlTag}{\param{const wxString\& }{source}, \param{int }{pos}, \param{int }{end\_pos}, \param{wxHtmlTagsCache* }{cache}}
  20
  21 Constructor. You'll probably never have to construct a wxHtmlTag object
  22 yourself. Feel free to ignore the constructor parameters.
  23 Have a look at lib/htmlparser.cpp if you're interested in creating it.
  24
  25 \membersection{wxHtmlTag::GetAllParams}\label{wxhtmltaggetallparams}
  26
  27 \constfunc{const wxString\&}{GetAllParams}{\void}
  28
  29 Returns string with all params.
  30
  31 Example : tag contains {\tt <FONT SIZE=+2 COLOR="\#000000">}. Call to
  32 tag.GetAllParams() would return {\tt SIZE=+2 COLOR="\#000000"}.
  33
  34 \membersection{wxHtmlTag::GetBeginPos}\label{wxhtmltaggetbeginpos}
  35
  36 \constfunc{int}{GetBeginPos}{\void}
  37
  38 Returns beginning position of the text {\it between} this tag and paired
  39 ending tag.
  40 See explanation (returned position is marked with '^'):
  41
  42 \begin{verbatim}
  43 bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
  44                    ^
  45 \end{verbatim}
  46
  47 \membersection{wxHtmlTag::GetEndPos1}\label{wxhtmltaggetendpos1}
  48
  49 \constfunc{int}{GetEndPos1}{\void}
  50
  51 Returns ending position of the text {\it between} this tag and paired
  52 ending tag.
  53 See explanation (returned position is marked with '^'):
  54
  55 \begin{verbatim}
  56 bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
  57                                         ^
  58 \end{verbatim}
  59
  60 \membersection{wxHtmlTag::GetEndPos2}\label{wxhtmltaggetendpos2}
  61
  62 \constfunc{int}{GetEndPos2}{\void}
  63
  64 Returns ending position 2 of the text {\it between} this tag and paired
  65 ending tag.
  66 See explanation (returned position is marked with '^'):
  67
  68 \begin{verbatim}
  69 bla bla bla <MYTAG> bla bla intenal text</MYTAG> bla bla
  70                                                ^
  71 \end{verbatim}
  72
  73 \membersection{wxHtmlTag::GetName}\label{wxhtmltaggetname}
  74
  75 \constfunc{wxString}{GetName}{\void}
  76
  77 Returns tag's name. The name is always in uppercase and it doesn't contain
  78 '<' or '/' characters. (So the name of {\tt <FONT SIZE=+2>} tag is "FONT"
  79 and name of {\tt </table>} is "TABLE")
  80
  81 \membersection{wxHtmlTag::GetParam}\label{wxhtmltaggetparam}
  82
  83 \constfunc{wxString}{GetParam}{\param{const wxString\& }{par}, \param{bool }{with\_commas = FALSE}}
  84
  85 Retuns the value of the parameter. You should check whether the
  86 param exists or not (use \helpref{HasParam}{wxhtmltaghasparam}) first.
  87
  88 \wxheading{Parameters}
  89
  90 \docparam{par}{The parameter's name in uppercase}
  91
  92 \docparam{with\_commas}{TRUE if you want to get commas as well. See example.}
  93
  94 \wxheading{Example}
  95
  96 \begin{verbatim}
  97 ...
  98 /* you have wxHtmlTag variable tag which is equal to
  99    HTML tag <FONT SIZE=+2 COLOR="#0000FF"> */
 100 dummy = tag.GetParam("SIZE");
 101    // dummy == "+2"
 102 dummy = tag.GetParam("COLOR");
 103    // dummy == "#0000FF"
 104 dummy = tag.GetParam("COLOR", TRUE);
 105    // dummy == "\"#0000FF\"" -- see the difference!!
 106 \end{verbatim}
 107
 108 \membersection{wxHtmlTag::HasEnding}\label{wxhtmltaghasending}
 109
 110 \constfunc{bool}{HasEnding}{\void}
 111
 112 Returns TRUE if this tag is paired with ending tag, FALSE otherwise.
 113
 114 See the example of HTML document:
 115
 116 \begin{verbatim}
 117 <html><body>
 118 Hello<p>
 119 How are you?
 120 <p align=center>This is centered...</p>
 121 Oops<br>Oooops!
 122 </body></html>
 123 \end{verbatim}
 124
 125 In this example tags HTML and BODY have ending tags, first P and BR
 126 doesn't have ending tag while the second P has. The third P tag (which
 127 is ending itself) of course doesn't have ending tag.
 128
 129 \membersection{wxHtmlTag::HasParam}\label{wxhtmltaghasparam}
 130
 131 \constfunc{bool}{HasParam}{\param{const wxString\& }{par}}
 132
 133 Returns TRUE if the tag has parameter of the given name.
 134 Example : {\tt <FONT SIZE=+2 COLOR="\#FF00FF">} has two parameters named
 135 "SIZE" and "COLOR".
 136
 137 \wxheading{Parameters}
 138
 139 \docparam{par}{the parameter you're looking for. It must {\it always} be in uppercase!}
 140
 141 \membersection{wxHtmlTag::IsEnding}\label{wxhtmltagisending}
 142
 143 \constfunc{bool}{IsEnding}{\void}
 144
 145 Returns TRUE if this tag is ending one.
 146 ({\tt </FONT>} is ending tag, {\tt <FONT>} is not)
 147
 148 \membersection{wxHtmlTag::ScanParam}\label{wxhtmltagscanparam}
 149
 150 \constfunc{wxString}{ScanParam}{\param{const wxString\& }{par}, \param{const char *}{format}, fuck}
 151
 152 This method scans given parameter. Usage is exactly the same as sscanf's
 153 usage except that you don't pass string but param name as the first parameter.
 154
 155 \wxheading{Parameters}
 156
 157 \docparam{par}{The name of tag you want to query (in uppercase)}
 158
 159 \docparam{format}{scanf()-like format string.}
 160
 161 \wxheading{Cygwin and Mingw32}
 162
 163 If you're using Cygwin beta 20 or Mingw32 compiler please remember
 164 that ScanParam() is only partially implemented! The problem is
 165 that under Cygnus' GCC vsscanf() function is not implemented. I worked around
 166 this in a way which causes that you can use only one parameter in ...
 167 (and only one \% in {\it format}).
 168