X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e5aff4c5687407c5636a5c8d53fbe245487cb90c..80d2803f703d1b238f42725504f08266ef02defe:/docs/latex/wx/listctrl.tex diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index 3305ac71c3..a275fe865f 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -3,7 +3,7 @@ A list control presents lists in a number of formats: list view, report view, icon view and small icon view. In any case, elements are numbered from zero. -Using many of wxListCtrl is shown in the +Using many of wxListCtrl is shown in the \helpref{corresponding sample}{samplelistctrl}. To intercept events from a list control, use the event table macros described @@ -39,6 +39,8 @@ the list wraps, unlike a wxListBox.} \twocolitem{\windowstyle{wxLC\_SINGLE\_SEL}}{Single selection.} \twocolitem{\windowstyle{wxLC\_SORT\_ASCENDING}}{Sort in ascending order (must still supply a comparison callback in SortItems.} \twocolitem{\windowstyle{wxLC\_SORT\_DESCENDING}}{Sort in descending order (must still supply a comparison callback in SortItems.} +\twocolitem{\windowstyle{wxLC\_HRULES}}{Draws light horizontal rules between rows in report mode.} +\twocolitem{\windowstyle{wxLC\_VRULES}}{Draws light vertical rules between columns in report mode.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -144,7 +146,7 @@ Deletes all items and all columns. \func{bool}{DeleteItem}{\param{long }{item}} -Deletes the specified item. This function sends the +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} @@ -155,10 +157,9 @@ See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems} Deletes all the items in the list control. -{\bf NB:} This function does {\it not} send the +{\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}) +from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrldeleteitem}). \membersection{wxListCtrl::DeleteColumn}\label{wxlistctrldeletecolumn} @@ -262,8 +263,8 @@ You must call {\it info.SetId()} to se ID of item you're interested in before calling this method. \pythonnote{The wxPython version of this method takes an integer parameter -for the item ID, and returns the wxListItem object. -} +for the item ID, an optional integer for the column number, and +returns the wxListItem object. } \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata} @@ -289,7 +290,7 @@ Returns the rectangle representing the item's size and position, in client coord {\it code} is one of wxLIST\_RECT\_BOUNDS, wxLIST\_RECT\_ICON, wxLIST\_RECT\_LABEL. \pythonnote{The wxPython version of this method accepts only the item -ID and returns the wxRect.} +ID and code and returns the wxRect.} \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate} @@ -323,7 +324,7 @@ Gets the item text for this item. \constfunc{long}{GetNextItem}{\param{long }{item}, \param{int }{geometry = wxLIST\_NEXT\_ALL}, \param{int }{state = wxLIST\_STATE\_DONTCARE}} -Searches for an item with the given goemetry or state, starting from +Searches for an item with the given goemetry or state, starting from {\it item} but excluding the {\it item} itself. If {\it item} is -1, the first item that matches the specified flags will be returned. @@ -331,6 +332,7 @@ Returns the first item with given state following {\it item} or -1 if no such item found. This function may be used to find all selected items in the control like this: + \begin{verbatim} long item = -1; for ( ;; ) @@ -413,7 +415,7 @@ 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 +this method. The first value is the item id and the second is the flags value mentioned above.} \membersection{wxListCtrl::InsertColumn}\label{wxlistctrlinsertcolumn} @@ -642,7 +644,7 @@ Sets the whole window style. \func{bool}{SortItems}{\param{wxListCtrlCompare }{fnSortCallBack}, \param{long }{data}} -Call this function to sorts the items in the list control. Sorting is done +Call this function to sort the items in the list control. Sorting is done using the specified {\it fnSortCallBack} function. This function must have the following prototype: @@ -658,7 +660,9 @@ second one and positive value if the first one is greater than the second one \wxheading{Parameters} \docparam{item1}{client data associated with the first item ({\bf NOT} the index).} + \docparam{item2}{client data associated with the second item ({\bf NOT} the index).} + \docparam{data}{the value passed to SortItems() itself.} Notice that the control may only be sorted on client data associated with the @@ -668,3 +672,8 @@ you want to be able to sort the items in the control. Please see the \helpref{listctrl sample}{samplelistctrl} for an example of using this function. +\pythonnote{wxPython uses the sortData parameter to pass the Python +function to call, so it is not available for programmer use. Call +SortItems with a reference to a callable object that expects two +parameters.} +