git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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\_GET\_INFO(id, func)}}{Request information from the application, usually the item text.}
	30	\twocolitem{{\bf EVT\_LIST\_SET\_INFO(id, func)}}{Information is being supplied (not implemented).}
	31	\twocolitem{{\bf EVT\_LIST\_ITEM\_SELECTED(id, func)}}{The item has been selected.}
	32	\twocolitem{{\bf EVT\_LIST\_ITEM\_DESELECTED(id, func)}}{The item has been deselected.}
	33	\twocolitem{{\bf EVT\_LIST\_ITEM\_ACTIVATED(id, func)}}{The item has been activated (ENTER or double click).}
	34	\twocolitem{{\bf EVT\_LIST\_KEY\_DOWN(id, func)}}{A key has been pressed.}
	35	\twocolitem{{\bf EVT\_LIST\_INSERT\_ITEM(id, func)}}{An item has been inserted.}
	36	\twocolitem{{\bf EVT\_LIST\_COL\_CLICK(id, func)}}{A column ({\bf m\_col}) has been left-clicked.}
	37	\end{twocollist}%
	38
	39	\wxheading{See also}
	40
	41	\helpref{wxListCtrl}{wxlistctrl}
	42
	43	\latexignore{\rtfignore{\wxheading{Members}}}
	44
	45	\membersection{wxListEvent::wxListEvent}
	46
	47	\func{}{wxListEvent}{\param{WXTYPE }{commandType = 0}, \param{int }{id = 0}}
	48
	49	Constructor.
	50
	51	\membersection{wxListEvent::GetCode}\label{wxlisteventgetcode}
	52
	53	\constfunc{int}{GetCode}{\void}
	54
	55	Key code if the event is a keypress event.
	56
	57	\membersection{wxListEvent::GetIndex}\label{wxlisteventgetindex}
	58
	59	\constfunc{long}{GetIndex}{\void}
	60
	61	The item index.
	62
	63	\membersection{wxListEvent::GetOldIndex}\label{wxlisteventgetoldindex}
	64
	65	\constfunc{long}{GetOldIndex}{\void}
	66
	67	The old item index.
	68
	69	\membersection{wxListEvent::GetColumn}\label{wxlisteventgetcolumn}
	70
	71	\constfunc{int}{GetColumn}{\void}
	72
	73	The column position.
	74
	75	\membersection{wxListEvent::Cancelled}\label{wxlisteventcancelled}
	76
	77	\constfunc{bool}{Cancelled}{\void}
	78
	79	TRUE if this event is an end edit event and the user cancelled the edit.
	80
	81	\membersection{wxListEvent::GetPoint}\label{wxlisteventgetpoint}
	82
	83	\constfunc{wxPoint}{GetPoint}{\void}
	84
	85	The position of the mouse pointer if the event is a drag event.
	86
	87
	88	\membersection{wxListEvent::GetLabel}\label{wxlisteventgetlabel}
	89
	90	\constfunc{const wxString\&}{GetLabel}{\void}
	91
	92	The label.
	93
	94	\membersection{wxListEvent::GetText}\label{wxlisteventgettext}
	95
	96	\constfunc{const wxString\&}{GetText}{\void}
	97
	98	The text.
	99
	100	\membersection{wxListEvent::GetImage}\label{wxlisteventgetimage}
	101
	102	\constfunc{int}{GetImage}{\void}
	103
	104	The image.
	105
	106	\membersection{wxListEvent::GetData}\label{wxlisteventgetdata}
	107
	108	\constfunc{long}{GetData}{\void}
	109
	110	The data.
	111
	112	\membersection{wxListEvent::GetMask}\label{wxlisteventgetmask}
	113
	114	\constfunc{long}{GetMask}{\void}
	115
	116	The mask.
	117
	118	\membersection{wxListEvent::GetItem}\label{wxlisteventgetitem}
	119
	120	\constfunc{const wxListItem\&}{GetItem}{\void}
	121
	122	An item object, used by some events. See also \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
	123
	124