X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/884360bc11fe926bf91b23215bae719b562df91b..7f24fdbfeae21875fe73f5aa69aede354baed29b:/docs/latex/wx/listctrl.tex

diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index 50ff163bcd..ba963b06b5 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -12,6 +12,10 @@ To intercept events from a list control, use the event table macros described in
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/listctrl.h>
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
@@ -22,12 +26,12 @@ the list wraps, unlike a wxListBox.}
 \twocolitem{\windowstyle{wxLC\_REPORT}}{single or multicolumn report view, with optional header.}
 \twocolitem{\windowstyle{wxLC\_ICON}}{Large icon view, with optional labels.}
 \twocolitem{\windowstyle{wxLC\_SMALL\_ICON}}{Small icon view, with optional labels.}
-\twocolitem{\windowstyle{wxLC\_ALIGN\_TOP}}{Icons align to the top (default).}
-\twocolitem{\windowstyle{wxLC\_ALIGN\_LEFT}}{Icons align to the left.}
-\twocolitem{\windowstyle{wxLC\_AUTOARRANGE}}{Icons arrange themselves.}
-\twocolitem{\windowstyle{wxLC\_USER\_TEXT}}{The application provides label text on demand, except for column headers.}
+\twocolitem{\windowstyle{wxLC\_ALIGN\_TOP}}{Icons align to the top. Win32 default, Win32 only. }
+\twocolitem{\windowstyle{wxLC\_ALIGN\_LEFT}}{Icons align to the left. }
+\twocolitem{\windowstyle{wxLC\_AUTOARRANGE}}{Icons arrange themselves. Win32 only. }
+\twocolitem{\windowstyle{wxLC\_USER\_TEXT}}{The application provides label text on demand, except for column headers. Win32 only. }
 \twocolitem{\windowstyle{wxLC\_EDIT\_LABELS}}{Labels are editable: the application will be notified when editing starts.}
-\twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode.}
+\twocolitem{\windowstyle{wxLC\_NO\_HEADER}}{No header in report mode. Win32 only. }
 \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.}
@@ -35,6 +39,29 @@ the list wraps, unlike a wxListBox.}
 
 See also \helpref{window styles overview}{windowstyles}.
 
+\wxheading{Event handling}
+
+To process input from a list control, use these event handler macros to direct input to member
+functions that take a \helpref{wxListEvent}{wxlistevent} argument.
+
+\twocolwidtha{7cm}
+\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. 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.}
+\end{twocollist}%
+
 \wxheading{See also}
 
 \helpref{wxListCtrl overview}{wxlistctrloverview}, \helpref{wxListBox}{wxlistbox}, \helpref{wxTreeCtrl}{wxtreectrl},\rtfsp
@@ -85,7 +112,7 @@ Destructor, destroying the list control.
 
 \func{bool}{Arrange}{\param{int }{flag = wxLIST\_ALIGN\_DEFAULT}}
 
-Arranges the items in icon or small icon view. {\it flag} is one of:
+Arranges the items in icon or small icon view. This only has effect on Win32. {\it flag} is one of:
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
@@ -103,6 +130,12 @@ Arranges the items in icon or small icon view. {\it flag} is one of:
 
 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}}
@@ -111,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.
 
@@ -121,11 +154,17 @@ Deletes all the items in the list control.
 
 Deletes a column.
 
-\membersection{wxListCtrl::Edit}\label{wxlistctrledit}
+\membersection{wxListCtrl::EditLabel}\label{wxlistctrledit}
+
+\func{void}{EditLabel}{\param{long }{item}}
 
-\func{wxTextCtrl\&}{Edit}{\param{long }{item}}
+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.
 
-Starts editing a label.
+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}
 
@@ -150,6 +189,15 @@ the beginning if 'start' is -1.
 Find an item nearest this position in the specified direction, starting from
 the item after {\it start} or the beginning if {\it start} is -1.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{FindItem(start, str, partial=FALSE)}}{}
+\twocolitem{\bf{FindItemData(start, data)}}{}
+\twocolitem{\bf{FindItemAtPos(start, point, direction)}}{}
+\end{twocollist}}
+}
+
 \membersection{wxListCtrl::GetColumn}\label{wxlistctrlgetcolumn}
 
 \constfunc{bool}{GetColumn}{\param{int }{col}, \param{wxListItem\& }{item}}
@@ -198,6 +246,10 @@ 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 an integer parameter
+for the item ID, and returns the wxListItem object.
+}
+
 \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}
 
 \constfunc{long}{GetItemData}{\param{long }{item}}
@@ -210,6 +262,9 @@ Gets the application-defined data associated with this item.
 
 Returns the position of the item, in icon or small icon view.
 
+\pythonnote{The wxPython version of this method accepts only the item
+ID and returns the wxPoint.}
+
 \membersection{wxListCtrl::GetItemRect}\label{wxlistctrlgetitemrect}
 
 \constfunc{bool}{GetItemRect}{\param{long }{item}, \param{wxRect\& }{rect}, \param{int }{code = wxLIST\_RECT\_BOUNDS}}
@@ -218,6 +273,9 @@ 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.}
+
 \membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
 
 \constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
@@ -318,6 +376,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}}
@@ -329,6 +391,16 @@ For list view mode (only), inserts a column. For more details, see \helpref{wxLi
 
 For list view mode (only), inserts a column. For more details, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{InsertColumn(col, heading, format=wxLIST_FORMAT_LEFT,
+width=-1)}}{Creates a column using a header string only.}
+\twocolitem{\bf{InsertColumnInfo(col, item)}}{Creates a column using a
+wxListInfo.}
+\end{twocollist}}
+}
+
 \membersection{wxListCtrl::InsertItem}\label{wxlistctrlinsertitem}
 
 \func{long}{InsertItem}{\param{wxListItem\& }{info}}
@@ -358,6 +430,16 @@ Insert an image/string item.
 
 \docparam{imageIndex}{index into the image list associated with this control and view style}
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{InsertItem(item)}}{Inserts an item using a wxListItem.}
+\twocolitem{\bf{InsertStringItem(index, label)}}{Inserts a string item.}
+\twocolitem{\bf{InsertImageItem(index, imageIndex)}}{Inserts an image item.}
+\twocolitem{\bf{InsertImageStringItem(index, label, imageIndex)}}{Insert an image/string item.}
+\end{twocollist}}
+}
+
 \membersection{wxListCtrl::ScrollList}\label{wxlistctrlscrolllist}
 
 \func{bool}{ScrollList}{\param{int }{dx}, \param{int }{dy}}
@@ -390,6 +472,8 @@ information.
 Sets the column width.
 
 {\it width} can be a width in pixels or wxLIST\_AUTOSIZE (-1) or wxLIST\_AUTOSIZE\_USEHEADER (-2).
+wxLIST\_AUTOSIZE will resize the column to the length of its longest item. wxLIST\_AUTOSIZE\_USEHEADER
+will resize the column to the length of the header (Win32) or 80 pixels (other platforms).
 
 In small or normal icon view, {\it col} must be -1, and the column width is set for all columns.
 
@@ -439,17 +523,27 @@ The {\bf m\_stateMask} and {\bf m\_state} members take flags from the following:
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is.}
-\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event.}
+\twocolitem{wxLIST\_STATE\_DONTCARE}{Don't care what the state is. Win32 only. }
+\twocolitem{wxLIST\_STATE\_DROPHILITED}{The item is highlighted to receive a drop event. Win32 only. }
 \twocolitem{wxLIST\_STATE\_FOCUSED}{The item has the focus.}
 \twocolitem{wxLIST\_STATE\_SELECTED}{The item is selected.}
-\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state.}
+\twocolitem{wxLIST\_STATE\_CUT}{The item is in the cut state. Win32 only. }
 \end{twocollist}
 
 \func{long}{SetItem}{\param{long }{index}, \param{int }{col}, \param{const wxString\& }{label}, \param{int }{imageId = -1}}
 
 Sets a string field at a particular column.
 
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{SetItem(item)}}{Sets information about the given wxListItem.}
+\twocolitem{\bf{SetStringItem(index, col, label, imageId)}}{Sets a
+string or image at a given location.}
+\end{twocollist}}
+}
+
+
 \membersection{wxListCtrl::SetItemData}\label{wxlistctrlsetitemdata}
 
 \func{bool}{SetItemData}{\param{long }{item}, \param{long }{data}}