Source cleaning: whitespaces, tabs, TRUE/true, FALSE/false, -1/wxID_ANY/wxDefaultCoor...

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

diff --git a/include/wx/msw/listctrl.h b/include/wx/msw/listctrl.h
index 3e780f13f25eedb977f199dcd12c605373bc1c85..6ba1bea220241daebfdbc5ce141bc80fdf1df3b1 100644 (file)
--- a/include/wx/msw/listctrl.h
+++ b/include/wx/msw/listctrl.h
@@ -63,8 +63,8 @@ class WXDLLEXPORT wxImageList;
     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.
 
@@ -90,7 +90,7 @@ public:
     wxListCtrl() { Init(); }
 
     wxListCtrl(wxWindow *parent,
-               wxWindowID id = -1,
+               wxWindowID id = wxID_ANY,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_ICON,
@@ -105,7 +105,7 @@ public:
     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,
@@ -189,10 +189,8 @@ public:
     // 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);
@@ -216,7 +214,7 @@ public:
     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) ;
@@ -240,8 +238,11 @@ public:
     void SetImageList(wxImageList *imageList, int which) ;
     void AssignImageList(wxImageList *imageList, int which) ;
 
-    // returns true if it is a virtual list control
-    bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; }
+    // 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);
@@ -279,7 +280,7 @@ public:
 
     // 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.
@@ -344,17 +345,26 @@ public:
     // bring the control in sync with current m_windowStyle value
     void UpdateStyle();
 
-    // 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;
-
     // 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();
@@ -362,6 +372,10 @@ protected:
     // 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
@@ -370,17 +384,16 @@ protected:
                       m_ownsImageListSmall,
                       m_ownsImageListState;
 
-    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
     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)
+    // true if we have any internal data (user data & attributes)
     bool m_AnyInternalData;
 
-    // TRUE if we have any items with custom attributes
+    // true if we have any items with custom attributes
     bool m_hasAnyAttr;
 
     // these functions are only used for virtual list view controls, i.e. the
@@ -396,8 +409,6 @@ protected:
     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 
 private:
-    bool DoCreateControl(int x, int y, int w, int h);
-
     // process NM_CUSTOMDRAW notification message
     WXLPARAM OnCustomDraw(WXLPARAM lParam);