X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd128b0c3ab84380d782e45bfa98f181a848df27..d83eeece0ee86a3ad81096d894a560647cef0d3a:/docs/latex/wx/listevt.tex diff --git a/docs/latex/wx/listevt.tex b/docs/latex/wx/listevt.tex index 6dbb70d0dd..76c42a3cb1 100644 --- a/docs/latex/wx/listevt.tex +++ b/docs/latex/wx/listevt.tex @@ -26,13 +26,22 @@ functions that take a wxListEvent argument. \twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.} \twocolitem{{\bf EVT\_LIST\_DELETE\_ITEM(id, func)}}{Delete an item.} \twocolitem{{\bf EVT\_LIST\_DELETE\_ALL\_ITEMS(id, func)}}{Delete all items.} -\twocolitem{{\bf EVT\_LIST\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.} -\twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).} +%\twocolitem{{\bf EVT\_LIST\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.} +%\twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).} \twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.} \twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.} +\twocolitem{{\bf EVT\_LIST\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).} +\twocolitem{{\bf EVT\_LIST\_ITEM\_FOCUSED(id, func)}}{The currently focused item has changed.} +\twocolitem{{\bf EVT\_LIST\_ITEM\_MIDDLE\_CLICK(id, func)}}{The middle mouse button has been clicked on an item.} +\twocolitem{{\bf EVT\_LIST\_ITEM\_RIGHT\_CLICK(id, func)}}{The right mouse button has been clicked on an item.} \twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.} \twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.} \twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.} +\twocolitem{{\bf EVT\_LIST\_COL\_RIGHT\_CLICK(id, func)}}{A column ({\bf m\_col}) (which can be $-1$ if the click occured outside any column) has been right-clicked.} +\twocolitem{{\bf EVT\_LIST\_COL\_BEGIN\_DRAG(id, func)}}{The user started resizing a column - can be vetoed.} +\twocolitem{{\bf EVT\_LIST\_COL\_DRAGGING(id, func)}}{The divider between columns is being dragged.} +\twocolitem{{\bf EVT\_LIST\_COL\_END\_DRAG(id, func)}}{A column has been resized by the user.} +\twocolitem{{\bf EVT\_LIST\_CACHE\_HINT(id, func)}}{Prepare cache for a virtual list control} \end{twocollist}% \wxheading{See also} @@ -47,45 +56,81 @@ functions that take a wxListEvent argument. Constructor. -\membersection{wxListEvent::m\_code} +\membersection{wxListEvent::GetCacheFrom}\label{wxlisteventgetcachefrom} -\member{int}{m\_code} +\constfunc{long}{GetCacheFrom}{\void} + +For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the first item which the +list control advises us to cache. + +\membersection{wxListEvent::GetCacheTo}\label{wxlisteventgetcacheto} + +\constfunc{long}{GetCacheTo}{\void} + +For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the last item (inclusive) +which the list control advises us to cache. + +\membersection{wxListEvent::GetKeyCode}\label{wxlisteventgetkeycode} + +\constfunc{int}{GetKeyCode}{\void} Key code if the event is a keypress event. -\membersection{wxListEvent::m\_itemIndex} +\membersection{wxListEvent::GetIndex}\label{wxlisteventgetindex} -\member{long}{m\_itemIndex} +\constfunc{long}{GetIndex}{\void} The item index. -\membersection{wxListEvent::m\_oldItemIndex} +\membersection{wxListEvent::GetColumn}\label{wxlisteventgetcolumn} + +\constfunc{int}{GetColumn}{\void} -\member{long}{m\_oldItemIndex} +The column position: it is only used with {\tt 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. -The old item index. +\membersection{wxListEvent::GetPoint}\label{wxlisteventgetpoint} -\membersection{wxListEvent::m\_col} +\constfunc{wxPoint}{GetPoint}{\void} -\member{int}{m\_col} +The position of the mouse pointer if the event is a drag event. -The column position. -\membersection{wxListEvent::m\_cancelled} +\membersection{wxListEvent::GetLabel}\label{wxlisteventgetlabel} -\member{bool}{m\_cancelled} +\constfunc{const wxString\&}{GetLabel}{\void} -TRUE if this event is an end edit event and the user cancelled the edit. +The label. -\membersection{wxListEvent::m\_pointDrag} +\membersection{wxListEvent::GetText}\label{wxlisteventgettext} -\member{wxPoint}{m\_pointDrag} +\constfunc{const wxString\&}{GetText}{\void} -The position of the mouse pointer if the event is a drag event. +The text. + +\membersection{wxListEvent::GetImage}\label{wxlisteventgetimage} + +\constfunc{int}{GetImage}{\void} + +The image. + +\membersection{wxListEvent::GetData}\label{wxlisteventgetdata} + +\constfunc{long}{GetData}{\void} + +The data. + +\membersection{wxListEvent::GetMask}\label{wxlisteventgetmask} + +\constfunc{long}{GetMask}{\void} + +The mask. -\membersection{wxListEvent::m\_item} +\membersection{wxListEvent::GetItem}\label{wxlisteventgetitem} -\member{wxListItem}{m\_item} +\constfunc{const wxListItem\&}{GetItem}{\void} An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.