/////////////////////////////////////////////////////////////////////////////
-// Name: listctrl.h
+// Name: wx/msw/listctrl.h
// Purpose: wxListCtrl class
// Author: Julian Smart
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_LISTCTRL_H_
#define _WX_LISTCTRL_H_
#ifdef __GNUG__
-#pragma interface "listctrl.h"
+ #pragma interface "listctrl.h"
#endif
+#if wxUSE_LISTCTRL
+
#include "wx/control.h"
#include "wx/event.h"
-#include "wx/imaglist.h"
+#include "wx/hash.h"
+
+class WXDLLEXPORT wxTextCtrl;
+class WXDLLEXPORT wxImageList;
/*
The wxListCtrl can show lists of items in four different modes:
*/
-// Mask flags to tell app/GUI what fields of wxListItem are valid
-#define wxLIST_MASK_STATE 0x0001
-#define wxLIST_MASK_TEXT 0x0002
-#define wxLIST_MASK_IMAGE 0x0004
-#define wxLIST_MASK_DATA 0x0008
-#define wxLIST_SET_ITEM 0x0010
-#define wxLIST_MASK_WIDTH 0x0020
-#define wxLIST_MASK_FORMAT 0x0040
-
-// State flags for indicating the state of an item
-#define wxLIST_STATE_DONTCARE 0x0000
-#define wxLIST_STATE_DROPHILITED 0x0001
-#define wxLIST_STATE_FOCUSED 0x0002
-#define wxLIST_STATE_SELECTED 0x0004
-#define wxLIST_STATE_CUT 0x0008
-
-// Hit test flags, used in HitTest
-#define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area.
-#define wxLIST_HITTEST_BELOW 0x0002 // Below the client area.
-#define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
-#define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
-#define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
-#define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
-#define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
-#define wxLIST_HITTEST_TOLEFT 0x0400 // To the left of the client area.
-#define wxLIST_HITTEST_TORIGHT 0x0800 // To the right of the client area.
-
-#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
-
-// Flags for GetNextItem
-enum {
- 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
-};
+class WXDLLEXPORT wxListCtrl: public wxControl
+{
+public:
+ /*
+ * Public interface
+ */
-// Alignment flags for Arrange
-enum {
- wxLIST_ALIGN_DEFAULT,
- wxLIST_ALIGN_LEFT,
- wxLIST_ALIGN_TOP,
- wxLIST_ALIGN_SNAP_TO_GRID
-};
+ wxListCtrl() { Init(); }
-// Column format
-enum {
- wxLIST_FORMAT_LEFT,
- wxLIST_FORMAT_RIGHT,
- wxLIST_FORMAT_CENTRE,
- wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
-};
+ wxListCtrl(wxWindow *parent,
+ wxWindowID id = -1,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxLC_ICON,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = _T("wxListCtrl"))
+ {
+ Init();
-// Autosize values for SetColumnWidth
-enum {
- wxLIST_AUTOSIZE = -1,
- wxLIST_AUTOSIZE_USEHEADER = -2
-};
+ Create(parent, id, pos, size, style, validator, name);
+ }
-// Flag values for GetItemRect
-enum {
- wxLIST_RECT_BOUNDS,
- wxLIST_RECT_ICON,
- wxLIST_RECT_LABEL
-};
+ virtual ~wxListCtrl();
-// Flag values for FindItem
-enum {
- wxLIST_FIND_UP,
- wxLIST_FIND_DOWN,
- wxLIST_FIND_LEFT,
- wxLIST_FIND_RIGHT
-};
+ bool Create(wxWindow *parent,
+ wxWindowID id = -1,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxLC_ICON,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = _T("wxListCtrl"));
-// wxListItem: data representing an item, or report field.
-// It also doubles up to represent entire column information
-// when inserting or setting a column.
-class WXDLLEXPORT wxListItem: public wxObject
-{
- DECLARE_DYNAMIC_CLASS(wxListItem)
-public:
- long m_mask; // Indicates what fields are valid
- long m_itemId; // The zero-based item position
- int m_col; // Zero-based column, if in report mode
- long m_state; // The state of the item
- long m_stateMask; // Which flags of m_state are valid (uses same flags)
- wxString m_text; // The label/header text
- int m_image; // The zero-based index into an image list
- long m_data; // App-defined data
-
- // For columns only
- int m_format; // left, right, centre
- int m_width; // width of column
-
- wxListItem();
-};
-// type of compare function for wxListCtrl sort operation
-typedef int (CALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);
+ // Attributes
+ ////////////////////////////////////////////////////////////////////////////
-class WXDLLEXPORT wxListCtrl: public wxControl
-{
- DECLARE_DYNAMIC_CLASS(wxListCtrl)
- public:
- /*
- * Public interface
- */
+ // Set the control colours
+ bool SetForegroundColour(const wxColour& col);
+ bool SetBackgroundColour(const wxColour& col);
- wxListCtrl();
+ // Gets information about this column
+ bool GetColumn(int col, wxListItem& item) const;
- inline wxListCtrl(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "listCtrl")
- {
- Create(parent, id, pos, size, style, validator, name);
- }
- ~wxListCtrl();
+ // Sets information about this column
+ bool SetColumn(int col, wxListItem& item) ;
- bool Create(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString& name = "wxListCtrl");
+ // Gets the column width
+ int GetColumnWidth(int col) const;
+ // Sets the column width
+ bool SetColumnWidth(int col, int width) ;
- // Attributes
- ////////////////////////////////////////////////////////////////////////////
+ // 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)
+ int GetCountPerPage() const;
- // Sets the background colour (GetBackgroundColour already implicit in
- // wxWindow class)
- bool SetBackgroundColour(const wxColour& col);
+ // Gets the edit control for editing labels.
+ wxTextCtrl* GetEditControl() const;
- // Gets information about this column
- bool GetColumn(int col, wxListItem& item) const;
+ // Gets information about the item
+ bool GetItem(wxListItem& info) const ;
- // Sets information about this column
- bool SetColumn(int col, wxListItem& item) ;
+ // Sets information about the item
+ bool SetItem(wxListItem& info) ;
- // Gets the column width
- int GetColumnWidth(int col) const;
+ // Sets a string field at a particular column
+ long SetItem(long index, int col, const wxString& label, int imageId = -1);
- // Sets the column width
- bool SetColumnWidth(int col, int width) ;
+ // Gets the item state
+ int GetItemState(long item, long stateMask) 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)
- int GetCountPerPage() const;
+ // Sets the item state
+ bool SetItemState(long item, long state, long stateMask) ;
- // Gets the edit control for editing labels.
- wxTextCtrl* GetEditControl() const;
+ // Sets the item image
+ bool SetItemImage(long item, int image, int selImage) ;
- // Gets information about the item
- bool GetItem(wxListItem& info) const ;
+ // Gets the item text
+ wxString GetItemText(long item) const ;
- // Sets information about the item
- bool SetItem(wxListItem& info) ;
+ // Sets the item text
+ void SetItemText(long item, const wxString& str) ;
- // Sets a string field at a particular column
- long SetItem(long index, int col, const wxString& label, int imageId = -1);
+ // Gets the item data
+ long GetItemData(long item) const ;
- // Gets the item state
- int GetItemState(long item, long stateMask) const ;
+ // Sets the item data
+ bool SetItemData(long item, long data) ;
- // Sets the item state
- bool SetItemState(long item, long state, long stateMask) ;
+ // Gets the item rectangle
+ bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
- // Sets the item image
- bool SetItemImage(long item, int image, int selImage) ;
+ // Gets the item position
+ bool GetItemPosition(long item, wxPoint& pos) const ;
- // Gets the item text
- wxString GetItemText(long item) const ;
+ // Sets the item position
+ bool SetItemPosition(long item, const wxPoint& pos) ;
- // Sets the item text
- void SetItemText(long item, const wxString& str) ;
+ // Gets the number of items in the list control
+ int GetItemCount() const;
- // Gets the item data
- long GetItemData(long item) const ;
+ // Gets the number of columns in the list control
+ int GetColumnCount() const { return m_colCount; }
- // Sets the item data
- bool SetItemData(long item, long data) ;
+ // Retrieves the spacing between icons in pixels.
+ // If small is TRUE, gets the spacing for the small icon
+ // view, otherwise the large icon view.
+ int GetItemSpacing(bool isSmall) const;
- // Gets the item rectangle
- bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
+ // Gets the number of selected items in the list control
+ int GetSelectedItemCount() const;
- // Gets the item position
- bool GetItemPosition(long item, wxPoint& pos) const ;
+ // Gets the text colour of the listview
+ wxColour GetTextColour() const;
- // Sets the item position
- bool SetItemPosition(long item, const wxPoint& pos) ;
+ // Sets the text colour of the listview
+ void SetTextColour(const wxColour& col);
- // Gets the number of items in the list control
- int GetItemCount() const;
+ // Gets the index of the topmost visible item when in
+ // list or report view
+ long GetTopItem() const ;
- // Gets the number of columns in the list control
- int GetColumnCount() const { return m_colCount; }
+ // Add or remove a single window style
+ void SetSingleStyle(long style, bool add = TRUE) ;
- // Retrieves the spacing between icons in pixels.
- // If small is TRUE, gets the spacing for the small icon
- // view, otherwise the large icon view.
- int GetItemSpacing(bool isSmall) const;
+ // Set the whole window style
+ void SetWindowStyleFlag(long style) ;
- // Gets the number of selected items in the list control
- int GetSelectedItemCount() const;
+ // Searches for an item, starting from 'item'.
+ // item can be -1 to find the first item that matches the
+ // specified flags.
+ // Returns the item or -1 if unsuccessful.
+ long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
- // Gets the text colour of the listview
- wxColour GetTextColour() const;
+ // Gets one of the three image lists
+ wxImageList *GetImageList(int which) const ;
- // Sets the text colour of the listview
- void SetTextColour(const wxColour& col);
+ // Sets the image list
+ // N.B. There's a quirk in the Win95 list view implementation.
+ // If in wxLC_LIST mode, it'll *still* display images by the labels if
+ // there's a small-icon image list set for the control - even though you
+ // haven't specified wxLIST_MASK_IMAGE when inserting.
+ // So you have to set a NULL small-icon image list to be sure that
+ // the wxLC_LIST mode works without icons. Of course, you may want icons...
+ void SetImageList(wxImageList *imageList, int which) ;
+ void AssignImageList(wxImageList *imageList, int which) ;
- // Gets the index of the topmost visible item when in
- // list or report view
- long GetTopItem() const ;
+ // returns true if it is a virtual list control
+ bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; }
- // Add or remove a single window style
- void SetSingleStyle(long style, bool add = TRUE) ;
+ // refresh items selectively (only useful for virtual list controls)
+ void RefreshItem(long item);
+ void RefreshItems(long itemFrom, long itemTo);
- // Set the whole window style
- void SetWindowStyleFlag(long style) ;
+ // Operations
+ ////////////////////////////////////////////////////////////////////////////
- // Searches for an item, starting from 'item'.
- // item can be -1 to find the first item that matches the
- // specified flags.
- // Returns the item or -1 if unsuccessful.
- long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
+ // Arranges the items
+ bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
- // Implementation: converts wxWindows style to MSW style.
- // Can be a single style flag or a bit list.
- // oldStyle is 'normalised' so that it doesn't contain
- // conflicting styles.
- long ConvertToMSWStyle(long& oldStyle, long style) const;
+ // Deletes an item
+ bool DeleteItem(long item);
- // Gets one of the three image lists
- wxImageList *GetImageList(int which) const ;
+ // Deletes all items
+ bool DeleteAllItems() ;
- // Sets the image list
- // N.B. There's a quirk in the Win95 list view implementation.
- // If in wxLC_LIST mode, it'll *still* display images by the labels if
- // there's a small-icon image list set for the control - even though you
- // haven't specified wxLIST_MASK_IMAGE when inserting.
- // So you have to set a NULL small-icon image list to be sure that
- // the wxLC_LIST mode works without icons. Of course, you may want icons...
- void SetImageList(wxImageList *imageList, int which) ;
+ // Deletes a column
+ bool DeleteColumn(int col);
- // Operations
- ////////////////////////////////////////////////////////////////////////////
+ // Deletes all columns
+ bool DeleteAllColumns();
- // Arranges the items
- bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
+ // Clears items, and columns if there are any.
+ void ClearAll();
- // Deletes an item
- bool DeleteItem(long item);
+ // Edit the label
+ wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
- // Deletes all items
- bool DeleteAllItems() ;
+ // End label editing, optionally cancelling the edit
+ bool EndEditLabel(bool cancel);
- // Deletes a column
- bool DeleteColumn(int col);
+ // Ensures this item is visible
+ bool EnsureVisible(long item) ;
- // Deletes all columns
- bool DeleteAllColumns();
+ // Find an item whose label matches this string, starting from the item after 'start'
+ // or the beginning if 'start' is -1.
+ long FindItem(long start, const wxString& str, bool partial = FALSE);
- // Clears items, and columns if there are any.
- void ClearAll();
+ // Find an item whose data matches this data, starting from the item after 'start'
+ // or the beginning if 'start' is -1.
+ long FindItem(long start, long data);
- // Edit the label
- wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
+ // Find an item nearest this position in the specified direction, starting from
+ // the item after 'start' or the beginning if 'start' is -1.
+ long FindItem(long start, const wxPoint& pt, int direction);
- // End label editing, optionally cancelling the edit
- bool EndEditLabel(bool cancel);
+ // Determines which item (if any) is at the specified point,
+ // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
+ long HitTest(const wxPoint& point, int& flags);
- // Ensures this item is visible
- bool EnsureVisible(long item) ;
+ // Inserts an item, returning the index of the new item if successful,
+ // -1 otherwise.
+ long InsertItem(wxListItem& info);
- // Find an item whose label matches this string, starting from the item after 'start'
- // or the beginning if 'start' is -1.
- long FindItem(long start, const wxString& str, bool partial = FALSE);
+ // Insert a string item
+ long InsertItem(long index, const wxString& label);
- // Find an item whose data matches this data, starting from the item after 'start'
- // or the beginning if 'start' is -1.
- long FindItem(long start, long data);
+ // Insert an image item
+ long InsertItem(long index, int imageIndex);
- // Find an item nearest this position in the specified direction, starting from
- // the item after 'start' or the beginning if 'start' is -1.
- long FindItem(long start, const wxPoint& pt, int direction);
+ // Insert an image/string item
+ long InsertItem(long index, const wxString& label, int imageIndex);
- // Determines which item (if any) is at the specified point,
- // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
- long HitTest(const wxPoint& point, int& flags);
+ // For list view mode (only), inserts a column.
+ long InsertColumn(long col, wxListItem& info);
- // Inserts an item, returning the index of the new item if successful,
- // -1 otherwise.
- // TOD: Should also have some further convenience functions
- // which don't require setting a wxListItem object
- long InsertItem(wxListItem& info);
+ long InsertColumn(long col,
+ const wxString& heading,
+ int format = wxLIST_FORMAT_LEFT,
+ int width = -1);
- // Insert a string item
- long InsertItem(long index, const wxString& label);
+ // set the number of items in a virtual list control
+ void SetItemCount(long count);
- // Insert an image item
- long InsertItem(long index, int imageIndex);
+ // Scrolls the list control. If in icon, small icon or report view mode,
+ // x specifies the number of pixels to scroll. If in list view mode, x
+ // specifies the number of columns to scroll.
+ // If in icon, small icon or list view mode, y specifies the number of pixels
+ // to scroll. If in report view mode, y specifies the number of lines to scroll.
+ bool ScrollList(int dx, int dy);
- // Insert an image/string item
- long InsertItem(long index, const wxString& label, int imageIndex);
+ // Sort items.
- // For list view mode (only), inserts a column.
- long InsertColumn(long col, wxListItem& info);
+ // fn is a function which takes 3 long arguments: item1, item2, data.
+ // item1 is the long data associated with a first item (NOT the index).
+ // item2 is the long data associated with a second item (NOT the index).
+ // data is the same value as passed to SortItems.
+ // The return value is a negative number if the first item should precede the second
+ // item, a positive number of the second item should precede the first,
+ // or zero if the two items are equivalent.
- long InsertColumn(long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
- int width = -1);
+ // data is arbitrary data to be passed to the sort function.
+ bool SortItems(wxListCtrlCompare fn, long data);
- // Scrolls the list control. If in icon, small icon or report view mode,
- // x specifies the number of pixels to scroll. If in list view mode, x
- // specifies the number of columns to scroll.
- // If in icon, small icon or list view mode, y specifies the number of pixels
- // to scroll. If in report view mode, y specifies the number of lines to scroll.
- bool ScrollList(int dx, int dy);
+ // IMPLEMENTATION
+ virtual bool MSWCommand(WXUINT param, WXWORD id);
+ virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
- // Sort items.
+ // bring the control in sync with current m_windowStyle value
+ void UpdateStyle();
- // fn is a function which takes 3 long arguments: item1, item2, data.
- // item1 is the long data associated with a first item (NOT the index).
- // item2 is the long data associated with a second item (NOT the index).
- // data is the same value as passed to SortItems.
- // The return value is a negative number if the first item should precede the second
- // item, a positive number of the second item should precede the first,
- // or zero if the two items are equivalent.
+ // Implementation: converts wxWindows style to MSW style.
+ // Can be a single style flag or a bit list.
+ // oldStyle is 'normalised' so that it doesn't contain
+ // conflicting styles.
+ long ConvertToMSWStyle(long& oldStyle, long style) const;
- // data is arbitrary data to be passed to the sort function.
- bool SortItems(wxListCtrlCompare fn, long data);
+ // Event handlers
+ ////////////////////////////////////////////////////////////////////////////
+ // Necessary for drawing hrules and vrules, if specified
+ void OnPaint(wxPaintEvent& event);
- // IMPLEMENTATION
- virtual bool MSWCommand(WXUINT param, WXWORD id);
- virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+protected:
+ // common part of all ctors
+ void Init();
- // bring the control in sync with current m_windowStyle value
- void UpdateStyle();
+ // free memory taken by all attributes and recreate the hash table
+ void FreeAllAttrs(bool dontRecreate = FALSE);
- // Add to pool: necessary because Windows needs to have a string
- // still exist across 3 callbacks.
- wxChar *AddPool(const wxString& str);
+ wxTextCtrl* m_textCtrl; // The control used for editing a label
+ wxImageList * m_imageListNormal; // The image list for normal icons
+ wxImageList * m_imageListSmall; // The image list for small icons
+ wxImageList * m_imageListState; // The image list state icons (not implemented yet)
+ bool m_ownsImageListNormal,
+ m_ownsImageListSmall,
+ m_ownsImageListState;
-protected:
- wxTextCtrl* m_textCtrl; // The control used for editing a label
- wxImageList * m_imageListNormal; // The image list for normal icons
- wxImageList * m_imageListSmall; // The image list for small icons
- wxImageList * m_imageListState; // The image list state icons (not implemented yet)
+ long m_baseStyle; // Basic Windows style flags, for recreation purposes
+ int m_colCount; // Windows doesn't have GetColumnCount so must
+ // keep track of inserted/deleted columns
+
+ // the hash table we use for storing pointers to the items attributes
+ wxHashTable m_attrs;
+
+ // TRUE if we have any items with custom attributes
+ bool m_hasAnyAttr;
- long m_baseStyle; // Basic Windows style flags, for recreation purposes
- wxStringList m_stringPool; // Pool of 3 strings to satisfy Windows callback
- // requirements
- int m_colCount; // Windows doesn't have GetColumnCount so must
- // keep track of inserted/deleted columns
+ // these functions are only used for virtual list view controls, i.e. the
+ // ones with wxLC_VIRTUAL style
+
+ // return the text for the given column of the given item
+ virtual wxString OnGetItemText(long item, long column) const;
+
+ // return the icon for the given item
+ virtual int OnGetItemImage(long item) const;
+
+ // return the attribute for the item (may return NULL if none)
+ virtual wxListItemAttr *OnGetItemAttr(long item) const;
private:
- bool DoCreateControl(int x, int y, int w, int h);
+ bool DoCreateControl(int x, int y, int w, int h);
+
+ // process NM_CUSTOMDRAW notification message
+ WXLPARAM OnCustomDraw(WXLPARAM lParam);
+
+ DECLARE_DYNAMIC_CLASS(wxListCtrl)
+ DECLARE_EVENT_TABLE()
};
+#endif // wxUSE_LISTCTRL
+
#endif
// _WX_LISTCTRL_H_
projects / wxWidgets.git / blobdiff