wxListView Class Reference
[Controls]

#include <wx/listctrl.h>

Inheritance diagram for wxListView:

List of all members.

---

Detailed Description

This class currently simply presents a simpler to use interface for the wxListCtrl -- it can be thought of as a façade for that complicated class.

Using it is preferable to using wxListCtrl directly whenever possible because in the future some ports might implement wxListView but not the full set of wxListCtrl features.

Other than different interface, this class is identical to wxListCtrl. In particular, it uses the same events, same window styles and so on.

Library:  wxCore

Category:  Controls

Appearance:

wxMSW appearance	wxGTK appearance	wxMac appearance

See also:

wxListView::SetColumnImage

Public Member Functions
void	ClearColumnImage (int col)
void	Focus (long index)
long	GetFirstSelected () const
long	GetFocusedItem () const
long	GetNextSelected (long item) const
bool	IsSelected (long index) const
void	Select (long n, bool on=true)
void	SetColumnImage (int col, int image)

---

Member Function Documentation

void wxListView::ClearColumnImage

(

int

col

)

Resets the column image -- after calling this function, no image will be shown.

Parameters:

col

the column to clear image for

See also:

SetColumnImage()

void wxListView::Focus

(

long

index

)

Sets focus to the item with the given index.

long wxListView::GetFirstSelected

(

)

const

Returns the first selected item in a (presumably) multiple selection control. Together with GetNextSelected() it can be used to iterate over all selected items in the control.

Returns:

The first selected item, if any, -1 otherwise.

long wxListView::GetFocusedItem

(

)

const

Returns the currently focused item or -1 if none.

See also:

IsSelected(), Focus()

long wxListView::GetNextSelected

(

long

item

)

const

Used together with GetFirstSelected() to iterate over all selected items in the control.

Returns:

Returns the next selected item or -1 if there are no more of them.

bool wxListView::IsSelected

(

long

index

)

const

Returns true if the item with the given index is selected, false otherwise.

See also:

GetFirstSelected(), GetNextSelected()

void wxListView::Select	(	long	n,
		bool	on = true
	)

Selects or unselects the given item.

Parameters:

	n	the item to select or unselect
	on	if true (default), selects the item, otherwise unselects it

See also:

wxListCtrl::SetItemState

void wxListView::SetColumnImage	(	int	col,
		int	image
	)

Sets the column image for the specified column. To use the column images, the control must have a valid image list with at least one image.

Parameters:

	col	the column to set image for
	image	the index of the column image in the controls image list