On screens with restricted space, it's useful to be able to add controls

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

diff --git a/include/wx/msw/listctrl.h b/include/wx/msw/listctrl.h
index 35dcf0bec4adf1e31f7d9f13a724d8ce458dd1f6..895adaea48ed8ff2ec661e49c0f97993469e81ad 100644 (file)
--- a/include/wx/msw/listctrl.h
+++ b/include/wx/msw/listctrl.h
@@ -12,10 +12,6 @@
 #ifndef _WX_LISTCTRL_H_
 #define _WX_LISTCTRL_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "listctrl.h"
-#endif
-
 #if wxUSE_LISTCTRL
 
 #include "wx/control.h"
@@ -63,8 +59,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,12 +86,12 @@ 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,
                const wxValidator& validator = wxDefaultValidator,
-               const wxString& name = _T("wxListCtrl"))
+               const wxString& name = wxListCtrlNameStr)
     {
         Init();
 
@@ -105,12 +101,12 @@ 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,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = _T("wxListCtrl"));
+                const wxString& name = wxListCtrlNameStr);
 
 
     // Attributes
@@ -124,7 +120,7 @@ public:
     bool GetColumn(int col, wxListItem& item) const;
 
     // Sets information about this column
-    bool SetColumn(int col, wxListItem& item) ;
+    bool SetColumn(int col, const wxListItem& item) ;
 
     // Gets the column width
     int GetColumnWidth(int col) const;
@@ -160,7 +156,8 @@ public:
     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) ;
+    bool SetItemColumnImage(long item, long column, int image);
 
     // Gets the item text
     wxString GetItemText(long item) const ;
@@ -169,7 +166,7 @@ public:
     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) ;
@@ -200,6 +197,10 @@ public:
     void SetItemBackgroundColour( long item, const wxColour &col);
     wxColour GetItemBackgroundColour( long item ) const;
 
+    // Font of an item.
+    void SetItemFont( long item, const wxFont &f);
+    wxFont GetItemFont( long item ) const;
+
     // Gets the number of selected items in the list control
     int GetSelectedItemCount() const;
 
@@ -214,7 +215,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) ;
@@ -280,11 +281,11 @@ 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.
-    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.
@@ -296,7 +297,7 @@ public:
 
     // Inserts an item, returning the index of the new item if successful,
     // -1 otherwise.
-    long InsertItem(wxListItem& info);
+    long InsertItem(const wxListItem& info);
 
     // Insert a string item
     long InsertItem(long index, const wxString& label);
@@ -308,7 +309,7 @@ public:
     long InsertItem(long index, const wxString& label, int imageIndex);
 
     // For list view mode (only), inserts a column.
-    long InsertColumn(long col, wxListItem& info);
+    long InsertColumn(long col, const wxListItem& info);
 
     long InsertColumn(long col,
                       const wxString& heading,
@@ -350,11 +351,29 @@ public:
     // 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);
 
+    // convert our styles to Windows
+    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
+
+    // special Windows message handling
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg,
+                                    WXWPARAM wParam,
+                                    WXLPARAM lParam);
+
 protected:
     // common part of all ctors
     void Init();
@@ -362,8 +381,9 @@ protected:
     // free memory taken by all internal data
     void FreeAllInternalData();
 
-    // convert our styles to Windows
-    virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) 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
+    wxListItemAttr *DoGetItemAttr(long item) const;
 
 
     wxTextCtrl*       m_textCtrl;        // The control used for editing a label
@@ -380,10 +400,10 @@ protected:
                                     // 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
@@ -392,9 +412,14 @@ protected:
     // 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
+    // return the icon for the given item. In report view, OnGetItemImage will
+    // only be called for the first column. See OnGetItemColumnImage for 
+    // details.
     virtual int OnGetItemImage(long item) const;
 
+    // return the icon for the given item and column.
+    virtual int OnGetItemColumnImage(long item, long column) const;
+
     // return the attribute for the item (may return NULL if none)
     virtual wxListItemAttr *OnGetItemAttr(long item) const;