X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd128b0c3ab84380d782e45bfa98f181a848df27..8a729bb860cec596f4ce5a59fabeb4404a266e97:/docs/latex/wx/listctrl.tex diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index afa9e5e5eb..4fac88641c 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -56,6 +56,7 @@ functions that take a \helpref{wxListEvent}{wxlistevent} argument. \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\_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.} @@ -129,18 +130,32 @@ Arranges the items in icon or small icon view. This only has effect on Win32. {\ Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details. +\membersection{wxListCtrl::ClearAll}\label{wxlistctrlclearall} + +\func{void}{ClearAll}{} + +Deletes all items and all columns. + \membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem} \func{bool}{DeleteItem}{\param{long }{item}} -Deletes the specified item. +Deletes the specified item. This function sends the +{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted. + +See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems} \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems} -\func{bool}{DeleteAllItems}{\void} +\func{bool}{DeleteAllItems}{} Deletes all the items in the list control. +{\bf NB:} This function does {\it not} send the +{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items +from the control would be too slow then (unlike + \helpref{DeleteItem}{wxlistctrldeleteitem}) + \membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn} \func{bool}{DeleteColumn}{\param{int }{col}} @@ -156,7 +171,7 @@ EVT\_LIST\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no text control will appear for in-place editing. If the user changed the label (i.e. s/he does not press ESC or leave -the text control without changes, a EVT\_LIST\_END\_LABEL\_EDIT event +the text control without changes, a EVT\_LIST\_END\_LABEL\_EDIT event will be sent which can be vetoed as well. \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible} @@ -239,8 +254,8 @@ Returns the specified image list. {\it which} may be one of: Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more information. -\pythonnote{The wxPython version of this method takes a parameter -representing the item ID, and returns the wxListItem object. +\pythonnote{The wxPython version of this method takes an integer parameter +for the item ID, and returns the wxListItem object. } \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata} @@ -369,6 +384,10 @@ giving details in {\it flags}. {\it flags} will be a combination of the followin wxLIST\_HITTEST\_ONITEMSTATEICON.} \end{twocollist} +\pythonnote{A tuple of values is returned in the wxPython version of +thsi method. The first value is the item id and the second is the +flags value mentioned above.} + \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} \func{long}{InsertColumn}{\param{long }{col}, \param{wxListItem\& }{info}}