Move unused values into 2.4 compatibility. Source cleaning.

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

diff --git a/include/wx/msw/listctrl.h b/include/wx/msw/listctrl.h
index 3fb236e0c27dc651269f5a3698517fd926e02845..d2cbb4d71be45330f82d3c027339f32f169b86d0 100644 (file)
--- a/include/wx/msw/listctrl.h
+++ b/include/wx/msw/listctrl.h
@@ -12,13 +12,19 @@
 #ifndef _WX_LISTCTRL_H_
 #define _WX_LISTCTRL_H_
 
 #ifndef _WX_LISTCTRL_H_
 #define _WX_LISTCTRL_H_
 

-#ifdef __GNUG__
-#pragma interface "listctrl.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "listctrl.h"

 #endif
 
 #endif
 

+#if wxUSE_LISTCTRL
+

 #include "wx/control.h"
 #include "wx/event.h"
 #include "wx/control.h"
 #include "wx/event.h"

-#include "wx/imaglist.h"
+#include "wx/hash.h"
+#include "wx/textctrl.h"
+
+
+class WXDLLEXPORT wxImageList;

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


@@ -57,8 +63,8 @@
     which item. Each image in an image list can contain a mask, and can be made out
     of either a bitmap, two bitmaps or an icon. See ImagList.h for more details.
 
     which item. Each image in an image list can contain a mask, and can be made out
     of either a bitmap, two bitmaps or an icon. See ImagList.h for more details.
 

-    Notifications are passed via the wxWindows 2.0 event system, or using virtual
-    functions in wxWindows 1.66.
+    Notifications are passed via the wxWidgets 2.0 event system, or using virtual
+    functions in wxWidgets 1.66.

 
     See the sample wxListCtrl app for API usage.
 
 
     See the sample wxListCtrl app for API usage.
 


@@ -84,7 +90,7 @@ public:
     wxListCtrl() { Init(); }
 
     wxListCtrl(wxWindow *parent,
     wxListCtrl() { Init(); }
 
     wxListCtrl(wxWindow *parent,

-               wxWindowID id = -1,
+               wxWindowID id = wxID_ANY,

                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_ICON,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_ICON,


@@ -99,7 +105,7 @@ public:
     virtual ~wxListCtrl();
 
     bool Create(wxWindow *parent,
     virtual ~wxListCtrl();
 
     bool Create(wxWindow *parent,

-                wxWindowID id = -1,
+                wxWindowID id = wxID_ANY,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxLC_ICON,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxLC_ICON,


@@ -110,8 +116,8 @@ public:
     // Attributes
     ////////////////////////////////////////////////////////////////////////////
 
     // Attributes
     ////////////////////////////////////////////////////////////////////////////
 

-    // Sets the background colour (GetBackgroundColour already implicit in
-    // wxWindow class)
+    // Set the control colours
+    bool SetForegroundColour(const wxColour& col);

     bool SetBackgroundColour(const wxColour& col);
 
     // Gets information about this column
     bool SetBackgroundColour(const wxColour& col);
 
     // Gets information about this column


@@ -132,6 +138,9 @@ public:
     // or small icon view)
     int GetCountPerPage() const;
 
     // or small icon view)
     int GetCountPerPage() const;
 

+    // return the total area occupied by all the items (icon/small icon only)
+    wxRect GetViewRect() const;
+

     // Gets the edit control for editing labels.
     wxTextCtrl* GetEditControl() const;
 
     // Gets the edit control for editing labels.
     wxTextCtrl* GetEditControl() const;
 


@@ -151,7 +160,7 @@ public:
     bool SetItemState(long item, long state, long stateMask) ;
 
     // Sets the item image
     bool SetItemState(long item, long state, long stateMask) ;
 
     // Sets the item image

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

 
     // Gets the item text
     wxString GetItemText(long item) const ;
 
     // Gets the item text
     wxString GetItemText(long item) const ;


@@ -160,7 +169,7 @@ public:
     void SetItemText(long item, const wxString& str) ;
 
     // Gets the item data
     void SetItemText(long item, const wxString& str) ;
 
     // Gets the item data

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

 
     // Sets the item data
     bool SetItemData(long item, long data) ;
 
     // Sets the item data
     bool SetItemData(long item, long data) ;


@@ -180,10 +189,16 @@ public:
     // Gets the number of columns in the list control
     int GetColumnCount() const { return m_colCount; }
 
     // Gets the number of columns in the list control
     int GetColumnCount() const { return m_colCount; }
 

-    // 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;
+    // get the horizontal and vertical components of the item spacing
+    wxSize GetItemSpacing() const;
+
+    // Foreground colour of an item.
+    void SetItemTextColour( long item, const wxColour& col);
+    wxColour GetItemTextColour( long item ) const;
+
+    // Background colour of an item.
+    void SetItemBackgroundColour( long item, const wxColour &col);
+    wxColour GetItemBackgroundColour( long item ) const;

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


@@ -199,7 +214,7 @@ public:
     long GetTopItem() const ;
 
     // Add or remove a single window style
     long GetTopItem() const ;
 
     // 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
     void SetWindowStyleFlag(long style) ;
 
     // Set the whole window style
     void SetWindowStyleFlag(long style) ;


@@ -210,12 +225,6 @@ public:
     // Returns the item or -1 if unsuccessful.
     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 
     // Returns the item or -1 if unsuccessful.
     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 

-    // 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;
-

     // Gets one of the three image lists
     wxImageList *GetImageList(int which) const ;
 
     // Gets one of the three image lists
     wxImageList *GetImageList(int which) const ;
 


@@ -227,6 +236,17 @@ public:
     // 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) ;
     // 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); }
+
+    // refresh items selectively (only useful for virtual list controls)
+    void RefreshItem(long item);
+    void RefreshItems(long itemFrom, long itemTo);

 
     // Operations
     ////////////////////////////////////////////////////////////////////////////
 
     // Operations
     ////////////////////////////////////////////////////////////////////////////


@@ -260,11 +280,11 @@ public:
 
     // 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.

-    long FindItem(long start, const wxString& str, bool partial = FALSE);
+    long FindItem(long start, const wxString& str, bool partial = false);

 
     // Find an item whose data matches this data, starting from the item after 'start'
     // or the beginning if 'start' is -1.
 
     // 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);
+    long FindItem(long start, wxUIntPtr data);

 
     // Find an item nearest this position in the specified direction, starting from
     // the item after 'start' or the beginning if 'start' is -1.
 
     // Find an item nearest this position in the specified direction, starting from
     // the item after 'start' or the beginning if 'start' is -1.


@@ -295,6 +315,9 @@ public:
                       int format = wxLIST_FORMAT_LEFT,
                       int width = -1);
 
                       int format = wxLIST_FORMAT_LEFT,
                       int width = -1);
 

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

     // 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.
     // 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.


@@ -322,32 +345,79 @@ public:
     // bring the control in sync with current m_windowStyle value
     void UpdateStyle();
 
     // bring the control in sync with current m_windowStyle value
     void UpdateStyle();
 

-    // Add to pool: necessary because Windows needs to have a string
-    // still exist across 3 callbacks.
-    wxChar *AddPool(const wxString& str);
+    // Event handlers
+    ////////////////////////////////////////////////////////////////////////////
+    // Necessary for drawing hrules and vrules, if specified
+    void OnPaint(wxPaintEvent& event);
+
+
+    virtual bool ShouldInheritColours() const { return false; }
+
+    virtual wxVisualAttributes GetDefaultAttributes() const
+    {
+        return GetClassDefaultAttributes(GetWindowVariant());
+    }
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+
+    // obsolete stuff, for compatibility only -- don't use
+    wxDEPRECATED( int GetItemSpacing(bool isSmall) const);

 
 protected:
     // common part of all ctors
     void Init();
 
 
 protected:
     // common part of all ctors
     void Init();
 

+    // free memory taken by all internal data
+    void FreeAllInternalData();
+
+    // convert our styles to Windows
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+

     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)
     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;

 
 

-    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
     int               m_colCount;   // Windows doesn't have GetColumnCount so must
                                     // 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;

 
 

-    // TRUE fi we have any items with custom attributes
+    // true if we have any items with custom attributes

     bool m_hasAnyAttr;
 
     bool m_hasAnyAttr;
 

+    // 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:
 private:

-    bool DoCreateControl(int x, int y, int w, int h);
+    // process NM_CUSTOMDRAW notification message
+    WXLPARAM OnCustomDraw(WXLPARAM lParam);

 
     DECLARE_DYNAMIC_CLASS(wxListCtrl)
 
     DECLARE_DYNAMIC_CLASS(wxListCtrl)

+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxListCtrl)

 };
 
 };
 

-#endif
-    // _WX_LISTCTRL_H_
+#endif // wxUSE_LISTCTRL
+
+#endif // _WX_LISTCTRL_H_
+