wx.HtmlListBox

Inheritance diagram for wx.HtmlListBox:



Description

wx.HtmlListBox is an implementation of wx.VListBox 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.

Known Subclasses

wx.SimpleHtmlListBox

Event Handling

Event Name Description
wx.html.EVT_HTML_CELL_CLICKED(id, func) A wx.html.HtmlCell 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.

Properties Summary

Class API

Methods

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

Constructor.

Parameters:


Returns:

wx.HtmlListBox


GetFileSystem()

Returns the wx.FileSystem 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 if you use relative paths for the images or other resources embedded in your HTML.


Returns:

wx.FileSystem


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

FileSystem
See GetFileSystem