]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/listctrl.h
Always use XPMs in this sample
[wxWidgets.git] / include / wx / generic / listctrl.h
index 74696528735ff2dda5ab08acb5ee5d0e3d49713b..b07e8242779fdb5d4d89ad101a55fa85cdd3a14e 100644 (file)
@@ -4,30 +4,27 @@
 // Author:      Robert Roebling
 // Created:     01/02/97
 // Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Robert Roebling and Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __LISTCTRLH_G__
 #define __LISTCTRLH_G__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "listctrl.h"
 #endif
 
 #include "wx/defs.h"
 #include "wx/object.h"
-#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__)
 #include "wx/generic/imaglist.h"
-#else
-#include "wx/imaglist.h"
-#endif
 
 #include "wx/control.h"
 #include "wx/timer.h"
 #include "wx/dcclient.h"
 #include "wx/scrolwin.h"
 #include "wx/settings.h"
+#include "wx/listbase.h"
 
 #if wxUSE_DRAG_AND_DROP
 class WXDLLEXPORT wxDropTarget;
@@ -39,7 +36,13 @@ class WXDLLEXPORT wxDropTarget;
 
 class WXDLLEXPORT wxListItem;
 class WXDLLEXPORT wxListEvent;
+
+#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__)
 class WXDLLEXPORT wxListCtrl;
+#define wxImageListType wxImageList
+#else
+#define wxImageListType wxGenericImageList
+#endif
 
 //-----------------------------------------------------------------------------
 // internal classes
@@ -64,30 +67,31 @@ class WXDLLEXPORT wxGenericListCtrl: public wxControl
 public:
     wxGenericListCtrl();
     wxGenericListCtrl( wxWindow *parent,
-                wxWindowID id = -1,
+                wxWindowID winid = -1,
                 const wxPoint &pos = wxDefaultPosition,
                 const wxSize &size = wxDefaultSize,
                 long style = wxLC_ICON,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString &name = "listctrl" )
+                const wxString &name = wxT("listctrl") )
     {
-        Create(parent, id, pos, size, style, validator, name);
+        Create(parent, winid, pos, size, style, validator, name);
     }
     ~wxGenericListCtrl();
 
     bool Create( wxWindow *parent,
-                 wxWindowID id = -1,
+                 wxWindowID winid = -1,
                  const wxPoint &pos = wxDefaultPosition,
                  const wxSize &size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,
-                 const wxString &name = "listctrl" );
+                 const wxString &name = wxT("listctrl") );
 
     bool GetColumn( int col, wxListItem& item ) const;
     bool SetColumn( int col, wxListItem& item );
     int GetColumnWidth( int col ) const;
     bool SetColumnWidth( int col, int width);
     int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think
+    wxRect GetViewRect() const;
 
     bool GetItem( wxListItem& info ) const;
     bool SetItem( wxListItem& info ) ;
@@ -105,7 +109,7 @@ public:
     int GetItemCount() const;
     int GetColumnCount() const;
     void SetItemSpacing( int spacing, bool isSmall = FALSE );
-    int GetItemSpacing( bool isSmall ) const;
+    wxSize GetItemSpacing() const;
     void SetItemTextColour( long item, const wxColour& col);
     wxColour GetItemTextColour( long item ) const;
     void SetItemBackgroundColour( long item, const wxColour &col);
@@ -119,9 +123,9 @@ public:
     void SetWindowStyleFlag( long style );
     void RecreateWindow() {}
     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
-    wxGenericImageList *GetImageList( int which ) const;
-    void SetImageList( wxGenericImageList *imageList, int which );
-    void AssignImageList( wxGenericImageList *imageList, int which );
+    wxImageListType *GetImageList( int which ) const;
+    void SetImageList( wxImageListType *imageList, int which );
+    void AssignImageList( wxImageListType *imageList, int which );
     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 
     void ClearAll();
@@ -145,8 +149,8 @@ public:
     long InsertItem( long index, int imageIndex );
     long InsertItem( long index, const wxString& label, int imageIndex );
     long InsertColumn( long col, wxListItem& info );
-    long InsertColumn( long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
-      int width = -1 );
+    long InsertColumn( long col, const wxString& heading,
+                       int format = wxLIST_FORMAT_LEFT, int width = -1 );
     bool ScrollList( int dx, int dy );
     bool SortItems( wxListCtrlCompare fn, long data );
     bool Update( long item );
@@ -158,13 +162,19 @@ public:
     void RefreshItem(long item);
     void RefreshItems(long itemFrom, long itemTo);
 
+    // obsolete, don't use
+    wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
+
+
     // implementation only from now on
     // -------------------------------
 
-    void OnIdle( wxIdleEvent &event );
+    void OnInternalIdle( );
     void OnSize( wxSizeEvent &event );
 
     // We have to hand down a few functions
+    virtual void Refresh(bool eraseBackground = TRUE,
+                         const wxRect *rect = NULL);
 
     virtual void Freeze();
     virtual void Thaw();
@@ -183,19 +193,21 @@ public:
 
     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 
+    virtual bool ShouldInheritColours() const { return false; }
     virtual void SetFocus();
 
     // implementation
     // --------------
 
-    wxGenericImageList         *m_imageListNormal;
-    wxGenericImageList         *m_imageListSmall;
-    wxGenericImageList         *m_imageListState;  // what's that ?
+    wxImageListType         *m_imageListNormal;
+    wxImageListType         *m_imageListSmall;
+    wxImageListType         *m_imageListState;  // what's that ?
     bool                 m_ownsImageListNormal,
                          m_ownsImageListSmall,
                          m_ownsImageListState;
     wxListHeaderWindow  *m_headerWin;
     wxListMainWindow    *m_mainWin;
+    wxCoord              m_headerHeight;
 
 protected:
     // return the text for the given column of the given item
@@ -217,6 +229,9 @@ private:
     // create the header window
     void CreateHeaderWindow();
 
+    // calculate and set height of the header
+    void CalculateAndSetHeaderHeight();
+
     // reposition the header and the main window in the report view depending
     // on whether it should be shown or not
     void ResizeReportView(bool showHeader);
@@ -238,13 +253,13 @@ class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
 public:
     wxListCtrl() {}
 
-    wxListCtrl(wxWindow *parent, wxWindowID id = -1,
+    wxListCtrl(wxWindow *parent, wxWindowID winid = -1,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxLC_ICON,
                const wxValidator &validator = wxDefaultValidator,
-               const wxString &name = "listctrl" )
-    : wxGenericListCtrl(parent, id, pos, size, style, validator, name)
+               const wxString &name = wxT("listctrl") )
+    : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
     {
     }
 };