1wxListView(3)              Erlang Module Definition              wxListView(3)
2
3
4

NAME

6       wxListView - Functions for wxListView class
7

DESCRIPTION

9       This class currently simply presents a simpler to use interface for the
10       wxListCtrl - it can be thought of as  a  façade  for  that  complicated
11       class.
12
13       Using  it  is preferable to using wxListCtrl directly whenever possible
14       because in the future some ports might implement wxListView but not the
15       full set of wxListCtrl features.
16
17       Other  than different interface, this class is identical to wxListCtrl.
18       In particular, it uses the same events, same window styles and so on.
19
20       See: setColumnImage/3
21
22       This class is derived (and can use functions) from: wxControl  wxWindow
23       wxEvtHandler
24
25       wxWidgets docs: wxListView
26

DATA TYPES

28       wxListView() = wx:wx_object()
29

EXPORTS

31       clearColumnImage(This, Col) -> ok
32
33              Types:
34
35                 This = wxListView()
36                 Col = integer()
37
38              Resets  the column image - after calling this function, no image
39              will be shown.
40
41              See: setColumnImage/3
42
43       focus(This, Index) -> ok
44
45              Types:
46
47                 This = wxListView()
48                 Index = integer()
49
50              Sets focus to the item with the given index.
51
52       getFirstSelected(This) -> integer()
53
54              Types:
55
56                 This = wxListView()
57
58              Returns the first selected item in a (presumably)  multiple  se‐
59              lection control.
60
61              Together  with  getNextSelected/2 it can be used to iterate over
62              all selected items in the control.
63
64              Return: The first selected item, if any, -1 otherwise.
65
66       getFocusedItem(This) -> integer()
67
68              Types:
69
70                 This = wxListView()
71
72              Returns the currently focused item or -1 if none.
73
74              See: isSelected/2, focus/2
75
76       getNextSelected(This, Item) -> integer()
77
78              Types:
79
80                 This = wxListView()
81                 Item = integer()
82
83              Used together with getFirstSelected/1 to iterate  over  all  se‐
84              lected items in the control.
85
86              Return:  Returns  the  next  selected item or -1 if there are no
87              more of them.
88
89       isSelected(This, Index) -> boolean()
90
91              Types:
92
93                 This = wxListView()
94                 Index = integer()
95
96              Returns true if the item with the given index is selected, false
97              otherwise.
98
99              See: getFirstSelected/1, getNextSelected/2
100
101       select(This, N) -> ok
102
103              Types:
104
105                 This = wxListView()
106                 N = integer()
107
108       select(This, N, Options :: [Option]) -> ok
109
110              Types:
111
112                 This = wxListView()
113                 N = integer()
114                 Option = {on, boolean()}
115
116              Selects or unselects the given item.
117
118              Notice  that  this  method  inherits  the  unusual  behaviour of
119              wxListCtrl:setItemState/4 which sends a wxEVT_LIST_ITEM_SELECTED
120              event  when  it is used to select an item, contrary to the usual
121              rule that only the user actions result in selection.
122
123       setColumnImage(This, Col, Image) -> ok
124
125              Types:
126
127                 This = wxListView()
128                 Col = Image = integer()
129
130              Sets the column image for the specified column.
131
132              To use the column images, the control must have  a  valid  image
133              list with at least one image.
134
135
136
137wxWidgets team.                     wx 2.1                       wxListView(3)