docs/latex/wx/listevt.tex

   1 \section{\class{wxListEvent}}\label{wxlistevent}
   2
   3 A list event holds information about events associated with wxListCtrl objects.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxCommandEvent}{wxcommandevent}\\
   8 \helpref{wxEvent}{wxevent}\\
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/listctrl.h>
  14
  15 \wxheading{Event table macros}
  16
  17 To process input from a list control, use these event handler macros to direct input to member
  18 functions that take a wxListEvent argument.
  19
  20 \twocolwidtha{7cm}
  21 \begin{twocollist}\itemsep=0pt
  22 \twocolitem{{\bf EVT\_LIST\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
  23 \twocolitem{{\bf EVT\_LIST\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
  24 \twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label.}
  25 \twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label.}
  26 \twocolitem{{\bf EVT\_LIST\_DELETE\_ITEM(id, func)}}{Delete an item.}
  27 \twocolitem{{\bf EVT\_LIST\_DELETE\_ALL\_ITEMS(id, func)}}{Delete all items.}
  28 \twocolitem{{\bf EVT\_LIST\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.}
  29 \twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).}
  30 \twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.}
  31 \twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.}
  32 \twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.}
  33 \twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.}
  34 \twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.}
  35 \end{twocollist}%
  36
  37 \wxheading{See also}
  38
  39 \helpref{wxListCtrl}{wxlistctrl}
  40
  41 \latexignore{\rtfignore{\wxheading{Members}}}
  42
  43 \membersection{wxListEvent::wxListEvent}
  44
  45 \func{}{wxListEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
  46
  47 Constructor.
  48
  49 \membersection{wxListEvent::m\_code}
  50
  51 \member{int}{m\_code}
  52
  53 Key code if the event is a keypress event.
  54
  55 \membersection{wxListEvent::m\_itemIndex}
  56
  57 \member{long}{m\_itemIndex}
  58
  59 The item index.
  60
  61 \membersection{wxListEvent::m\_oldItemIndex}
  62
  63 \member{long}{m\_oldItemIndex}
  64
  65 The old item index.
  66
  67 \membersection{wxListEvent::m\_col}
  68
  69 \member{int}{m\_col}
  70
  71 The column position.
  72
  73 \membersection{wxListEvent::m\_cancelled}
  74
  75 \member{bool}{m\_cancelled}
  76
  77 TRUE if this event is an end edit event and the user cancelled the edit.
  78
  79 \membersection{wxListEvent::m\_pointDrag}
  80
  81 \member{wxPoint}{m\_pointDrag}
  82
  83 The position of the mouse pointer if the event is a drag event.
  84
  85 \membersection{wxListEvent::m\_item}
  86
  87 \member{wxListItem}{m\_item}
  88
  89 An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
  90
  91