X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/164a797204e4738fceac9ad0d3ef2b0ffffae8cb..576adedbc01b335f921aaa3254ff805a07ef12f3:/docs/latex/wx/listctrl.tex?ds=sidebyside diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex index fb2b75828c..e92d627f7d 100644 --- a/docs/latex/wx/listctrl.tex +++ b/docs/latex/wx/listctrl.tex @@ -38,6 +38,12 @@ Using many of wxListCtrl features is shown in the To intercept events from a list control, use the event table macros described in \helpref{wxListEvent}{wxlistevent}. +{\bf Mac Note:} Starting with 2.8, wxListCtrl uses a native implementation for +report mode, and uses a generic implementation for other modes. You can use the +generic implementation for report mode as well by setting the +mac.listctrl.always\_use\_generic \helpref{wxSystemOption}{wxsystemoptions} to +1. + \wxheading{Derived from} \helpref{wxControl}{wxcontrol}\\ @@ -49,6 +55,10 @@ in \helpref{wxListEvent}{wxlistevent}. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{7cm} @@ -250,10 +260,12 @@ Ensures this item is visible. \membersection{wxListCtrl::FindItem}\label{wxlistctrlfinditem} -\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{const bool }{partial = false}} +\func{long}{FindItem}{\param{long }{start}, \param{const wxString\& }{str}, \param{bool }{partial = false}} Find an item whose label matches this string, starting from {\it start} or -the beginning if {\it start} is -1. +the beginning if {\it start} is -1. The string comparison is case +insensitive. If {\it partial} is true then this method will look for +items which begin with {\it str}. \func{long}{FindItem}{\param{long }{start}, \param{long }{data}} @@ -326,7 +338,8 @@ or small icon view). Returns the edit control being currently used to edit a label. Returns {\tt NULL} if no label is being edited. -{\bf NB:} It is currently only implemented for wxMSW. +{\bf NB:} It is currently only implemented for wxMSW and the generic version, +not for the native Mac OS X version. \membersection{wxListCtrl::GetImageList}\label{wxlistctrlgetimagelist} @@ -441,6 +454,7 @@ for \helpref{GetItemRect}{wxlistctrlgetitemrect}. \arg{code} can be one of \texttt{wxLIST\_RECT\_BOUNDS}, \texttt{wxLIST\_RECT\_ICON} or \texttt{wxLIST\_RECT\_LABEL}. +\newsince{2.7.0} \membersection{wxListCtrl::GetItemSpacing}\label{wxlistctrlgetitemspacing} @@ -572,7 +586,7 @@ list or report views (this is a limitation of the native Win32 control). \membersection{wxListCtrl::HitTest}\label{wxlistctrlhittest} -\func{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}, \param{long\* }{ptrSubItem}} +\constfunc{long}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}, \param{long *}{ptrSubItem}} Determines which item (if any) is at the specified point, giving details in {\it flags}. Returns index of the item or {\tt wxNOT\_FOUND} @@ -596,11 +610,11 @@ wxLIST\_HITTEST\_ONITEMSTATEICON.} If \arg{ptrSubItem} is not \NULL and the wxListCtrl is in the report mode the subitem (or column) number will also be provided. -This feature is currently only implemented under wxMSW and requires at least -comctl32.dll of verion 4.70 on the host system or the value stored in -\arg{ptrSubItem} will be always -1. To compile this feature into wxWidgets -library you need to have access to commctrl.h of version 4.70 that is provided -by Microsoft. +This feature is only available in version 2.7.0 or higher and is currently only +implemented under wxMSW and requires at least comctl32.dll of verion 4.70 on +the host system or the value stored in \arg{ptrSubItem} will be always -1. To +compile this feature into wxWidgets library you need to have access to +commctrl.h of version 4.70 that is provided by Microsoft. \pythonnote{A tuple of values is returned in the wxPython version of this method. The first value is the item id and the second is the @@ -933,6 +947,9 @@ from $0$ to {\it count}. Associates application-defined data with this item. +Notice that this function cannot be used to associate pointers with the control +items, use \helpref{SetItemPtrData}{wxlistctrlsetitemptrdata} instead. + \membersection{wxListCtrl::SetItemFont}\label{wxlistctrlsetitemfont} @@ -958,7 +975,7 @@ used. \membersection{wxListCtrl::SetItemColumnImage}\label{wxlistctrlsetitemcolumnimage} -\func{bool}{SetItemImage}{\param{long }{item}, \param{long }{column}\param{int }{image}} +\func{bool}{SetItemColumnImage}{\param{long }{item}, \param{long }{column}, \param{int }{image}} Sets the image associated with the item. In report view, you can specify the column. The image is an index into the image list associated with the list control. @@ -971,6 +988,18 @@ The image is an index into the image list associated with the list control. Sets the position of the item, in icon or small icon view. Windows only. +\membersection{wxListCtrl::SetItemPtrData}\label{wxlistctrlsetitemptrdata} + +\func{bool}{SetItemPtrData}{\param{long }{item}, \param{wxUIntPtr }{data}} + +Associates application-defined data with this item. The \arg{data} parameter may +be either an integer or a pointer cast to the \texttt{wxUIntPtr} type which is +guaranteed to be large enough to be able to contain all integer types and +pointers. + +\newsince{2.8.4} + + \membersection{wxListCtrl::SetItemState}\label{wxlistctrlsetitemstate} \func{bool}{SetItemState}{\param{long }{item}, \param{long }{state}, \param{long }{stateMask}} @@ -999,7 +1028,7 @@ The colour can be retrieved using \membersection{wxListCtrl::SetSingleStyle}\label{wxlistctrlsetsinglestyle} -\func{void}{SetSingleStyle}{\param{long }{style}, \param{const bool }{add = true}} +\func{void}{SetSingleStyle}{\param{long }{style}, \param{bool }{add = true}} Adds or removes a single window style.