wxListEvent (wx v2.5.4)

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).

Types

wxList()

-type wxList() ::
          #wxList{type :: wxListEvent:wxListEventType(),
                  code :: integer(),
                  oldItemIndex :: integer(),
                  itemIndex :: integer(),
                  col :: integer(),
                  pointDrag :: {X :: integer(), Y :: integer()}}.

wxListEvent()

-type wxListEvent() :: wx:wx_object().

wxListEventType()

-type 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.

Functions

getCacheFrom(This :: wxListEvent()) -> integer()

For EVT\_LIST\_CACHE\_HINT event only: return the first item which the list control advises us to cache.

getCacheTo(This :: wxListEvent()) -> integer()

For EVT\_LIST\_CACHE\_HINT event only: return the last item (inclusive) which the list control advises us to cache.

getColumn(This :: wxListEvent()) -> integer()

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.

getData(This :: wxListEvent()) -> integer()

The data.

getImage(This :: wxListEvent()) -> integer()

The image.

getIndex(This :: wxListEvent()) -> integer()

The item index.

getItem(This :: wxListEvent()) -> Result

Types

Result = wxListItem:wxListItem()

An item object, used by some events.

getKeyCode(This :: wxListEvent()) -> integer()

Key code if the event is a keypress event.

getLabel(This :: wxListEvent()) -> unicode:charlist()

The (new) item label for EVT_LIST_END_LABEL_EDIT event.

getMask(This :: wxListEvent()) -> integer()

The mask.

getPoint(This :: wxListEvent()) -> Result

Types

Result = {X :: integer(), Y :: integer()}

The position of the mouse pointer if the event is a drag event.

getText(This :: wxListEvent()) -> unicode:charlist()

The text.

isEditCancelled(This :: wxListEvent()) -> boolean()