X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..3877c17eeb72b6ff6eb7670d06b47cef9037dcbc:/interface/listctrl.h?ds=sidebyside diff --git a/interface/listctrl.h b/interface/listctrl.h index 733608fb12..31e28708a7 100644 --- a/interface/listctrl.h +++ b/interface/listctrl.h @@ -44,47 +44,47 @@ 1. @beginStyleTable - @style{wxLC_LIST}: + @style{wxLC_LIST} Multicolumn list view, with optional small icons. Columns are computed automatically, i.e. you don't set columns as in wxLC_REPORT. In other words, the list wraps, unlike a wxListBox. - @style{wxLC_REPORT}: + @style{wxLC_REPORT} Single or multicolumn report view, with optional header. - @style{wxLC_VIRTUAL}: + @style{wxLC_VIRTUAL} The application provides items text on demand. May only be used with wxLC_REPORT. - @style{wxLC_ICON}: + @style{wxLC_ICON} Large icon view, with optional labels. - @style{wxLC_SMALL_ICON}: + @style{wxLC_SMALL_ICON} Small icon view, with optional labels. - @style{wxLC_ALIGN_TOP}: + @style{wxLC_ALIGN_TOP} Icons align to the top. Win32 default, Win32 only. - @style{wxLC_ALIGN_LEFT}: + @style{wxLC_ALIGN_LEFT} Icons align to the left. - @style{wxLC_AUTOARRANGE}: + @style{wxLC_AUTOARRANGE} Icons arrange themselves. Win32 only. - @style{wxLC_EDIT_LABELS}: + @style{wxLC_EDIT_LABELS} Labels are editable: the application will be notified when editing starts. - @style{wxLC_NO_HEADER}: + @style{wxLC_NO_HEADER} No header in report mode. - @style{wxLC_SINGLE_SEL}: + @style{wxLC_SINGLE_SEL} Single selection (default is multiple). - @style{wxLC_SORT_ASCENDING}: + @style{wxLC_SORT_ASCENDING} Sort in ascending order (must still supply a comparison callback in SortItems. - @style{wxLC_SORT_DESCENDING}: + @style{wxLC_SORT_DESCENDING} Sort in descending order (must still supply a comparison callback in SortItems. - @style{wxLC_HRULES}: + @style{wxLC_HRULES} Draws light horizontal rules between rows in report mode. - @style{wxLC_VRULES}: + @style{wxLC_VRULES} Draws light vertical rules between columns in report mode. @endStyleTable @library{wxcore} @category{ctrl} - @appearance{listctrl.png} + @see @ref overview_wxlistctrloverview "wxListCtrl overview", wxListView, wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem @@ -179,7 +179,7 @@ public: /** Deletes all items in the list control. - @b NB: This function does @e not send the + @note This function does @e not send the @c wxEVT_COMMAND_LIST_DELETE_ITEM event because deleting many items from the control would be too slow then (unlike wxListCtrl::DeleteItem). */ @@ -275,7 +275,7 @@ public: /** Returns the edit control being currently used to edit a label. Returns @NULL if no label is being edited. - @b NB: It is currently only implemented for wxMSW and the generic version, + @note It is currently only implemented for wxMSW and the generic version, not for the native Mac OS X version. */ wxTextCtrl* GetEditControl() const; @@ -399,7 +399,7 @@ public: Searches for an item to the right of the specified item. - @b NB: this parameter is only supported by wxMSW currently and ignored on + @note this parameter is only supported by wxMSW currently and ignored on other platforms. @a state can be a bitlist of the following: @@ -442,7 +442,7 @@ public: @a code can be one of @c wxLIST_RECT_BOUNDS, @c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL. - @wxsince{2.7.0} + @since 2.7.0 */ bool GetSubItemRect(long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const; @@ -628,7 +628,7 @@ public: @a dx specifies the number of pixels to scroll. If in list view mode, @a dx specifies the number of columns to scroll. @a dy always specifies the number of pixels to scroll vertically. - @b NB: This method is currently only implemented in the Windows version. + @note This method is currently only implemented in the Windows version. */ bool ScrollList(int dx, int dy); @@ -875,7 +875,7 @@ The m_stateMask and m_state members take flags from the following: guaranteed to be large enough to be able to contain all integer types and pointers. - @wxsince{2.8.4} + @since 2.8.4 */ bool SetItemPtrData(long item, wxUIntPtr data); @@ -951,7 +951,7 @@ public: /** Constructor. */ - wxListEvent(WXTYPE commandType = 0, int id = 0); + wxListEvent(wxEventType commandType = 0, int id = 0); /** For @c EVT_LIST_CACHE_HINT event only: return the first item which the @@ -1122,7 +1122,7 @@ public: @library{wxcore} @category{ctrl} - @appearance{listview.png} + @see wxListView::SetColumnImage */ @@ -1149,7 +1149,7 @@ public: Together with GetNextSelected() it can be used to iterate over all selected items in the control. - @returns The first selected item, if any, -1 otherwise. + @return The first selected item, if any, -1 otherwise. */ long GetFirstSelected() const; @@ -1164,7 +1164,7 @@ public: Used together with GetFirstSelected() to iterate over all selected items in the control. - @returns Returns the next selected item or -1 if there are no more of + @return Returns the next selected item or -1 if there are no more of them. */ long GetNextSelected(long item) const;