Use enum for wxMouseEvent::m_wheelAxis instead of int.

[wxWidgets.git] / include / wx / msw / listctrl.h

diff --git a/include/wx/msw/listctrl.h b/include/wx/msw/listctrl.h
index cf4bfdd64e2c454c2aea89d632c82a80ada45f37..75c30270be549118c96cbe55c34e7c3d56d5526a 100644 (file)
--- a/include/wx/msw/listctrl.h
+++ b/include/wx/msw/listctrl.h
@@ -13,8 +13,14 @@
 #define _WX_LISTCTRL_H_
 
 #include "wx/textctrl.h"
 #define _WX_LISTCTRL_H_
 
 #include "wx/textctrl.h"

+#include "wx/dynarray.h"
+#include "wx/vector.h"

 
 

-class WXDLLEXPORT wxImageList;
+class wxMSWListItemData;
+
+// define this symbol to indicate the availability of SetColumnsOrder() and
+// related functions
+#define wxHAS_LISTCTRL_COLUMN_ORDER

 
 /*
     The wxListCtrl can show lists of items in four different modes:
 
 /*
     The wxListCtrl can show lists of items in four different modes:


@@ -70,7 +76,7 @@ class WXDLLEXPORT wxImageList;
 
  */
 
 
  */
 

-class WXDLLEXPORT wxListCtrl: public wxControl
+class WXDLLIMPEXP_CORE wxListCtrl: public wxListCtrlBase

 {
 public:
     /*
 {
 public:
     /*


@@ -114,13 +120,25 @@ public:
     bool GetColumn(int col, wxListItem& item) const;
 
     // Sets information about this column
     bool GetColumn(int col, wxListItem& item) const;
 
     // Sets information about this column

-    bool SetColumn(int col, const wxListItem& item) ;
+    bool SetColumn(int col, const wxListItem& item);

 
     // Gets the column width
     int GetColumnWidth(int col) const;
 
     // Sets the column width
 
     // Gets the column width
     int GetColumnWidth(int col) const;
 
     // Sets the column width

-    bool SetColumnWidth(int col, int width) ;
+    bool SetColumnWidth(int col, int width);
+
+
+    // Gets the column order from its index or index from its order
+    int GetColumnOrder(int col) const;
+    int GetColumnIndexFromOrder(int order) const;
+
+    // Gets the column order for all columns
+    wxArrayInt GetColumnsOrder() const;
+
+    // Sets the column order for all columns
+    bool SetColumnsOrder(const wxArrayInt& orders);
+

 
     // Gets the number of items that can fit vertically in the
     // visible area of the list control (list or report view)
 
     // Gets the number of items that can fit vertically in the
     // visible area of the list control (list or report view)


@@ -135,48 +153,48 @@ public:
     wxTextCtrl* GetEditControl() const;
 
     // Gets information about the item
     wxTextCtrl* GetEditControl() const;
 
     // Gets information about the item

-    bool GetItem(wxListItem& info) const ;
+    bool GetItem(wxListItem& info) const;

 
     // Sets information about the item
 
     // Sets information about the item

-    bool SetItem(wxListItem& info) ;
+    bool SetItem(wxListItem& info);

 
     // Sets a string field at a particular column
     long SetItem(long index, int col, const wxString& label, int imageId = -1);
 
     // Gets the item state
 
     // Sets a string field at a particular column
     long SetItem(long index, int col, const wxString& label, int imageId = -1);
 
     // Gets the item state

-    int  GetItemState(long item, long stateMask) const ;
+    int  GetItemState(long item, long stateMask) const;

 
     // Sets the item state
 
     // Sets the item state

-    bool SetItemState(long item, long state, long stateMask) ;
+    bool SetItemState(long item, long state, long stateMask);

 
     // Sets the item image
 
     // Sets the item image

-    bool SetItemImage(long item, int image, int selImage = -1) ;
+    bool SetItemImage(long item, int image, int selImage = -1);

     bool SetItemColumnImage(long item, long column, int image);
 
     // Gets the item text
     bool SetItemColumnImage(long item, long column, int image);
 
     // Gets the item text

-    wxString GetItemText(long item) const ;
+    wxString GetItemText(long item, int col = 0) const;

 
     // Sets the item text
 
     // Sets the item text

-    void SetItemText(long item, const wxString& str) ;
+    void SetItemText(long item, const wxString& str);

 
     // Gets the item data
 
     // Gets the item data

-    wxUIntPtr GetItemData(long item) const ;
+    wxUIntPtr GetItemData(long item) const;

 
     // Sets the item data
     bool SetItemPtrData(long item, wxUIntPtr data);
     bool SetItemData(long item, long data) { return SetItemPtrData(item, data); }
 
     // Gets the item rectangle
 
     // Sets the item data
     bool SetItemPtrData(long item, wxUIntPtr data);
     bool SetItemData(long item, long data) { return SetItemPtrData(item, data); }
 
     // Gets the item rectangle

-    bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
+    bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const;

 
     // Gets the subitem rectangle in report mode
 
     // Gets the subitem rectangle in report mode

-    bool GetSubItemRect(long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
+    bool GetSubItemRect(long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const;

 
     // Gets the item position
 
     // Gets the item position

-    bool GetItemPosition(long item, wxPoint& pos) const ;
+    bool GetItemPosition(long item, wxPoint& pos) const;

 
     // Sets the item position
 
     // Sets the item position

-    bool SetItemPosition(long item, const wxPoint& pos) ;
+    bool SetItemPosition(long item, const wxPoint& pos);

 
     // Gets the number of items in the list control
     int GetItemCount() const;
 
     // Gets the number of items in the list control
     int GetItemCount() const;


@@ -210,22 +228,22 @@ public:
 
     // Gets the index of the topmost visible item when in
     // list or report view
 
     // Gets the index of the topmost visible item when in
     // list or report view

-    long GetTopItem() const ;
+    long GetTopItem() const;

 
     // Add or remove a single window style
 
     // Add or remove a single window style

-    void SetSingleStyle(long style, bool add = true) ;
+    void SetSingleStyle(long style, bool add = true);

 
     // Set the whole window style
 
     // Set the whole window style

-    void SetWindowStyleFlag(long style) ;
+    void SetWindowStyleFlag(long style);

 
     // 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.
 
     // 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 ;
+    long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const;

 
     // Gets one of the three image lists
 
     // Gets one of the three image lists

-    wxImageList *GetImageList(int which) const ;
+    wxImageList *GetImageList(int which) const;

 
     // Sets the image list
     // N.B. There's a quirk in the Win95 list view implementation.
 
     // Sets the image list
     // N.B. There's a quirk in the Win95 list view implementation.


@@ -234,14 +252,8 @@ public:
     // 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...
     // 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) ;
-
-    // are we in report mode?
-    bool InReportView() const { return HasFlag(wxLC_REPORT); }
-
-    // are we in virtual report mode?
-    bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
+    void SetImageList(wxImageList *imageList, int which);
+    void AssignImageList(wxImageList *imageList, int which);

 
     // refresh items selectively (only useful for virtual list controls)
     void RefreshItem(long item);
 
     // refresh items selectively (only useful for virtual list controls)
     void RefreshItem(long item);


@@ -257,7 +269,7 @@ public:
     bool DeleteItem(long item);
 
     // Deletes all items
     bool DeleteItem(long item);
 
     // Deletes all items

-    bool DeleteAllItems() ;
+    bool DeleteAllItems();

 
     // Deletes a column
     bool DeleteColumn(int col);
 
     // Deletes a column
     bool DeleteColumn(int col);


@@ -269,13 +281,13 @@ public:
     void ClearAll();
 
     // Edit the label
     void ClearAll();
 
     // Edit the label

-    wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
+    wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = wxCLASSINFO(wxTextCtrl));

 
     // End label editing, optionally cancelling the edit
     bool EndEditLabel(bool cancel);
 
     // Ensures this item is visible
 
     // End label editing, optionally cancelling the edit
     bool EndEditLabel(bool cancel);
 
     // Ensures this item is visible

-    bool EnsureVisible(long item) ;
+    bool EnsureVisible(long item);

 
     // Find an item whose label matches this string, starting from the item after 'start'
     // or the beginning if 'start' is -1.
 
     // Find an item whose label matches this string, starting from the item after 'start'
     // or the beginning if 'start' is -1.


@@ -307,14 +319,6 @@ public:
     // Insert an image/string item
     long InsertItem(long index, const wxString& label, int imageIndex);
 
     // Insert an image/string item
     long InsertItem(long index, const wxString& label, int imageIndex);
 

-    // For list view mode (only), inserts a column.
-    long InsertColumn(long col, const wxListItem& info);
-
-    long InsertColumn(long col,
-                      const wxString& heading,
-                      int format = wxLIST_FORMAT_LEFT,
-                      int width = -1);
-

     // set the number of items in a virtual list control
     void SetItemCount(long count);
 
     // set the number of items in a virtual list control
     void SetItemCount(long count);
 


@@ -336,7 +340,7 @@ public:
     // or zero if the two items are equivalent.
 
     // data is arbitrary data to be passed to the sort function.
     // or zero if the two items are equivalent.
 
     // data is arbitrary data to be passed to the sort function.

-    bool SortItems(wxListCtrlCompare fn, long data);
+    bool SortItems(wxListCtrlCompare fn, wxIntPtr data);

 
     // IMPLEMENTATION
     virtual bool MSWCommand(WXUINT param, WXWORD id);
 
     // IMPLEMENTATION
     virtual bool MSWCommand(WXUINT param, WXWORD id);


@@ -380,12 +384,18 @@ protected:
     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();
 

+    // Implement base class pure virtual methods.
+    long DoInsertColumn(long col, const wxListItem& info);
+

     // free memory taken by all internal data
     void FreeAllInternalData();
 
     // free memory taken by all internal data
     void FreeAllInternalData();
 

+    // get the internal data object for this item (may return NULL)
+    wxMSWListItemData *MSWGetItemData(long item) const;
+

     // get the item attribute, either by quering it for virtual control, or by
     // returning the one previously set using setter methods for a normal one
     // get the item attribute, either by quering it for virtual control, or by
     // returning the one previously set using setter methods for a normal one

-    wxListItemAttr *DoGetItemAttr(long item) const;
+    wxListItemAttr *DoGetItemColumnAttr(long item, long column) const;

 
 
     wxTextCtrl*       m_textCtrl;        // The control used for editing a label
 
 
     wxTextCtrl*       m_textCtrl;        // The control used for editing a label


@@ -400,10 +410,9 @@ protected:
                                     // keep track of inserted/deleted columns
     long              m_count;      // Keep track of item count to save calls to
                                     // ListView_GetItemCount
                                     // keep track of inserted/deleted columns
     long              m_count;      // Keep track of item count to save calls to
                                     // ListView_GetItemCount

-    bool              m_ignoreChangeMessages;

 
 

-    // true if we have any internal data (user data & attributes)
-    bool m_AnyInternalData;
+    // all wxMSWListItemData objects we use
+    wxVector<wxMSWListItemData *> m_internalData;

 
     // true if we have any items with custom attributes
     bool m_hasAnyAttr;
 
     // true if we have any items with custom attributes
     bool m_hasAnyAttr;


@@ -425,13 +434,34 @@ protected:
     // return the attribute for the item (may return NULL if none)
     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 
     // return the attribute for the item (may return NULL if none)
     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 

+    // return the attribute for the given item and column (may return NULL if none)
+    virtual wxListItemAttr *OnGetItemColumnAttr(long item, long WXUNUSED(column)) const
+    {
+        return OnGetItemAttr(item);
+    }
+

 private:
     // process NM_CUSTOMDRAW notification message
     WXLPARAM OnCustomDraw(WXLPARAM lParam);
 
 private:
     // process NM_CUSTOMDRAW notification message
     WXLPARAM OnCustomDraw(WXLPARAM lParam);
 

+    // set the extended styles for the control (used by Create() and
+    // UpdateStyle()), only should be called if InReportView()
+    void MSWSetExListStyles();
+
+    // initialize the (already created) m_textCtrl with the associated HWND
+    void InitEditControl(WXHWND hWnd);
+
+    // destroy m_textCtrl if it's currently valid and reset it to NULL
+    void DeleteEditControl();
+
+    // Intercept Escape and Enter keys to avoid them being stolen from our
+    // in-place editor control.
+    void OnCharHook(wxKeyEvent& event);
+
+

     DECLARE_DYNAMIC_CLASS(wxListCtrl)
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxListCtrl)
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxListCtrl)
+    wxDECLARE_NO_COPY_CLASS(wxListCtrl);

 };
 
 #endif // _WX_LISTCTRL_H_
 };
 
 #endif // _WX_LISTCTRL_H_