| 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{wxNotifyEvent}{wxnotifyevent}\\ |
| 8 | \helpref{wxCommandEvent}{wxcommandevent}\\ |
| 9 | \helpref{wxEvent}{wxevent}\\ |
| 10 | \helpref{wxObject}{wxobject} |
| 11 | |
| 12 | \wxheading{Include files} |
| 13 | |
| 14 | <wx/listctrl.h> |
| 15 | |
| 16 | \wxheading{Event table macros} |
| 17 | |
| 18 | To process input from a list control, use these event handler macros to direct input to member |
| 19 | functions that take a wxListEvent argument. |
| 20 | |
| 21 | \twocolwidtha{7cm} |
| 22 | \begin{twocollist}\itemsep=0pt |
| 23 | \twocolitem{{\bf EVT\_LIST\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.} |
| 24 | \twocolitem{{\bf EVT\_LIST\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.} |
| 25 | \twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} |
| 26 | \twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} |
| 27 | \twocolitem{{\bf EVT\_LIST\_DELETE\_ITEM(id, func)}}{Delete an item.} |
| 28 | \twocolitem{{\bf EVT\_LIST\_DELETE\_ALL\_ITEMS(id, func)}}{Delete all items.} |
| 29 | \twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.} |
| 30 | \twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.} |
| 31 | \twocolitem{{\bf EVT\_LIST\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).} |
| 32 | \twocolitem{{\bf EVT\_LIST\_ITEM\_FOCUSED(id, func)}}{The currently focused item has changed.} |
| 33 | \twocolitem{{\bf EVT\_LIST\_ITEM\_MIDDLE\_CLICK(id, func)}}{The middle mouse button has been clicked on an item.} |
| 34 | \twocolitem{{\bf EVT\_LIST\_ITEM\_RIGHT\_CLICK(id, func)}}{The right mouse button has been clicked on an item.} |
| 35 | \twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.} |
| 36 | \twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.} |
| 37 | \twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.} |
| 38 | \twocolitem{{\bf EVT\_LIST\_COL\_RIGHT\_CLICK(id, func)}}{A column ({\bf m\_col}) (which can be $-1$ if the click occurred outside any column) has been right-clicked.} |
| 39 | \twocolitem{{\bf EVT\_LIST\_COL\_BEGIN\_DRAG(id, func)}}{The user started resizing a column - can be vetoed.} |
| 40 | \twocolitem{{\bf EVT\_LIST\_COL\_DRAGGING(id, func)}}{The divider between columns is being dragged.} |
| 41 | \twocolitem{{\bf EVT\_LIST\_COL\_END\_DRAG(id, func)}}{A column has been resized by the user.} |
| 42 | \twocolitem{{\bf EVT\_LIST\_CACHE\_HINT(id, func)}}{Prepare cache for a virtual list control} |
| 43 | \end{twocollist}% |
| 44 | |
| 45 | \wxheading{See also} |
| 46 | |
| 47 | \helpref{wxListCtrl}{wxlistctrl} |
| 48 | |
| 49 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 50 | |
| 51 | |
| 52 | \membersection{wxListEvent::wxListEvent}\label{wxlisteventctor} |
| 53 | |
| 54 | \func{}{wxListEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}} |
| 55 | |
| 56 | Constructor. |
| 57 | |
| 58 | |
| 59 | \membersection{wxListEvent::GetCacheFrom}\label{wxlisteventgetcachefrom} |
| 60 | |
| 61 | \constfunc{long}{GetCacheFrom}{\void} |
| 62 | |
| 63 | For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the first item which the |
| 64 | list control advises us to cache. |
| 65 | |
| 66 | |
| 67 | \membersection{wxListEvent::GetCacheTo}\label{wxlisteventgetcacheto} |
| 68 | |
| 69 | \constfunc{long}{GetCacheTo}{\void} |
| 70 | |
| 71 | For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the last item (inclusive) |
| 72 | which the list control advises us to cache. |
| 73 | |
| 74 | |
| 75 | \membersection{wxListEvent::GetKeyCode}\label{wxlisteventgetkeycode} |
| 76 | |
| 77 | \constfunc{int}{GetKeyCode}{\void} |
| 78 | |
| 79 | Key code if the event is a keypress event. |
| 80 | |
| 81 | |
| 82 | \membersection{wxListEvent::GetIndex}\label{wxlisteventgetindex} |
| 83 | |
| 84 | \constfunc{long}{GetIndex}{\void} |
| 85 | |
| 86 | The item index. |
| 87 | |
| 88 | |
| 89 | \membersection{wxListEvent::GetColumn}\label{wxlisteventgetcolumn} |
| 90 | |
| 91 | \constfunc{int}{GetColumn}{\void} |
| 92 | |
| 93 | The column position: it is only used with {\tt COL} events. For the column |
| 94 | dragging events, it is the column to the left of the divider being dragged, for |
| 95 | the column click events it may be $-1$ if the user clicked in the list control |
| 96 | header outside any column. |
| 97 | |
| 98 | |
| 99 | \membersection{wxListEvent::GetPoint}\label{wxlisteventgetpoint} |
| 100 | |
| 101 | \constfunc{wxPoint}{GetPoint}{\void} |
| 102 | |
| 103 | The position of the mouse pointer if the event is a drag event. |
| 104 | |
| 105 | |
| 106 | |
| 107 | \membersection{wxListEvent::GetLabel}\label{wxlisteventgetlabel} |
| 108 | |
| 109 | \constfunc{const wxString\&}{GetLabel}{\void} |
| 110 | |
| 111 | The (new) item label for \texttt{EVT\_LIST\_END\_LABEL\_EDIT} event. |
| 112 | |
| 113 | |
| 114 | \membersection{wxListEvent::GetText}\label{wxlisteventgettext} |
| 115 | |
| 116 | \constfunc{const wxString\&}{GetText}{\void} |
| 117 | |
| 118 | The text. |
| 119 | |
| 120 | |
| 121 | \membersection{wxListEvent::GetImage}\label{wxlisteventgetimage} |
| 122 | |
| 123 | \constfunc{int}{GetImage}{\void} |
| 124 | |
| 125 | The image. |
| 126 | |
| 127 | |
| 128 | \membersection{wxListEvent::GetData}\label{wxlisteventgetdata} |
| 129 | |
| 130 | \constfunc{long}{GetData}{\void} |
| 131 | |
| 132 | The data. |
| 133 | |
| 134 | |
| 135 | \membersection{wxListEvent::GetMask}\label{wxlisteventgetmask} |
| 136 | |
| 137 | \constfunc{long}{GetMask}{\void} |
| 138 | |
| 139 | The mask. |
| 140 | |
| 141 | |
| 142 | \membersection{wxListEvent::GetItem}\label{wxlisteventgetitem} |
| 143 | |
| 144 | \constfunc{const wxListItem\&}{GetItem}{\void} |
| 145 | |
| 146 | An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. |
| 147 | |
| 148 | |
| 149 | \membersection{wxListEvent::IsEditCancelled}\label{wxlisteventiseditcancelled} |
| 150 | |
| 151 | \constfunc{bool}{IsEditCancelled}{\void} |
| 152 | |
| 153 | This method only makes sense for \texttt{EVT\_LIST\_END\_LABEL\_EDIT} message |
| 154 | and returns \true if it the label editing has been cancelled by the user |
| 155 | (\helpref{GetLabel}{wxlisteventgetlabel} returns an empty string in this case |
| 156 | but it doesn't allow the application to distinguish between really cancelling the edit and |
| 157 | the admittedly rare case when the user wants to rename it to an empty string). |
| 158 | |
| 159 | |