wxListEvent
Description
A list event holds information about events associated with wxListCtrl objects.
See: wxListCtrl
This class is derived (and can use functions) from: wxNotifyEvent wxCommandEvent wxEvent
wxWidgets docs: wxListEvent
Events
Use wxEvtHandler:connect/3 with wxListEventType to subscribe to events of this type.
Data Types
wxListEventType() =
command_list_begin_drag | command_list_begin_rdrag |
command_list_begin_label_edit | command_list_end_label_edit |
command_list_delete_item | command_list_delete_all_items |
command_list_key_down | command_list_insert_item |
command_list_col_click | command_list_col_right_click |
command_list_col_begin_drag | command_list_col_dragging |
command_list_col_end_drag | command_list_item_selected |
command_list_item_deselected | command_list_item_right_click |
command_list_item_middle_click | command_list_item_activated |
command_list_item_focused | command_list_cache_hint
command_list_begin_drag | command_list_begin_rdrag |
command_list_begin_label_edit | command_list_end_label_edit |
command_list_delete_item | command_list_delete_all_items |
command_list_key_down | command_list_insert_item |
command_list_col_click | command_list_col_right_click |
command_list_col_begin_drag | command_list_col_dragging |
command_list_col_end_drag | command_list_item_selected |
command_list_item_deselected | command_list_item_right_click |
command_list_item_middle_click | command_list_item_activated |
command_list_item_focused | command_list_cache_hint
getCacheFrom(This) -> integer()
Types
This = wxListEvent()
For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache.
getCacheTo(This) -> integer()
Types
This = wxListEvent()
For EVT_LIST_CACHE_HINT event only: return the last item (inclusive) which the list control advises us to cache.
getKeyCode(This) -> integer()
Types
This = wxListEvent()
Key code if the event is a keypress event.
getIndex(This) -> integer()
Types
This = wxListEvent()
The item index.
getColumn(This) -> integer()
Types
This = wxListEvent()
The column position: it is only used with COL events.
For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column.
getPoint(This) -> {X :: integer(), Y :: integer()}
Types
This = wxListEvent()
The position of the mouse pointer if the event is a drag event.
getLabel(This) -> unicode:charlist()
Types
This = wxListEvent()
The (new) item label for EVT_LIST_END_LABEL_EDIT event.
getText(This) -> unicode:charlist()
Types
This = wxListEvent()
The text.
getImage(This) -> integer()
Types
This = wxListEvent()
The image.
getData(This) -> integer()
Types
This = wxListEvent()
The data.
getMask(This) -> integer()
Types
This = wxListEvent()
The mask.
getItem(This) -> wxListItem:wxListItem()
Types
This = wxListEvent()
An item object, used by some events.
See also wxListCtrl:setItem/5.
isEditCancelled(This) -> boolean()
Types
This = wxListEvent()
This method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user (getLabel/1 returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string).