.\" This is a wxWidgets manpage page generated from the XML docs .TH wxHtmlTag 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxHtmlTag \- .SH DESCRIPTION This class represents a single HTML tag. It is used by tag handlers . .SH "PARENTS" wxObject .SH "INCLUDE FILES" wx/html/htmltag.h .SH MEMBERS .SS wxHtmlTag (wxHtmlTag *parentconst wxString& sourceint posint end_poswxHtmlTagsCache* cachewxHtmlEntitiesParser *entParser) 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. .SS const wxString& GetAllParams () Returns a string containing all parameters. Example : tag contains . Call to tag.GetAllParams() would return SIZE=+2 COLOR="#000000" . .SS int GetBeginPos () Returns beginning position of the text between this tag and paired ending tag. See explanation (returned position is marked with `|'): bla bla bla bla bla internal text bla bla | .SS int GetEndPos1 () Returns ending position of the text between this tag and paired ending tag. See explanation (returned position is marked with `|'): bla bla bla bla bla internal text bla bla | .SS int GetEndPos2 () Returns ending position 2 of the text between this tag and paired ending tag. See explanation (returned position is marked with `|'): bla bla bla bla bla internal text bla bla | .SS wxString GetName () Returns tag's name. The name is always in uppercase and it doesn't contain '<' or '/' characters. (So the name of tag is "FONT" and name of is "TABLE") .SS wxString GetParam (const wxString& parbool with_commas = false) Returns the value of the parameter. You should check whether the parameter exists or not (use HasParam ) first. .SS bool GetParamAsColour (const wxString& parwxColour *clr) Interprets tag parameter par as colour specification and saves its value into wxColour variable pointed by clr . Returns true on success and false if par is not colour specification or if the tag has no such parameter. .SS bool GetParamAsInt (const wxString& parint *value) Interprets tag parameter par as an integer and saves its value into int variable pointed by value . Returns true on success and false if par is not an integer or if the tag has no such parameter. .SS bool HasEnding () Returns true if this tag is paired with ending tag, false otherwise. See the example of HTML document: Hello

How are you?

This is centered...

Oops
Oooops! 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. .SS bool HasParam (const wxString& par) Returns true if the tag has a parameter of the given name. Example : has two parameters named "SIZE" and "COLOR". .SS wxString ScanParam (const wxString& parconst wxChar *formatvoid *value) 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 format ). .SH "SEE ALSO" wxObject .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.