## wxHtmlListBox

wxHtmlListBox is an implementation of wxVListBox 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 (see htlbox sample for the example) but you will only need to override a single OnGetItem() function.

Derived from

wxVListBox
wxVScrolledWindow
wxPanel
wxWindow
wxEvtHandler
wxObject

Include files

<wx/htmllbox.h>

See also

wxSimpleHtmlListBox

Event handling

To process input from a wxHtmlListBox, use these event handler macros to direct input to member functions that take a wxHtmlCellEvent argument or a wxHtmlLinkEvent.

EVT_HTML_CELL_CLICKED(id, func) | A wxHtmlCell was clicked.
EVT_HTML_CELL_HOVER(id, func) | The mouse passed over a wxHtmlCell.
EVT_HTML_LINK_CLICKED(id, func) | A wxHtmlCell which contains an hyperlink was clicked.

Members

wxHtmlListBox::wxHtmlListBox
wxHtmlListBox::~wxHtmlListBox
wxHtmlListBox::Create
wxHtmlListBox::GetFileSystem
wxHtmlListBox::GetSelectedTextBgColour
wxHtmlListBox::GetSelectedTextColour
wxHtmlListBox::OnGetItem
wxHtmlListBox::OnGetItemMarkup
wxHtmlListBox::OnLinkClicked

### wxHtmlListBox::wxHtmlListBox

wxHtmlListBox(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = wxHtmlListBoxNameStr)

Normal constructor which calls Create() internally.

wxHtmlListBox()

Default constructor, you must call Create() later.

### wxHtmlListBox::~wxHtmlListBox

~wxHtmlListBox()

Destructor cleans up whatever resources we use.

### wxHtmlListBox::Create

bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = wxHtmlListBoxNameStr)

Creates the control and optionally sets the initial number of items in it (it may also be set or changed later with SetItemCount()).

There are no special styles defined for wxHtmlListBox, in particular the wxListBox styles (with the exception of `wxLB_MULTIPLE`) can not be used here.

Returns `true` on success or `false` if the control couldn't be created

### wxHtmlListBox::GetFileSystem

wxFileSystem& GetFileSystem()

const wxFileSystem& GetFileSystem() const

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

### wxHtmlListBox::GetSelectedTextBgColour

wxColour GetSelectedTextBgColour(const wxColour& colBg) const

This virtual function may be overridden to change the appearance of the background of the selected cells in the same way as GetSelectedTextColour.

It should be rarely, if ever, used because SetSelectionBackground allows to change the selection background for all cells at once and doing anything more fancy is probably going to look strangely.

See also

GetSelectedTextColour

### wxHtmlListBox::GetSelectedTextColour

wxColour GetSelectedTextColour(const wxColour& colFg) const

This virtual function may be overridden to customize the appearance of the selected cells. It is used to determine how the colour colFg is going to look inside selection. By default all original colours are completely ignored and the standard, system-dependent, selection colour is used but the program may wish to override this to achieve some custom appearance.

See also

GetSelectedTextBgColour,
SetSelectionBackground,
wxSystemSettings::GetColour

### wxHtmlListBox::OnGetItem

wxString OnGetItem(size_t n) const

This method must be implemented in the derived class and should return the body (i.e. without `<html>` nor `<body>` tags) of the HTML fragment for the given item.

Note that this function should always return a text fragment for the n item which renders with the same height both when it is selected and when it's not: i.e. if you call, inside your OnGetItem() implementation, `IsSelected(n)` to make the items appear differently when they are selected, then you should make sure that the returned HTML fragment will render with the same height or else you'll see some artifacts when the user selects an item.

### wxHtmlListBox::OnGetItemMarkup

wxString OnGetItemMarkup(size_t n) const

This function may be overridden to decorate HTML returned by OnGetItem().

### wxHtmlListBox::OnLinkClicked

virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link)

Called when the user clicks on hypertext link. Does nothing by default. Overloading this method is deprecated; intercept the event instead.

Parameters

n

Index of the item containing the link.

link

Description of the link.

See also

See also wxHtmlLinkInfo.