]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/listctrl.tex
More mostly cross compiling related mods..
[wxWidgets.git] / docs / latex / wx / listctrl.tex
index 79a8478b031d68f4fee5a0a5d62dd93e6675d655..186a5d2a9b1548e969daa15c9316eaeff5c6f6f1 100644 (file)
@@ -129,13 +129,18 @@ Arranges the items in icon or small icon view. This only has effect on Win32. {\
 \twocolitem{wxLIST\_ALIGN\_SNAP\_TO\_GRID}{Snap to grid.}
 \end{twocollist}
 
-\membersection{wxListCtrl::Create}\label{wxlistctrlcreate}
+\membersection{wxListCtrl::AssignImageList}\label{wxlistctrlassignimagelist}
 
-\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
-\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
+\func{void}{AssignImageList}{\param{wxImageList*}{ imageList}, \param{int }{which}}
 
-Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
+Sets the image list associated with the control and 
+takes ownership of it (i.e. the control will, unlike when using
+SetImageList, delete the list when destroyed). {\it which} is one of
+wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented).
+
+\wxheading{See also}
+
+\helpref{wxListCtrl::SetImageList}{wxlistctrlsetimagelist}
 
 \membersection{wxListCtrl::ClearAll}\label{wxlistctrlclearall}
 
@@ -143,14 +148,13 @@ Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr}
 
 Deletes all items and all columns.
 
-\membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem}
-
-\func{bool}{DeleteItem}{\param{long }{item}}
+\membersection{wxListCtrl::Create}\label{wxlistctrlcreate}
 
-Deletes the specified item. This function sends the
-{\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event for the item being deleted.
+\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
+\param{long}{ style = wxLC\_ICON}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listCtrl"}}
 
-See also: \helpref{DeleteAllItems}{wxlistctrldeleteallitems}
+Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlconstr} for further details.
 
 \membersection{wxListCtrl::DeleteAllItems}\label{wxlistctrldeleteallitems}
 
@@ -168,6 +172,15 @@ from the control would be too slow then (unlike \helpref{DeleteItem}{wxlistctrld
 
 Deletes a column.
 
+\membersection{wxListCtrl::DeleteItem}\label{wxlistctrldeleteitem}
+
+\func{bool}{DeleteItem}{\param{long }{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::EditLabel}\label{wxlistctrledit}
 
 \func{void}{EditLabel}{\param{long }{item}}
@@ -260,12 +273,18 @@ Returns the specified image list. {\it which} may be one of:
 Gets information about the item. See \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem} for more
 information.
 
-You must call {\it info.SetId()} to se ID of item you're interested in
+You must call {\it info.SetId()} to the 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, an optional integer for the column number, and
-returns the wxListItem object.  }
+returns the wxListItem object.}
+
+\membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount}
+
+\constfunc{int}{GetItemCount}{\void}
+
+Returns the number of items in the list control.
 
 \membersection{wxListCtrl::GetItemData}\label{wxlistctrlgetitemdata}
 
@@ -293,20 +312,6 @@ Returns the rectangle representing the item's size and position, in client coord
 \pythonnote{The wxPython version of this method accepts only the item
 ID and code and returns the wxRect.}
 
-\membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
-
-\constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
-
-Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
-
-The {\bf stateMask} indicates which state flags are of interest.
-
-\membersection{wxListCtrl::GetItemCount}\label{wxlistctrlgetitemcount}
-
-\constfunc{int}{GetItemCount}{\void}
-
-Returns the number of items in the list control.
-
 \membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing}
 
 \constfunc{int}{GetItemSpacing}{\param{bool }{isSmall}}
@@ -315,6 +320,14 @@ Retrieves the spacing between icons in pixels.
 If {\it small} is TRUE, gets the spacing for the small icon
 view, otherwise the large icon view.
 
+\membersection{wxListCtrl::GetItemState}\label{wxlistctrlgetitemstate}
+
+\constfunc{int}{GetItemState}{\param{long }{item}, \param{long }{stateMask}}
+
+Gets the item state. For a list of state flags, see \helpref{wxListCtrl::SetItem}{wxlistctrlsetitem}.
+
+The {\bf stateMask} indicates which state flags are of interest.
+
 \membersection{wxListCtrl::GetItemText}\label{wxlistctrlgetitemtext}
 
 \constfunc{wxString}{GetItemText}{\param{long }{item}}
@@ -523,6 +536,14 @@ In small or normal icon view, {\it col} must be -1, and the column width is set
 Sets the image list associated with the control. {\it which} is one of
 wxIMAGE\_LIST\_NORMAL, wxIMAGE\_LIST\_SMALL, wxIMAGE\_LIST\_STATE (the last is unimplemented).
 
+This method does not take ownership of the image list, you have to
+delete it yourself.
+
+\wxheading{See also}
+
+\helpref{wxListCtrl::AssignImageList}{wxlistctrlassignimagelist}
+
+
 \membersection{wxListCtrl::SetItem}\label{wxlistctrlsetitem}
 
 \func{bool}{SetItem}{\param{wxListItem\& }{info}}