***************
wx.html.HtmlTag
***************
Inheritance diagram for `wx.html.HtmlTag`:
|
.. inheritance-diagram:: wx.html.HtmlTag
|
Description
===========
This class represents a single HTML tag.
Derived From
^^^^^^^^^^^^^
* `wx.Object <../Widgets/wx.Object.html>`_
Methods Summary
^^^^^^^^^^^^^^^
* `__init__ <#__init__>`_
* `GetAllParams <#GetAllParams>`_
* `GetBeginPos <#GetBeginPos>`_
* `GetEndPos1 <#GetEndPos1>`_
* `GetEndPos2 <#GetEndPos2>`_
* `GetName <#GetName>`_
* `GetParam <#GetParam>`_
* `HasEnding <#HasEnding>`_
* `HasParam <#HasParam>`_
Properties Summary
^^^^^^^^^^^^^^^^^^
* `AllParams <#AllParams>`_
* `BeginPos <#BeginPos>`_
* `EndPos1 <#EndPos1>`_
* `EndPos2 <#EndPos2>`_
* `Name <#Name>`_
Class API
=========
Methods
^^^^^^^
.. method:: __init__()
`No docstrings available for this method.`
--------
.. method:: GetAllParams()
Returns a string containing all parameters.
Example:
tag contains ````.
Call to `tag.GetAllParams()` would return ``SIZE=+2 COLOR=\"#000000\"``.
|
**Returns:**
`string`
--------
.. method:: GetBeginPos()
Returns beginning position of the text *between* this tag and paired ending tag.
|
**Returns:**
`int`
--------
.. method:: GetEndPos1()
Returns ending position of the text *between* this tag and paired ending tag.
|
**Returns:**
`int`
--------
.. method:: GetEndPos2()
Returns ending position 2 of the text *between* this tag and paired ending tag.
|
**Returns:**
`int`
--------
.. method:: 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")
|
**Returns:**
`string`
--------
.. method:: GetParam(par, with_commas=False)
Returns the value of the parameter.
You should check whether the parameter exists or not (use `HasParam <#HasParam>`_) first.
**Parameters:**
* `par` (string): The parameter's name.
* `with_commas` (bool): ``True`` if you want to get commas as well.
|
**Returns:**
`string`
--------
.. method:: HasEnding()
Returns ``True`` if this tag is paired with ending tag, ``False`` otherwise.
|
**Returns:**
`bool`
--------
.. method:: HasParam(par)
Returns ``True`` if the tag has a parameter of the given name.
**Parameters:**
* `par` (string): the parameter you're looking for.
|
**Returns:**
`bool`
--------
Properties
^^^^^^^^^^
.. attribute:: AllParams
See `GetAllParams <#GetAllParams>`_
.. attribute:: BeginPos
See `GetBeginPos <#GetBeginPos>`_
.. attribute:: EndPos1
See `GetEndPos1 <#GetEndPos1>`_
.. attribute:: EndPos2
See `GetEndPos2 <#GetEndPos2>`_
.. attribute:: Name
See `GetName <#GetName>`_