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

NAME

6       wxListEvent - Functions for wxListEvent class
7

DESCRIPTION

9       A  list event holds information about events associated with wxListCtrl
10       objects.
11
12       See: wxListCtrl
13
14       This class is derived (and can use functions) from:  wxNotifyEvent  wx‐
15       CommandEvent wxEvent
16
17       wxWidgets docs: wxListEvent
18

EVENTS

20       Use  wxEvtHandler:connect/3 with wxListEventType to subscribe to events
21       of this type.
22

DATA TYPES

24       wxListEvent() = wx:wx_object()
25
26       wxList() =
27           #wxList{type = wxListEvent:wxListEventType(),
28                   code = integer(),
29                   oldItemIndex = integer(),
30                   itemIndex = integer(),
31                   col = integer(),
32                   pointDrag = {X :: integer(), Y :: integer()}}
33
34       wxListEventType() =
35           command_list_begin_drag | command_list_begin_rdrag |
36           command_list_begin_label_edit | command_list_end_label_edit |
37           command_list_delete_item | command_list_delete_all_items |
38           command_list_key_down | command_list_insert_item |
39           command_list_col_click | command_list_col_right_click |
40           command_list_col_begin_drag | command_list_col_dragging |
41           command_list_col_end_drag | command_list_item_selected |
42           command_list_item_deselected | command_list_item_right_click |
43           command_list_item_middle_click | command_list_item_activated |
44           command_list_item_focused | command_list_cache_hint
45

EXPORTS

47       getCacheFrom(This) -> integer()
48
49              Types:
50
51                 This = wxListEvent()
52
53              For EVT_LIST_CACHE_HINT event only: return the first item  which
54              the list control advises us to cache.
55
56       getCacheTo(This) -> integer()
57
58              Types:
59
60                 This = wxListEvent()
61
62              For EVT_LIST_CACHE_HINT event only: return the last item (inclu‐
63              sive) which the list control advises us to cache.
64
65       getKeyCode(This) -> integer()
66
67              Types:
68
69                 This = wxListEvent()
70
71              Key code if the event is a keypress event.
72
73       getIndex(This) -> integer()
74
75              Types:
76
77                 This = wxListEvent()
78
79              The item index.
80
81       getColumn(This) -> integer()
82
83              Types:
84
85                 This = wxListEvent()
86
87              The column position: it is only used with COL events.
88
89              For the column dragging events, it is the column to the left  of
90              the divider being dragged, for the column click events it may be
91              -1 if the user clicked in the list control  header  outside  any
92              column.
93
94       getPoint(This) -> {X :: integer(), Y :: integer()}
95
96              Types:
97
98                 This = wxListEvent()
99
100              The position of the mouse pointer if the event is a drag event.
101
102       getLabel(This) -> unicode:charlist()
103
104              Types:
105
106                 This = wxListEvent()
107
108              The (new) item label for EVT_LIST_END_LABEL_EDIT event.
109
110       getText(This) -> unicode:charlist()
111
112              Types:
113
114                 This = wxListEvent()
115
116              The text.
117
118       getImage(This) -> integer()
119
120              Types:
121
122                 This = wxListEvent()
123
124              The image.
125
126       getData(This) -> integer()
127
128              Types:
129
130                 This = wxListEvent()
131
132              The data.
133
134       getMask(This) -> integer()
135
136              Types:
137
138                 This = wxListEvent()
139
140              The mask.
141
142       getItem(This) -> wxListItem:wxListItem()
143
144              Types:
145
146                 This = wxListEvent()
147
148              An item object, used by some events.
149
150              See also wxListCtrl:setItem/5.
151
152       isEditCancelled(This) -> boolean()
153
154              Types:
155
156                 This = wxListEvent()
157
158              This method only makes sense for EVT_LIST_END_LABEL_EDIT message
159              and returns true if it the label editing has been  cancelled  by
160              the user (getLabel/1 returns an empty string in this case but it
161              doesn't allow the application to distinguish between really can‐
162              celling  the  edit  and  the  admittedly rare case when the user
163              wants to rename it to an empty string).
164
165
166
167wxWidgets team.                    wx 2.2.2                     wxListEvent(3)