X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..30acf700f91bc40b1549d71c9fc0186ce4f1cafd:/docs/latex/wx/listevt.tex

diff --git a/docs/latex/wx/listevt.tex b/docs/latex/wx/listevt.tex
index e1561cda4d..2c47de8d20 100644
--- a/docs/latex/wx/listevt.tex
+++ b/docs/latex/wx/listevt.tex
@@ -4,10 +4,15 @@ A list event holds information about events associated with wxListCtrl objects.
 
 \wxheading{Derived from}
 
+\helpref{wxNotifyEvent}{wxnotifyevent}\\
 \helpref{wxCommandEvent}{wxcommandevent}\\
 \helpref{wxEvent}{wxevent}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/listctrl.h>
+
 \wxheading{Event table macros}
 
 To process input from a list control, use these event handler macros to direct input to member
@@ -17,17 +22,26 @@ functions that take a wxListEvent argument.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_LIST\_BEGIN\_DRAG(id, func)}}{Begin dragging with the left mouse button.}
 \twocolitem{{\bf EVT\_LIST\_BEGIN\_RDRAG(id, func)}}{Begin dragging with the right mouse button.}
-\twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label.}
-\twocolitem{{\bf EVT\_LIST\_END\_LABEL\_EDIT(id, func)}}{Finish editing a label.}
+\twocolitem{{\bf EVT\_LIST\_BEGIN\_LABEL\_EDIT(id, func)}}{Begin editing a label. This can be prevented by calling \helpref{Veto()}{wxnotifyeventveto}.}
+\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}
@@ -42,45 +56,87 @@ functions that take a wxListEvent argument.
 
 Constructor.
 
-\membersection{wxListEvent::m\_code}
+\membersection{wxListEvent::GetCacheFrom}\label{wxlisteventgetcachefrom}
 
-\member{int}{m\_code}
+\constfunc{long}{GetCacheFrom}{\void}
 
-Key code if the event is a keypress event.
+For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the first item which the
+list control advises us to cache.
 
-\membersection{wxListEvent::m\_itemIndex}
+\membersection{wxListEvent::GetCacheTo}\label{wxlisteventgetcacheto}
 
-\member{long}{m\_itemIndex}
+\constfunc{long}{GetCacheTo}{\void}
 
-The item index.
+For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the last item (inclusive)
+which the list control advises us to cache.
 
-\membersection{wxListEvent::m\_oldItemIndex}
+\membersection{wxListEvent::GetCode}\label{wxlisteventgetcode}
 
-\member{long}{m\_oldItemIndex}
+\constfunc{int}{GetCode}{\void}
 
-The old item index.
+Key code if the event is a keypress event.
+
+\membersection{wxListEvent::GetIndex}\label{wxlisteventgetindex}
 
-\membersection{wxListEvent::m\_col}
+\constfunc{long}{GetIndex}{\void}
 
-\member{int}{m\_col}
+The item index.
 
-The column position.
+\membersection{wxListEvent::GetColumn}\label{wxlisteventgetcolumn}
 
-\membersection{wxListEvent::m\_cancelled}
+\constfunc{int}{GetColumn}{\void}
 
-\member{bool}{m\_cancelled}
+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.
+
+\membersection{wxListEvent::Cancelled}\label{wxlisteventcancelled}
+
+\constfunc{bool}{Cancelled}{\void}
 
 TRUE if this event is an end edit event and the user cancelled the edit.
 
-\membersection{wxListEvent::m\_pointDrag}
+\membersection{wxListEvent::GetPoint}\label{wxlisteventgetpoint}
 
-\member{wxPoint}{m\_pointDrag}
+\constfunc{wxPoint}{GetPoint}{\void}
 
 The position of the mouse pointer if the event is a drag event.
 
-\membersection{wxListEvent::m\_item}
 
-\member{wxListItem}{m\_item}
+\membersection{wxListEvent::GetLabel}\label{wxlisteventgetlabel}
+
+\constfunc{const wxString\&}{GetLabel}{\void}
+
+The label.
+
+\membersection{wxListEvent::GetText}\label{wxlisteventgettext}
+
+\constfunc{const wxString\&}{GetText}{\void}
+
+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::GetItem}\label{wxlisteventgetitem}
+
+\constfunc{const wxListItem\&}{GetItem}{\void}
 
 An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.