X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/614391dc087ca70b145e07c442815217f8aa3162..d479632a8f5846d33a4ea13a9ceae158b78f57eb:/docs/latex/wx/listevt.tex diff --git a/docs/latex/wx/listevt.tex b/docs/latex/wx/listevt.tex index 867ecda597..8d944ca89e 100644 --- a/docs/latex/wx/listevt.tex +++ b/docs/latex/wx/listevt.tex @@ -26,14 +26,19 @@ 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\_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 occurred 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}% @@ -43,12 +48,14 @@ functions that take a wxListEvent argument. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxListEvent::wxListEvent} + +\membersection{wxListEvent::wxListEvent}\label{wxlisteventctor} \func{}{wxListEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}} Constructor. + \membersection{wxListEvent::GetCacheFrom}\label{wxlisteventgetcachefrom} \constfunc{long}{GetCacheFrom}{\void} @@ -56,6 +63,7 @@ Constructor. 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} @@ -63,35 +71,30 @@ list control advises us to cache. For {\tt EVT\_LIST\_CACHE\_HINT} event only: return the last item (inclusive) which the list control advises us to cache. -\membersection{wxListEvent::GetCode}\label{wxlisteventgetcode} -\constfunc{int}{GetCode}{\void} +\membersection{wxListEvent::GetKeyCode}\label{wxlisteventgetkeycode} + +\constfunc{int}{GetKeyCode}{\void} Key code if the event is a keypress event. + \membersection{wxListEvent::GetIndex}\label{wxlisteventgetindex} \constfunc{long}{GetIndex}{\void} The item index. -\membersection{wxListEvent::GetOldIndex}\label{wxlisteventgetoldindex} - -\constfunc{long}{GetOldIndex}{\void} - -The old item index. \membersection{wxListEvent::GetColumn}\label{wxlisteventgetcolumn} \constfunc{int}{GetColumn}{\void} -The column position. - -\membersection{wxListEvent::Cancelled}\label{wxlisteventcancelled} +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. -\constfunc{bool}{Cancelled}{\void} - -TRUE if this event is an end edit event and the user cancelled the edit. \membersection{wxListEvent::GetPoint}\label{wxlisteventgetpoint} @@ -100,11 +103,13 @@ TRUE if this event is an end edit event and the user cancelled the edit. The position of the mouse pointer if the event is a drag event. + \membersection{wxListEvent::GetLabel}\label{wxlisteventgetlabel} \constfunc{const wxString\&}{GetLabel}{\void} -The label. +The (new) item label for \texttt{EVT\_LIST\_END\_LABEL\_EDIT} event. + \membersection{wxListEvent::GetText}\label{wxlisteventgettext} @@ -112,24 +117,28 @@ The label. 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} @@ -137,3 +146,14 @@ The mask. An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}. +\membersection{wxListEvent::IsEditCancelled}\label{wxlisteventiseditcancelled} + +\constfunc{bool}{IsEditCancelled}{\void} + +This method only makes sense for \texttt{EVT\_LIST\_END\_LABEL\_EDIT} message +and returns \true if it the label editing has been cancelled by the user +(\helpref{GetLabel}{wxlisteventgetlabel} 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). + +