@b 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.
+ 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.
+
@beginStyleTable
@style{wxLC_LIST}
Draws light vertical rules between columns in report mode.
@endStyleTable
+
+ @beginEventTable{wxListEvent}
+ @event{EVT_LIST_BEGIN_DRAG(id, func)}
+ Begin dragging with the left mouse button.
+ @event{EVT_LIST_BEGIN_RDRAG(id, func)}
+ Begin dragging with the right mouse button..
+ @event{EVT_BEGIN_LABEL_EDIT(id, func)}
+ Begin editing a label. This can be prevented by calling Veto().
+ @event{EVT_LIST_END_LABEL_EDIT(id, func)}
+ Finish editing a label. This can be prevented by calling Veto().
+ @event{EVT_LIST_DELETE_ITEM(id, func)}
+ An item was deleted.
+ @event{EVT_LIST_DELETE_ALL_ITEMS(id, func)}
+ All items were deleted.
+ @event{EVT_LIST_ITEM_SELECTED(id, func)}
+ The item has been selected.
+ @event{EVT_LIST_ITEM_DESELECTED(id, func)}
+ The item has been deselected.
+ @event{EVT_LIST_ITEM_ACTIVATED(id, func)}
+ The item has been activated (ENTER or double click).
+ @event{EVT_LIST_ITEM_FOCUSED(id, func)}
+ The currently focused item has changed.
+ @event{EVT_LIST_ITEM_MIDDLE_CLICK(id, func)}
+ The middle mouse button has been clicked on an item.
+ @event{EVT_LIST_ITEM_RIGHT_CLICK(id, func)}
+ The right mouse button has been clicked on an item.
+ @event{EVT_LIST_KEY_DOWN(id, func)}
+ A key has been pressed.
+ @event{EVT_LIST_INSERT_ITEM(id, func)}
+ An item has been inserted.
+ @event{EVT_LIST_COL_CLICK(id, func)}
+ A column (m_col) has been left-clicked.
+ @event{EVT_LIST_COL_RIGHT_CLICK(id, func)}
+ A column (m_col) has been right-clicked.
+ @event{EVT_LIST_COL_BEGIN_DRAG(id, func)}
+ The user started resizing a column - can be vetoed.
+ @event{EVT_LIST_COL_DRAGGING(id, func)}
+ The divider between columns is being dragged.
+ @event{EVT_LIST_COL_END_DRAG(id, func)}
+ A column has been resized by the user.
+ @event{EVT_LIST_CACHE_HINT(id, func)}
+ Prepare cache for a virtual list control.
+ @endEventTable
+
+
@library{wxcore}
@category{ctrl}
<!-- @appearance{listctrl.png} -->
@see @ref overview_listctrl "wxListCtrl Overview", wxListView,
- wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem
+ wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem, wxEditableListBox
*/
class wxListCtrl : public wxControl
{
public:
- //@{
/**
- Constructor, creating and showing a list control.
+ Default constructor.
*/
wxListCtrl();
long style = wxLC_ICON,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxListCtrlNameStr);
- //@}
/**
Destructor, destroying the list control.
*/
- ~wxListCtrl();
+ virtual ~wxListCtrl();
/**
Arranges the items in icon or small icon view. This only has effect on Win32.
@a 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.
+ - 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.
*/
bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
*/
bool EnsureVisible(long item);
- //@{
/**
- Find an item nearest this position in the specified direction, starting from
- @a start or the beginning if @a start is -1.
-
-
- @b FindItem( start, str, partial = @false )
-
-
- @b FindItemData( start, data )
-
-
- @b FindItemAtPos( start, point, direction )
+ Find an item nearest this position in the specified direction,
+ starting from @a start or the beginning if @a start is -1.
*/
long FindItem(long start, const wxString& str,
bool partial = false);
+ /**
+ Find an item nearest this position in the specified direction,
+ starting from @a start or the beginning if @a start is -1.
+ */
long FindItem(long start, long data);
+ /**
+ Find an item nearest this position in the specified direction,
+ starting from @a start or the beginning if @a start is -1.
+ */
long FindItem(long start, const wxPoint& pt, int direction);
- //@}
/**
Gets information about this column. See SetItem() for more
/**
Returns the specified image list. @a which may be one of:
- @b wxIMAGE_LIST_NORMAL
-
- The normal (large icon) image list.
-
- @b wxIMAGE_LIST_SMALL
-
- The small icon image list.
-
- @b wxIMAGE_LIST_STATE
-
- The user-defined state image list (unimplemented).
+ - 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).
*/
wxImageList* GetImageList(int which) const;
long HitTest(const wxPoint& point, int& flags,
long* ptrSubItem) const;
- //@{
/**
For report view mode (only), inserts a column. For more details, see SetItem().
*/
long InsertColumn(long col, wxListItem& info);
+ /**
+ For report view mode (only), inserts a column. For more details, see SetItem().
+ */
long InsertColumn(long col, const wxString& heading,
int format = wxLIST_FORMAT_LEFT,
int width = -1);
- //@}
- //@{
/**
Insert a wxListItem.
@param info
*/
long InsertItem(long index, const wxString& label,
int imageIndex);
- //@}
/**
This function may be overloaded in the derived class for a control with
*/
void SetImageList(wxImageList* imageList, int which);
- //@{
/**
- Sets a string field at a particular column.
+ 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 @b 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 @b m_stateMask and @b 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.
*/
bool SetItem(wxListItem& info);
+
+ /**
+ Sets a string field at a particular column.
+ */
long SetItem(long index, int col, const wxString& label,
int imageId = -1);
- m_mask 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 SetItem(long index, int col, const wxString& label,
- int imageId = -1);
- //@}
/**
- Sets the background colour for this item. This function only works in report
- view.
- The colour can be retrieved using
- GetItemBackgroundColour().
+ Sets the background colour for this item. This function only works
+ in report view. The colour can be retrieved using GetItemBackgroundColour().
*/
void SetItemBackgroundColour(long item, const wxColour& col);
/**
- 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.
+ 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.
*/
bool SetItemColumnImage(long item, long column, int image);
bool SetItemData(long item, long data);
/**
- Sets the item's font.
+ Sets the item's font.
*/
void SetItemFont(long item, const wxFont& font);
- //@{
/**
- 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: @a
- selImage is not
- used.
+ Sets the unselected and selected images associated with the item. The
+ images are indices into the image list associated with the list control.
*/
bool 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.
+ This form is deprecated: @a selImage is not used.
+ */
bool SetItemImage(long item, int image, int selImage);
- //@}
/**
Sets the position of the item, in icon or small icon view. Windows only.
class wxListItemAttr
{
public:
- //@{
+ /**
+ Default Constructor.
+ */
+ wxListItemAttr();
/**
Construct a wxListItemAttr with the specified foreground and
background colors and font.
*/
- wxListItemAttr();
wxListItemAttr(const wxColour colText,
const wxColour colBack,
const wxFont font);
- //@}
/**
Returns the currently set background color.
@see wxListCtrl::SetItemState
*/
- void Select(bool on = true);
+ void Select(long n, bool on = true);
/**
Sets the column image for the specified column. To use the column images, the
projects / wxWidgets.git / blobdiff