wxListCtrl Class Reference
[Controls]
#include <wx/listctrl.h>
Detailed Description
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. For all these modes, the items are stored in the control and must be added to it using wxListCtrl::InsertItem method.A special case of report view quite different from the other modes of the list control is a virtual control in which the items data (including text, images and attributes) is managed by the main program and is requested by the control itself only when needed which allows to have controls with millions of items without consuming much memory. To use virtual list control you must use wxListCtrl::SetItemCount first and overload at least wxListCtrl::OnGetItemText (and optionally wxListCtrl::OnGetItemImage or wxListCtrl::OnGetItemColumnImage and wxListCtrl::OnGetItemAttr) to return the information about the items when the control requests it. Virtual list control can be used as a normal one except that no operations which can take time proportional to the number of items in the control happen -- this is required to allow having a practically infinite number of items. For example, in a multiple selection virtual list control, the selections won't be sent when many items are selected at once because this could mean iterating over all the items.
Using many of wxListCtrl features is shown in the corresponding sample.
To intercept events from a list control, use the event table macros described in wxListEvent.
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 wxSystemOption() to 1.
Column reordering (only wxMSW): In report view, the control has several columns which are identified by their internal indices. By default, these indices correspond to their order on screen, i.e. the column 0 appears first (in the left-to-right or maybe right-to-left if the current language uses this writing direction), the column 1 next and so on. However it is possible to reorder the columns visual order using SetColumnsOrder() method and the user can also rearrange the columns interactively by dragging them. In this case, the index of the column is not the same as its order and the functions GetColumnOrder() and GetColumnIndexFromOrder() should be used to translate between them.
Styles:
- 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.
- wxLC_REPORT:Single or multicolumn report view, with optional header.
- wxLC_VIRTUAL:The application provides items text on demand. May only be used with wxLC_REPORT.
- wxLC_ICON:Large icon view, with optional labels.
- wxLC_SMALL_ICON:Small icon view, with optional labels.
- wxLC_ALIGN_TOP:Icons align to the top. Win32 default, Win32 only.
- wxLC_ALIGN_LEFT:Icons align to the left.
- wxLC_AUTOARRANGE:Icons arrange themselves. Win32 only.
- wxLC_EDIT_LABELS:Labels are editable: the application will be notified when editing starts.
- wxLC_NO_HEADER:No header in report mode.
- wxLC_SINGLE_SEL:Single selection (default is multiple).
- wxLC_SORT_ASCENDING:Sort in ascending order. (You must still supply a comparison callback in wxListCtrl::SortItems.)
- wxLC_SORT_DESCENDING:Sort in descending order. (You must still supply a comparison callback in wxListCtrl::SortItems.)
- wxLC_HRULES:Draws light horizontal rules between rows in report mode.
- wxLC_VRULES:Draws light vertical rules between columns in report mode.
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
Event macros:
- EVT_LIST_BEGIN_DRAG(id, func):Begin dragging with the left mouse button.
- EVT_LIST_BEGIN_RDRAG(id, func):Begin dragging with the right mouse button..
- EVT_BEGIN_LABEL_EDIT(id, func):Begin editing a label. This can be prevented by calling Veto().
- EVT_LIST_END_LABEL_EDIT(id, func):Finish editing a label. This can be prevented by calling Veto().
- EVT_LIST_DELETE_ITEM(id, func):An item was deleted.
- EVT_LIST_DELETE_ALL_ITEMS(id, func):All items were deleted.
- EVT_LIST_ITEM_SELECTED(id, func):The item has been selected.
- EVT_LIST_ITEM_DESELECTED(id, func):The item has been deselected.
- EVT_LIST_ITEM_ACTIVATED(id, func):The item has been activated (ENTER or double click).
- EVT_LIST_ITEM_FOCUSED(id, func):The currently focused item has changed.
- EVT_LIST_ITEM_MIDDLE_CLICK(id, func):The middle mouse button has been clicked on an item.
- EVT_LIST_ITEM_RIGHT_CLICK(id, func):The right mouse button has been clicked on an item.
- EVT_LIST_KEY_DOWN(id, func):A key has been pressed.
- EVT_LIST_INSERT_ITEM(id, func):An item has been inserted.
- EVT_LIST_COL_CLICK(id, func):A column (m_col) has been left-clicked.
- EVT_LIST_COL_RIGHT_CLICK(id, func):A column (m_col) has been right-clicked.
- EVT_LIST_COL_BEGIN_DRAG(id, func):The user started resizing a column - can be vetoed.
- EVT_LIST_COL_DRAGGING(id, func):The divider between columns is being dragged.
- EVT_LIST_COL_END_DRAG(id, func):A column has been resized by the user.
- EVT_LIST_CACHE_HINT(id, func):Prepare cache for a virtual list control.
- See also:
- wxListCtrl Overview, wxListView, wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem, wxEditableListBox
Public Member Functions | |
| wxListCtrl () | |
| wxListCtrl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxLC_ICON, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxListCtrlNameStr) | |
| virtual | ~wxListCtrl () |
| bool | Arrange (int flag=wxLIST_ALIGN_DEFAULT) |
| void | AssignImageList (wxImageList *imageList, int which) |
| void | ClearAll () |
| bool | Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxLC_ICON, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxListCtrlNameStr) |
| bool | DeleteAllItems () |
| bool | DeleteColumn (int col) |
| bool | DeleteItem (long item) |
| void | EditLabel (long item) |
| bool | EnsureVisible (long item) |
| long | FindItem (long start, const wxString &str, bool partial=false) |
| long | FindItem (long start, long data) |
| long | FindItem (long start, const wxPoint &pt, int direction) |
| bool | GetColumn (int col, wxListItem &item) const |
| int | GetColumnCount () const |
| int | GetColumnIndexFromOrder (int order) const |
| int | GetColumnOrder (int col) const |
| int | GetColumnWidth (int col) const |
| wxArrayInt | GetColumnsOrder () const |
| int | GetCountPerPage () const |
| wxTextCtrl * | GetEditControl () const |
| wxImageList * | GetImageList (int which) const |
| bool | GetItem (wxListItem &info) const |
| wxColour | GetItemBackgroundColour (long item) const |
| int | GetItemCount () const |
| long | GetItemData (long item) const |
| wxFont | GetItemFont (long item) const |
| bool | GetItemPosition (long item, wxPoint &pos) const |
| bool | GetItemRect (long item, wxRect &rect, int code=wxLIST_RECT_BOUNDS) const |
| wxSize | GetItemSpacing () const |
| int | GetItemState (long item, long stateMask) const |
| wxString | GetItemText (long item) const |
| wxColour | GetItemTextColour (long item) const |
| long | GetNextItem (long item, int geometry=wxLIST_NEXT_ALL, int state=wxLIST_STATE_DONTCARE) const |
| int | GetSelectedItemCount () const |
| bool | GetSubItemRect (long item, long subItem, wxRect &rect, int code=wxLIST_RECT_BOUNDS) const |
| wxColour | GetTextColour () const |
| long | GetTopItem () const |
| wxRect | GetViewRect () const |
| long | HitTest (const wxPoint &point, int &flags, long *ptrSubItem) const |
| long | InsertColumn (long col, wxListItem &info) |
| long | InsertColumn (long col, const wxString &heading, int format=wxLIST_FORMAT_LEFT, int width=-1) |
| long | InsertItem (wxListItem &info) |
| long | InsertItem (long index, const wxString &label) |
| long | InsertItem (long index, int imageIndex) |
| long | InsertItem (long index, const wxString &label, int imageIndex) |
| virtual wxListItemAttr * | OnGetItemAttr (long item) const |
| virtual int | OnGetItemColumnImage (long item, long column) const |
| virtual int | OnGetItemImage (long item) const |
| virtual wxString | OnGetItemText (long item, long column) const |
| void | RefreshItem (long item) |
| void | RefreshItems (long itemFrom, long itemTo) |
| bool | ScrollList (int dx, int dy) |
| void | SetBackgroundColour (const wxColour &col) |
| bool | SetColumn (int col, wxListItem &item) |
| bool | SetColumnWidth (int col, int width) |
| bool | SetColumnOrder (const wxArrayInt &orders) const |
| void | SetImageList (wxImageList *imageList, int which) |
| bool | SetItem (wxListItem &info) |
| long | SetItem (long index, int col, const wxString &label, int imageId=-1) |
| void | SetItemBackgroundColour (long item, const wxColour &col) |
| bool | SetItemColumnImage (long item, long column, int image) |
| void | SetItemCount (long count) |
| bool | SetItemData (long item, long data) |
| void | SetItemFont (long item, const wxFont &font) |
| bool | SetItemImage (long item, int image) |
| bool | SetItemImage (long item, int image, int selImage) |
| bool | SetItemPosition (long item, const wxPoint &pos) |
| bool | SetItemPtrData (long item, wxUIntPtr data) |
| bool | SetItemState (long item, long state, long stateMask) |
| void | SetItemText (long item, const wxString &text) |
| void | SetItemTextColour (long item, const wxColour &col) |
| void | SetSingleStyle (long style, bool add=true) |
| void | SetTextColour (const wxColour &col) |
| void | SetWindowStyleFlag (long style) |
| bool | SortItems (wxListCtrlCompare fnSortCallBack, long data) |
Constructor & Destructor Documentation
| wxListCtrl::wxListCtrl | ( | ) |
Default constructor.
| wxListCtrl::wxListCtrl | ( | wxWindow * | parent, | |
| wxWindowID | id, | |||
| const wxPoint & | pos = wxDefaultPosition, |
|||
| const wxSize & | size = wxDefaultSize, |
|||
| long | style = wxLC_ICON, |
|||
| const wxValidator & | validator = wxDefaultValidator, |
|||
| const wxString & | name = wxListCtrlNameStr | |||
| ) |
Constructor, creating and showing a list control.
- Parameters:
-
parent Parent window. Must not be NULL. id Window identifier. The value wxID_ANY indicates a default value. pos Window position. size Window size. If wxDefaultSize is specified then the window is sized appropriately. style Window style. See wxListCtrl. validator Window validator. name Window name.
- See also:
- Create(), wxValidator
| virtual wxListCtrl::~wxListCtrl | ( | ) | [virtual] |
Destructor, destroying the list control.
Member Function Documentation
| bool wxListCtrl::Arrange | ( | int | flag = wxLIST_ALIGN_DEFAULT |
) |
Arranges the items in icon or small icon view. This only has effect on Win32. flag is one of:
- wxLIST_ALIGN_DEFAULT: Default alignment.
- wxLIST_ALIGN_LEFT: Align to the left side of the control.
- wxLIST_ALIGN_TOP: Align to the top side of the control.
- wxLIST_ALIGN_SNAP_TO_GRID: Snap to grid.
| void wxListCtrl::AssignImageList | ( | wxImageList * | imageList, | |
| int | which | |||
| ) |
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). which is one of wxIMAGE_LIST_NORMAL, wxIMAGE_LIST_SMALL, wxIMAGE_LIST_STATE (the last is unimplemented).
- See also:
- SetImageList()
| void wxListCtrl::ClearAll | ( | ) |
Deletes all items and all columns.
| bool wxListCtrl::Create | ( | wxWindow * | parent, | |
| wxWindowID | id, | |||
| const wxPoint & | pos = wxDefaultPosition, |
|||
| const wxSize & | size = wxDefaultSize, |
|||
| long | style = wxLC_ICON, |
|||
| const wxValidator & | validator = wxDefaultValidator, |
|||
| const wxString & | name = wxListCtrlNameStr | |||
| ) |
Creates the list control. See wxListCtrl() for further details.
| bool wxListCtrl::DeleteAllItems | ( | ) |
Deletes all items in the list control.
- Note:
- This function does not send the
wxEVT_COMMAND_LIST_DELETE_ITEMevent because deleting many items from the control would be too slow then (unlike wxListCtrl::DeleteItem).
| bool wxListCtrl::DeleteColumn | ( | int | col | ) |
Deletes a column.
| bool wxListCtrl::DeleteItem | ( | long | item | ) |
Deletes the specified item. This function sends the wxEVT_COMMAND_LIST_DELETE_ITEM event for the item being deleted. See also: DeleteAllItems()
| void wxListCtrl::EditLabel | ( | 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. 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.
| bool wxListCtrl::EnsureVisible | ( | long | item | ) |
Ensures this item is visible.
| long wxListCtrl::FindItem | ( | long | start, | |
| const wxString & | str, | |||
| bool | partial = false | |||
| ) |
Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.
| long wxListCtrl::FindItem | ( | long | start, | |
| long | data | |||
| ) |
Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.
| long wxListCtrl::FindItem | ( | long | start, | |
| const wxPoint & | pt, | |||
| int | direction | |||
| ) |
Find an item nearest this position in the specified direction, starting from start or the beginning if start is -1.
| bool wxListCtrl::GetColumn | ( | int | col, | |
| wxListItem & | item | |||
| ) | const |
Gets information about this column. See SetItem() for more information.
| int wxListCtrl::GetColumnCount | ( | ) | const |
Returns the number of columns.
| int wxListCtrl::GetColumnIndexFromOrder | ( | int | order | ) | const |
Gets the column number by visual order index (report view only).
| int wxListCtrl::GetColumnOrder | ( | int | col | ) | const |
Gets the column visual order index (valid in report view only).
| int wxListCtrl::GetColumnWidth | ( | int | col | ) | const |
Gets the column width (report view only).
| wxArrayInt wxListCtrl::GetColumnsOrder | ( | ) | const |
Returns the array containing the orders of all columns. On error, an empty array is returned.
| int wxListCtrl::GetCountPerPage | ( | ) | const |
Gets the number of items that can fit vertically in the visible area of the list control (list or report view) or the total number of items in the list control (icon or small icon view).
| wxTextCtrl* wxListCtrl::GetEditControl | ( | ) | const |
Returns the edit control being currently used to edit a label. Returns NULL if no label is being edited.
- Note:
- It is currently only implemented for wxMSW and the generic version, not for the native Mac OS X version.
| wxImageList* wxListCtrl::GetImageList | ( | int | which | ) | const |
Returns the specified image list. which may be one of:
- wxIMAGE_LIST_NORMAL: The normal (large icon) image list.
- wxIMAGE_LIST_SMALL: The small icon image list.
- wxIMAGE_LIST_STATE: The user-defined state image list (unimplemented).
| bool wxListCtrl::GetItem | ( | wxListItem & | info | ) | const |
Gets information about the item. See SetItem() for more information. You must call info.SetId() to the ID of item you're interested in before calling this method.
| wxColour wxListCtrl::GetItemBackgroundColour | ( | long | item | ) | const |
Returns the colour for this item. If the item has no specific colour, returns an invalid colour (and not the default background control of the control itself).
- See also:
- GetItemTextColour()
| int wxListCtrl::GetItemCount | ( | ) | const |
Returns the number of items in the list control.
| long wxListCtrl::GetItemData | ( | long | item | ) | const |
Gets the application-defined data associated with this item.
| wxFont wxListCtrl::GetItemFont | ( | long | item | ) | const |
Returns the item's font.
| bool wxListCtrl::GetItemPosition | ( | long | item, | |
| wxPoint & | pos | |||
| ) | const |
Returns the position of the item, in icon or small icon view.
| bool wxListCtrl::GetItemRect | ( | long | item, | |
| wxRect & | rect, | |||
| int | code = wxLIST_RECT_BOUNDS | |||
| ) | const |
Returns the rectangle representing the item's size and position, in physical coordinates. code is one of wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON, wxLIST_RECT_LABEL.
| wxSize wxListCtrl::GetItemSpacing | ( | ) | const |
Retrieves the spacing between icons in pixels: horizontal spacing is returned as x component of the wxSize object and the vertical spacing as its y component.
| int wxListCtrl::GetItemState | ( | long | item, | |
| long | stateMask | |||
| ) | const |
Gets the item state. For a list of state flags, see SetItem(). The stateMask indicates which state flags are of interest.
| wxString wxListCtrl::GetItemText | ( | long | item | ) | const |
Gets the item text for this item.
| wxColour wxListCtrl::GetItemTextColour | ( | long | item | ) | const |
Returns the colour for this item. If the item has no specific colour, returns an invalid colour (and not the default foreground control of the control itself as this wouldn't allow distinguishing between items having the same colour as the current control foreground and items with default colour which, hence, have always the same colour as the control).
| long wxListCtrl::GetNextItem | ( | long | item, | |
| int | geometry = wxLIST_NEXT_ALL, |
|||
| int | state = wxLIST_STATE_DONTCARE | |||
| ) | const |
Searches for an item with the given geometry or state, starting from item but excluding the item itself. If item is -1, the first item that matches the specified flags will be returned. Returns the first item with given state following item or -1 if no such item found. This function may be used to find all selected items in the control like this:
geometry can be one of:
wxLIST_NEXT_ABOVE
Searches for an item above the specified item.
wxLIST_NEXT_ALL
Searches for subsequent item by index.
wxLIST_NEXT_BELOW
Searches for an item below the specified item.
wxLIST_NEXT_LEFT
Searches for an item to the left of the specified item.
wxLIST_NEXT_RIGHT
Searches for an item to the right of the specified item.
- Note:
- this parameter is only supported by wxMSW currently and ignored on other platforms. state can be a bitlist of the following:
Don't care what the state is.
wxLIST_STATE_DROPHILITED
The item indicates it is a drop target.
wxLIST_STATE_FOCUSED
The item has the focus.
wxLIST_STATE_SELECTED
The item is selected.
wxLIST_STATE_CUT
The item is selected as part of a cut and paste operation.
| int wxListCtrl::GetSelectedItemCount | ( | ) | const |
Returns the number of selected items in the list control.
| bool wxListCtrl::GetSubItemRect | ( | long | item, | |
| long | subItem, | |||
| wxRect & | rect, | |||
| int | code = wxLIST_RECT_BOUNDS | |||
| ) | const |
Returns the rectangle representing the size and position, in physical coordinates, of the given subitem, i.e. the part of the row item in the column subItem. This method is only meaningfull when the wxListCtrl is in the report mode. If subItem parameter is equal to the special value wxLIST_GETSUBITEMRECT_WHOLEITEM the return value is the same as for GetItemRect(). code can be one of wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON or wxLIST_RECT_LABEL.
- Since:
- 2.7.0
| wxColour wxListCtrl::GetTextColour | ( | ) | const |
Gets the text colour of the list control.
| long wxListCtrl::GetTopItem | ( | ) | const |
Gets the index of the topmost visible item when in list or report view.
| wxRect wxListCtrl::GetViewRect | ( | ) | const |
Returns the rectangle taken by all items in the control. In other words, if the controls client size were equal to the size of this rectangle, no scrollbars would be needed and no free space would be left. Note that this function only works in the icon and small icon views, not in list or report views (this is a limitation of the native Win32 control).
| long wxListCtrl::HitTest | ( | const wxPoint & | point, | |
| int & | flags, | |||
| long * | ptrSubItem | |||
| ) | const |
Determines which item (if any) is at the specified point, giving details in flags. Returns index of the item or wxNOT_FOUND if no item is at the specified point. flags will be a combination of the following flags:
wxLIST_HITTEST_ABOVE
Above the client area.
wxLIST_HITTEST_BELOW
Below the client area.
wxLIST_HITTEST_NOWHERE
In the client area but below the last item.
wxLIST_HITTEST_ONITEMICON
On the bitmap associated with an item.
wxLIST_HITTEST_ONITEMLABEL
On the label (string) associated with an item.
wxLIST_HITTEST_ONITEMRIGHT
In the area to the right of an item.
wxLIST_HITTEST_ONITEMSTATEICON
On the state icon for a tree view item that is in a user-defined state.
wxLIST_HITTEST_TOLEFT
To the right of the client area.
wxLIST_HITTEST_TORIGHT
To the left of the client area.
wxLIST_HITTEST_ONITEM
Combination of wxLIST_HITTEST_ONITEMICON, wxLIST_HITTEST_ONITEMLABEL, wxLIST_HITTEST_ONITEMSTATEICON.
If ptrSubItem is not NULL and the wxListCtrl is in the report mode the subitem (or column) number will also be provided. 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 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.
| long wxListCtrl::InsertColumn | ( | long | col, | |
| wxListItem & | info | |||
| ) |
For report view mode (only), inserts a column. For more details, see SetItem().
| long wxListCtrl::InsertColumn | ( | long | col, | |
| const wxString & | heading, | |||
| int | format = wxLIST_FORMAT_LEFT, |
|||
| int | width = -1 | |||
| ) |
For report view mode (only), inserts a column. For more details, see SetItem().
| long wxListCtrl::InsertItem | ( | wxListItem & | info | ) |
Insert a wxListItem.
- Parameters:
-
info wxListItem object
| long wxListCtrl::InsertItem | ( | long | index, | |
| const wxString & | label | |||
| ) |
Insert an string item.
- Parameters:
-
index Index of the new item, supplied by the application label String label
| long wxListCtrl::InsertItem | ( | long | index, | |
| int | imageIndex | |||
| ) |
Insert an image item.
- Parameters:
-
index Index of the new item, supplied by the application imageIndex Index into the image list associated with this control and view style
| long wxListCtrl::InsertItem | ( | long | index, | |
| const wxString & | label, | |||
| int | imageIndex | |||
| ) |
Insert an image/string item.
- Parameters:
-
index Index of the new item, supplied by the application label String label imageIndex Index into the image list associated with this control and view style
| virtual wxListItemAttr* wxListCtrl::OnGetItemAttr | ( | long | item | ) | const [virtual] |
This function may be overloaded in the derived class for a control with wxLC_VIRTUAL style. It should return the attribute for the for the specified item or NULL to use the default appearance parameters. wxListCtrl will not delete the pointer or keep a reference of it. You can return the same wxListItemAttr pointer for every OnGetItemAttr call. The base class version always returns NULL.
| virtual int wxListCtrl::OnGetItemColumnImage | ( | long | item, | |
| long | column | |||
| ) | const [virtual] |
Overload this function in the derived class for a control with wxLC_VIRTUAL and wxLC_REPORT styles in order to specify the image index for the given line and column. The base class version always calls OnGetItemImage for the first column, else it returns -1.
- See also:
- OnGetItemText(), OnGetItemImage(), OnGetItemAttr()
| virtual int wxListCtrl::OnGetItemImage | ( | long | item | ) | const [virtual] |
This function must be overloaded in the derived class for a control with wxLC_VIRTUAL style having an image list (if the control doesn't have an image list, it is not necessary to overload it). It should return the index of the items image in the controls image list or -1 for no image. In a control with wxLC_REPORT style, OnGetItemImage only gets called for the first column of each line. The base class version always returns -1.
- See also:
- OnGetItemText(), OnGetItemColumnImage(), OnGetItemAttr()
| virtual wxString wxListCtrl::OnGetItemText | ( | long | item, | |
| long | column | |||
| ) | const [virtual] |
This function must be overloaded in the derived class for a control with wxLC_VIRTUAL style. It should return the string containing the text of the given column for the specified item.
| void wxListCtrl::RefreshItem | ( | long | item | ) |
Redraws the given item. This is only useful for the virtual list controls as without calling this function the displayed value of the item doesn't change even when the underlying data does change.
- See also:
- RefreshItems()
| void wxListCtrl::RefreshItems | ( | long | itemFrom, | |
| long | itemTo | |||
| ) |
Redraws the items between itemFrom and itemTo. The starting item must be less than or equal to the ending one. Just as RefreshItem() this is only useful for virtual list controls.
| bool wxListCtrl::ScrollList | ( | int | dx, | |
| int | dy | |||
| ) |
Scrolls the list control. If in icon, small icon or report view mode, dx specifies the number of pixels to scroll. If in list view mode, dx specifies the number of columns to scroll. dy always specifies the number of pixels to scroll vertically.
- Note:
- This method is currently only implemented in the Windows version.
| void wxListCtrl::SetBackgroundColour | ( | const wxColour & | col | ) | [virtual] |
| bool wxListCtrl::SetColumn | ( | int | col, | |
| wxListItem & | item | |||
| ) |
Sets information about this column. See SetItem() for more information.
| bool wxListCtrl::SetColumnWidth | ( | int | col, | |
| int | width | |||
| ) |
Sets the column width. 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, col must be -1, and the column width is set for all columns.
| bool wxListCtrl::SetColumnOrder | ( | const wxArrayInt & | orders | ) | const |
Sets the order of all columns at once. The orders array must have the same number elements as the number of columns and contain each position exactly once. This function is valid in report view only.
| void wxListCtrl::SetImageList | ( | wxImageList * | imageList, | |
| int | which | |||
| ) |
Sets the image list associated with the control. 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.
- See also:
- AssignImageList()
| bool wxListCtrl::SetItem | ( | wxListItem & | info | ) |
Sets the data of an item.
wxListItem is a class with the following members
- long m_mask: Indicates which fields are valid. See below.
- long m_itemId: Zero based item position.
- int m_col: Zero based column index.
- long m_state: The state of the item: See below for valid state flags.
- long m_stateMask: A mask indicating which state flags are valid. See below.
- wxStrign m_text: the label (or header for columns)
- int m_image: The zero based index into an image list
- long m_data: Application defined data
- int m_format: For columns only: Either of wxLIST_FORMAT_LEFT, wxLIST_FORMAT_RIGHT, wxLIST_FORMAT_CENTRE
- int m_width: For columns only: the width of the column
The m_mask member contains a bitlist specifying which of the other fields are valid. The flags are:
- wxLIST_MASK_STATE: The m_state field is valid.
- wxLIST_MASK_TEXT: The m_text field is valid.
- wxLIST_MASK_IMAGE: The m_image field is valid.
- wxLIST_MASK_DATA: The m_data field is valid.
- wxLIST_MASK_WIDTH: The m_width field is valid.
- wxLIST_MASK_FORMAT: The m_format field is valid.
The m_stateMask and m_state members take flags from the following:
- wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
- wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
- wxLIST_STATE_FOCUSED: The item has the focus.
- wxLIST_STATE_SELECTED: The item is selected.
- wxLIST_STATE_CUT: The item is in the cut state. Win32 only.
The wxListItem object can also contain item-specific colour and font information: for this you need to call one of SetTextColour(), SetBackgroundColour() or SetFont() functions on it passing it the colour/font to use. If the colour/font is not specified, the default list control colour/font is used.
| long wxListCtrl::SetItem | ( | long | index, | |
| int | col, | |||
| const wxString & | label, | |||
| int | imageId = -1 | |||
| ) |
Sets a string field at a particular column.
| void wxListCtrl::SetItemBackgroundColour | ( | long | item, | |
| const wxColour & | col | |||
| ) |
Sets the background colour for this item. This function only works in report view. The colour can be retrieved using GetItemBackgroundColour().
| bool wxListCtrl::SetItemColumnImage | ( | long | item, | |
| long | column, | |||
| 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.
| void wxListCtrl::SetItemCount | ( | long | count | ) |
This method can only be used with virtual list controls.
It is used to indicate to the control the number of items it contains. After calling it, the main program should be ready to handle calls to various item callbacks (such as wxListCtrl::OnGetItemText) for all items in the range from 0 to count.
Notice that the control is not necessarily redrawn after this call as it may be undesirable if an item which is not visible on the screen anyhow was added to or removed from a control displaying many items, if you do need to refresh the display you can just call Refresh() manually.
| bool wxListCtrl::SetItemData | ( | long | item, | |
| long | data | |||
| ) |
Associates application-defined data with this item. Notice that this function cannot be used to associate pointers with the control items, use SetItemPtrData() instead.
| void wxListCtrl::SetItemFont | ( | long | item, | |
| const wxFont & | font | |||
| ) |
Sets the item's font.
| bool wxListCtrl::SetItemImage | ( | long | item, | |
| int | image | |||
| ) |
Sets the unselected and selected images associated with the item. The images are indices into the image list associated with the list control.
| bool wxListCtrl::SetItemImage | ( | long | item, | |
| int | image, | |||
| int | selImage | |||
| ) |
Sets the unselected and selected images associated with the item. The images are indices into the image list associated with the list control. This form is deprecated: selImage is not used.
| bool wxListCtrl::SetItemPosition | ( | long | item, | |
| const wxPoint & | pos | |||
| ) |
Sets the position of the item, in icon or small icon view. Windows only.
| bool wxListCtrl::SetItemPtrData | ( | long | item, | |
| wxUIntPtr | data | |||
| ) |
Associates application-defined data with this item. The data parameter may be either an integer or a pointer cast to the wxUIntPtr type which is guaranteed to be large enough to be able to contain all integer types and pointers.
- Since:
- 2.8.4
| bool wxListCtrl::SetItemState | ( | long | item, | |
| long | state, | |||
| long | stateMask | |||
| ) |
Sets the item state. For a list of state flags, see SetItem(). The stateMask indicates which state flags are valid.
| void wxListCtrl::SetItemText | ( | long | item, | |
| const wxString & | text | |||
| ) |
Sets the item text for this item.
| void wxListCtrl::SetItemTextColour | ( | long | item, | |
| const wxColour & | col | |||
| ) |
Sets the colour for this item. This function only works in report view. The colour can be retrieved using GetItemTextColour().
| void wxListCtrl::SetSingleStyle | ( | long | style, | |
| bool | add = true | |||
| ) |
Adds or removes a single window style.
| void wxListCtrl::SetTextColour | ( | const wxColour & | col | ) |
Sets the text colour of the list control.
| void wxListCtrl::SetWindowStyleFlag | ( | long | style | ) | [virtual] |
Sets the whole window style, deleting all items.
Reimplemented from wxWindow.
| bool wxListCtrl::SortItems | ( | wxListCtrlCompare | fnSortCallBack, | |
| long | data | |||
| ) |
Call this function to sort the items in the list control. Sorting is done using the specified fnSortCallBack function. This function must have the following prototype:
It is called each time when the two items must be compared and should return 0 if the items are equal, negative value if the first item is less than the second one and positive value if the first one is greater than the second one (the same convention as used by qsort(3)).
- Parameters:
-
item1 client data associated with the first item (NOT the index). item2 client data associated with the second item (NOT the index). data the value passed to SortItems() itself.
