**************
wx.HtmlListBox
**************

Inheritance diagram for `wx.HtmlListBox`:

|

.. inheritance-diagram:: wx.HtmlListBox

|

Description
===========

`wx.HtmlListBox` is an implementation of `wx.VListBox <wx.VListBox.html>`_ which shows HTML content in the listbox rows. This is still 
an abstract base class and you will need to derive your own class from it but you will only need to override a single `OnGetItem` 
function.

.. seealso:: `wx.SimpleHtmlListBox <wx.SimpleHtmlListBox.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.VListBox <wx.VListBox.html>`_ 
* `wx.VScrolledWindow <wx.VScrolledWindow.html>`_ 
* `wx.Panel <wx.Panel.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.SimpleHtmlListBox <wx.SimpleHtmlListBox.html>`_

Event Handling
^^^^^^^^^^^^^^

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.html.EVT_HTML_CELL_CLICKED(id, func)             A `wx.html.HtmlCell <../html/wx.html.HtmlCell.html>`_ was clicked.
wx.html.EVT_HTML_CELL_HOVER(id, func)               The mouse passed over a `wx.html.HtmlCell`.
wx.html.EVT_HTML_LINK_CLICKED(id, func)             A `wx.html.HtmlCell` which contains an hyperlink was clicked.
==================================================  ==================================================  

Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetFileSystem <#GetFileSystem>`_ 
* `OnLinkClicked <#OnLinkClicked>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `FileSystem <#FileSystem>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name=wx.VListBoxNameStr)

   Constructor.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `id` (int)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `style` (long)
   * `name` (string)

   |

   **Returns:**

   `wx.HtmlListBox <wx.HtmlListBox.html>`_
 

--------

.. method:: GetFileSystem()

   Returns the `wx.FileSystem <wx.FileSystem.html>`_ used by the HTML parser of this object. 

   The file system object is used to resolve the paths in HTML fragments displayed in the control and you should use 
   `wx.FileSystem.ChangePathTo <wx.FileSystem.html#ChangePathTo>`_ if you use relative paths for the images or other resources embedded in your HTML.

   |  

   **Returns:**

   `wx.FileSystem <wx.FileSystem.html>`_
 

--------

.. method:: OnLinkClicked(n, link)

   Called when the user clicks on hypertext link. Does nothing by default. 

   **Parameters:**

   * `n` (long): Index of the item containing the link.
   * `link` (`wx.HtmlLinkInfo`): Description of the link.
  

.. warning:: Overloading this method is deprecated; intercept the event instead.


--------

Properties
^^^^^^^^^^


.. attribute:: FileSystem

   See `GetFileSystem <#GetFileSystem>`_