#include <wx/vlbox.h>

Inheritance diagram for wxVListBox:

Detailed Description

wxVListBox is a wxListBox-like control with the following two main differences from a regular wxListBox: it can have an arbitrarily huge number of items because it doesn't store them itself but uses the OnDrawItem() callback to draw them (so it is a virtual listbox) and its items can have variable height as determined by OnMeasureItem() (so it is also a listbox with the lines of variable height).

Also, as a consequence of its virtual nature, it doesn't have any methods to append or insert items in it as it isn't necessary to do it: you just have to call SetItemCount() to tell the control how many items it should display. Of course, this also means that you will never use this class directly because it has pure virtual functions, but will need to derive your own class from it (for example, wxHtmlListBox).

However it emits the same events as wxListBox and the same event macros may be used with it. Since wxVListBox does not store its items itself, the events will only contain the index, not any contents such as the string of an item.

Library: wxCore

Category: Controls

See also: wxSimpleHtmlListBox, wxHtmlListBox

Public Member Functions
	wxVListBox ()
	Default constructor, you must call Create() later.

	wxVListBox (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxVListBoxNameStr)
	Normal constructor which calls Create() internally.

virtual	~wxVListBox ()
	Destructor.

void	Clear ()
	Deletes all items from the control.

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

bool	DeselectAll ()
	Deselects all the items in the listbox.

int	GetFirstSelected (unsigned long &cookie) const
	Returns the index of the first selected item in the listbox or `wxNOT_FOUND` if no items are currently selected.

size_t	GetItemCount () const
	Get the number of items in the control.

wxPoint	GetMargins () const
	Returns the margins used by the control.

wxRect	GetItemRect (size_t item) const
	Returns the rectangle occupied by this item in physical coordinates.

int	GetNextSelected (unsigned long &cookie) const
	Returns the index of the next selected item or `wxNOT_FOUND` if there are no more.

size_t	GetSelectedCount () const
	Returns the number of the items currently selected.

int	GetSelection () const
	Get the currently selected item or `wxNOT_FOUND` if there is no selection.

const wxColour &	GetSelectionBackground () const
	Returns the background colour used for the selected cells.

bool	HasMultipleSelection () const
	Returns true if the listbox was created with `wxLB_MULTIPLE` style and so supports multiple selection or false if it is a single selection listbox.

bool	IsCurrent (size_t item) const
	Returns true if this item is the current one, false otherwise.

int	GetCurrent () const
	Get the current item or `wxNOT_FOUND` if there is no current item.

void	SetCurrent (int current)
	Set the specified item as the current item, if it is wxNOT_FOUND the current item is unset.

bool	IsSelected (size_t item) const
	Returns true if this item is selected, false otherwise.

bool	Select (size_t item, bool select=true)
	Selects or deselects the specified item which must be valid (i.e. not equal to `wxNOT_FOUND`).

bool	SelectAll ()
	Selects all the items in the listbox.

bool	SelectRange (size_t from, size_t to)
	Selects all items in the specified range which may be given in any order.

virtual void	SetItemCount (size_t count)
	Set the number of items to be shown in the control.

void	SetSelection (int selection)
	Set the selection to the specified item, if it is -1 the selection is unset.

void	SetSelectionBackground (const wxColour &col)
	Sets the colour to be used for the selected cells background.

void	Toggle (size_t item)
	Toggles the state of the specified item, i.e. selects it if it was unselected and deselects it if it was selected.


void	SetMargins (const wxPoint &pt)
	Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.

void	SetMargins (wxCoord x, wxCoord y)
	Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.

Protected Member Functions
virtual void	OnDrawItem (wxDC &dc, const wxRect &rect, size_t n) const =0
	The derived class must implement this function to actually draw the item with the given index on the provided DC.

virtual void	OnDrawBackground (wxDC &dc, const wxRect &rect, size_t n) const
	This method is used to draw the item's background and, maybe, a border around it.

virtual void	OnDrawSeparator (wxDC &dc, wxRect &rect, size_t n) const
	This method may be used to draw separators between the lines.

virtual wxCoord	OnMeasureItem (size_t n) const =0
	The derived class must implement this method to return the height of the specified item (in pixels).

Constructor & Destructor Documentation

◆ wxVListBox() [1/2]

wxVListBox::wxVListBox ( )

Default constructor, you must call Create() later.

◆ wxVListBox() [2/2]

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

Normal constructor which calls Create() internally.

◆ ~wxVListBox()

virtual wxVListBox::~wxVListBox ( )

virtual

Destructor.

Member Function Documentation

◆ Clear()

void wxVListBox::Clear ( )

Deletes all items from the control.

◆ Create()

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

Creates the control.

To finish creating it you also should call SetItemCount() to let it know about the number of items it contains.

The only special style which may be used with wxVListBox is wxLB_MULTIPLE which indicates that the listbox should support multiple selection.

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

◆ DeselectAll()

bool wxVListBox::DeselectAll ( )

Deselects all the items in the listbox.

This method is only valid for multi selection listboxes.

Returns: true if any items were changed, i.e. if there had been any selected items before, or false if all the items were already deselected.

See also: SelectAll(), Select()

◆ GetCurrent()

int wxVListBox::GetCurrent ( ) const

Get the current item or wxNOT_FOUND if there is no current item.

Since: 3.3.0

◆ GetFirstSelected()

int wxVListBox::GetFirstSelected ( unsigned long & cookie ) const

Returns the index of the first selected item in the listbox or wxNOT_FOUND if no items are currently selected.

cookie is an opaque parameter which should be passed to the subsequent calls to GetNextSelected(). It is needed in order to allow parallel iterations over the selected items.

Here is a typical example of using these functions:

unsigned long cookie;
int item = hlbox->GetFirstSelected(cookie);
while ( item != wxNOT_FOUND )
{
    // ... process item ...
    item = hlbox->GetNextSelected(cookie);
}

This method is only valid for multi selection listboxes.

◆ GetItemCount()

size_t wxVListBox::GetItemCount ( ) const

Get the number of items in the control.

See also: SetItemCount()

◆ GetItemRect()

wxRect wxVListBox::GetItemRect ( size_t item ) const

Returns the rectangle occupied by this item in physical coordinates.

If the item is not currently visible, returns an empty rectangle.

Since: 2.9.0

◆ GetMargins()

wxPoint wxVListBox::GetMargins ( ) const

Returns the margins used by the control.

The x field of the returned point is the horizontal margin and the y field is the vertical one.

See also: SetMargins()

◆ GetNextSelected()

int wxVListBox::GetNextSelected ( unsigned long & cookie ) const

Returns the index of the next selected item or wxNOT_FOUND if there are no more.

This method is only valid for multi selection listboxes.

See also: GetFirstSelected()

◆ GetSelectedCount()

size_t wxVListBox::GetSelectedCount ( ) const

Returns the number of the items currently selected.

It is valid for both single and multi selection controls. In the former case it may only return 0 or 1 however.

See also: IsSelected(), GetFirstSelected(), GetNextSelected()

◆ GetSelection()

int wxVListBox::GetSelection ( ) const

Get the currently selected item or wxNOT_FOUND if there is no selection.

◆ GetSelectionBackground()

const wxColour & wxVListBox::GetSelectionBackground ( ) const

Returns the background colour used for the selected cells.

By default the standard system colour is used.

See also: wxSystemSettings::GetColour(), SetSelectionBackground()

◆ HasMultipleSelection()

bool wxVListBox::HasMultipleSelection ( ) const

Returns true if the listbox was created with wxLB_MULTIPLE style and so supports multiple selection or false if it is a single selection listbox.

◆ IsCurrent()

bool wxVListBox::IsCurrent ( size_t item ) const

Returns true if this item is the current one, false otherwise.

The current item is always the same as selected one for the single selection listbox and in this case this method is equivalent to IsSelected() but they are different for multi selection listboxes where many items may be selected but only one (at most) is current.

◆ IsSelected()

bool wxVListBox::IsSelected ( size_t item ) const

Returns true if this item is selected, false otherwise.

◆ OnDrawBackground()

virtual void wxVListBox::OnDrawBackground	(	wxDC &	dc,
		const wxRect &	rect,
		size_t	n ) const

protectedvirtual

This method is used to draw the item's background and, maybe, a border around it.

The base class version implements a reasonable default behaviour which consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current.

Todo: Change this function signature to non-const.

◆ OnDrawItem()

virtual void wxVListBox::OnDrawItem	(	wxDC &	dc,
		const wxRect &	rect,
		size_t	n ) const

protectedpure virtual

The derived class must implement this function to actually draw the item with the given index on the provided DC.

Parameters

dc	The device context to use for drawing.
rect	The bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function).
n	The index of the item to be drawn.

Todo: Change this function signature to non-const.

◆ OnDrawSeparator()

virtual void wxVListBox::OnDrawSeparator	(	wxDC &	dc,
		wxRect &	rect,
		size_t	n ) const

protectedvirtual

This method may be used to draw separators between the lines.

The rectangle passed to it may be modified, typically to deflate it a bit before passing to OnDrawItem().

The base class version of this method doesn't do anything.

Parameters

dc	The device context to use for drawing.
rect	The bounding rectangle for the item.
n	The index of the item.

Todo: Change this function signature to non-const.

◆ OnMeasureItem()

virtual wxCoord wxVListBox::OnMeasureItem ( size_t n ) const

protectedpure virtual

The derived class must implement this method to return the height of the specified item (in pixels).

◆ Select()

bool wxVListBox::Select	(	size_t	item,
		bool	select = true )

Selects or deselects the specified item which must be valid (i.e. not equal to wxNOT_FOUND).

Returns: true if the items selection status has changed or false otherwise.

This function is only valid for the multiple selection listboxes, use SetSelection() for the single selection ones.

◆ SelectAll()

bool wxVListBox::SelectAll ( )

Selects all the items in the listbox.

Returns: true if any items were changed, i.e. if there had been any unselected items before, or false if all the items were already selected.

This method is only valid for multi selection listboxes.

See also: DeselectAll(), Select()

◆ SelectRange()

bool wxVListBox::SelectRange	(	size_t	from,
		size_t	to )

Selects all items in the specified range which may be given in any order.

Returns: true if the items selection status has changed or false otherwise.

This method is only valid for multi selection listboxes.

See also: SelectAll(), Select()

◆ SetCurrent()

void wxVListBox::SetCurrent ( int current )

Set the specified item as the current item, if it is wxNOT_FOUND the current item is unset.

The current item will be automatically scrolled into view if it isn't currently visible.

Since: 3.3.0

◆ SetItemCount()

virtual void wxVListBox::SetItemCount ( size_t count )

virtual

Set the number of items to be shown in the control.

This is just a synonym for wxVScrolledWindow::SetRowCount().

◆ SetMargins() [1/2]

void wxVListBox::SetMargins ( const wxPoint & pt )

Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.

By default both margins are 0.

◆ SetMargins() [2/2]

void wxVListBox::SetMargins	(	wxCoord	x,
		wxCoord	y )

Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.

By default both margins are 0.

◆ SetSelection()

void wxVListBox::SetSelection ( int selection )

Set the selection to the specified item, if it is -1 the selection is unset.

The selected item will be automatically scrolled into view if it isn't currently visible.

This method may be used both with single and multiple selection listboxes.

◆ SetSelectionBackground()

void wxVListBox::SetSelectionBackground ( const wxColour & col )

Sets the colour to be used for the selected cells background.

The background of the standard cells may be changed by simply calling wxWindow::SetBackgroundColour().

Note: Using a non-default background colour may result in control having an appearance different from the similar native controls and should be avoided in general.

See also: GetSelectionBackground()

◆ Toggle()

void wxVListBox::Toggle ( size_t item )

Toggles the state of the specified item, i.e. selects it if it was unselected and deselects it if it was selected.

This method is only valid for multi selection listboxes.

See also: Select()

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ wxVListBox() [1/2]

◆ wxVListBox() [2/2]

◆ ~wxVListBox()

Member Function Documentation

◆ Clear()

◆ Create()

◆ DeselectAll()

◆ GetCurrent()

◆ GetFirstSelected()

◆ GetItemCount()

◆ GetItemRect()

◆ GetMargins()

◆ GetNextSelected()

◆ GetSelectedCount()

◆ GetSelection()

◆ GetSelectionBackground()

◆ HasMultipleSelection()

◆ IsCurrent()

◆ IsSelected()

◆ OnDrawBackground()

◆ OnDrawItem()

◆ OnDrawSeparator()

◆ OnMeasureItem()

◆ Select()

◆ SelectAll()

◆ SelectRange()

◆ SetCurrent()

◆ SetItemCount()

◆ SetMargins() [1/2]

◆ SetMargins() [2/2]

◆ SetSelection()

◆ SetSelectionBackground()

◆ Toggle()