Wx::HtmlTag

This class represents a single HTML tag. It is used by tag handlers.

Derived from

Object

HtmlTag.new

HtmlTag.new(HtmlTag parent,  String source,  Integer pos, 
            Integer end_pos, 
            HtmlTagsCache cache, 
            HtmlEntitiesParser entParser)

Constructor. You will probably never have to construct a HtmlTag object yourself. Feel free to ignore the constructor parameters. Have a look at src/html/htmlpars.cpp if you’re interested in creating it.

HtmlTag#get_all_params

String get_all_params()

Returns a string containing all parameters.

Example : tag contains <FONT SIZE=+2 COLOR="\#000000">. Call to tag.GetAllParams() would return SIZE=+2 COLOR="\#000000".

HtmlTag#get_begin_pos

Integer get_begin_pos()

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
                   |

HtmlTag#get_end_pos_1

Integer get_end_pos_1()

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
                                        |

HtmlTag#get_end_pos_2

Integer get_end_pos_2()

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
                                               |

HtmlTag#get_name

String get_name()

Returns tag’s name. The name is always in uppercase and it doesn’t contain ‘<’ or ’/’ characters. (So the name of <FONT SIZE=+2> tag is “FONT” and name of </table> is “TABLE”)

HtmlTag#get_param

String get_param(String par,  Boolean with_commas = false)

Returns the value of the parameter. You should check whether the parameter exists or not (use has_param) first.

Parameters

• par The parameter’s name.
• with_commas true if you want to get commas as well. See example.

Example

...
/* you have HtmlTag variable tag which is equal to
   HTML tag  /
dummy = tag.GetParam("SIZE");
   // dummy == "+2" 
dummy = tag.GetParam("COLOR");
   // dummy == "#0000FF" 
dummy = tag.GetParam("COLOR", true);
   // dummy == "\"#0000FF\"" -- see the difference!!

Boolean *get_param_as_colour(String par,  Colour clr)

Boolean get_param_as_int(String par,  Integer value)

Boolean has_ending()

Boolean has_param(String par)

String scan_param(String par,  Char format,  (arg-type) value)