ListView

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

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

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

See also

ListView.SetColumnImage

Inheritance Diagram

Inheritance diagram for class ListView

Control Appearance

wxMSW

wxMAC

wxGTK

Methods Summary

ClearColumnImage	Resets the column image – after calling this function, no image will be shown.
Focus	Sets focus to the item with the given index.
GetFirstSelected	Returns the first selected item in a (presumably) multiple selection control.
GetFocusedItem	Returns the currently focused item or -1 if none.
GetNextSelected	Used together with GetFirstSelected to iterate over all selected items in the control.
IsSelected	Returns True if the item with the given index is selected, False otherwise.
Select	Selects or unselects the given item.
SetColumnImage	Sets the column image for the specified column.

Properties Summary

FirstSelected	See GetFirstSelected
FocusedItem	See GetFocusedItem

Class API

---

class ListView(ListCtrl)

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

Methods

---

ClearColumnImage(self, col)

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

Parameters:col (int) – the column to clear image for

See also

SetColumnImage

---

Focus(self, index)

Sets focus to the item with the given index.

Parameters:index (long) –

---

GetFirstSelected(self)

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.

Return type:long Returns:The first selected item, if any, -1 otherwise.

---

GetFocusedItem(self)

Returns the currently focused item or -1 if none.

Return type:long

See also

IsSelected , Focus

---

GetNextSelected(self, item)

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

Parameters:item (long) – Return type:long Returns:Returns the next selected item or -1 if there are no more of them.

---

IsSelected(self, index)

Returns True if the item with the given index is selected, False otherwise.

Parameters:index (long) – Return type:bool

See also

GetFirstSelected , GetNextSelected

---

Select(self, n, on=True)

Selects or unselects the given item.

Parameters:

• n (long) – the item to select or unselect
• on (bool) – if True (default), selects the item, otherwise unselects it

See also

ListCtrl.SetItemState

---

SetColumnImage(self, col, 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 (int) – the column to set image for
• image (int) – the index of the column image in the controls image list

Properties

---

FirstSelected

See GetFirstSelected

---

FocusedItem

See GetFocusedItem