X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/86f975a8588dff94739f25091ba7910b0763a316..8bb8ab39dd433191764a64b4f96344399b113d1b:/docs/latex/wx/listctrl.tex?ds=sidebyside diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index 22661e87d1..0adf77c4de 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -48,14 +48,15 @@ functions that take a \helpref{wxListEvent}{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\_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,6 +130,12 @@ 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}} @@ -137,7 +144,7 @@ Deletes the specified item. \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems} -\func{bool}{DeleteAllItems}{\void} +\func{bool}{DeleteAllItems}{} Deletes all the items in the list control. @@ -149,16 +156,15 @@ Deletes a column. \membersection{wxListCtrl::EditLabel}\label{wxlistctrledit} -\func{wxTextCtrl *}{Edit}{\param{long }{item}} +\func{void}{EditLabel}{\param{long }{item}} -Starts editing the label of the given item, returning the text control that -the tree control uses for editing. This function generates a -EVT\_LIST\_BEGIN\_LABEL\_EDIT event and if the event handler returns FALSE, label -editing will not start and NULL will be returned - be ready to handle this -case. +Starts editing the label of the given item. This function generates a +EVT\_LIST\_BEGIN\_LABEL\_EDIT event which can be vetoed so that no +text control will appear for in-place editing. -The text control returned should not be deleted by the application and is not -valid any longer after the EVT\_LIST\_END\_LABEL\_EDIT event is received. +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 +will be sent which can be vetoed as well. \membersection{wxListCtrl::EnsureVisible}\label{wxlistctrlensurevisible}