Rebake from clean wx tree.
[wxWidgets.git] / include / wx / generic / listctrl.h
index 0224f03c14b7993b5bc131fc8a38d32cbef9408f..1d02db33890874ba77aa66c42b957f90eaf3634e 100644 (file)
@@ -8,65 +8,39 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __LISTCTRLH_G__
-#define __LISTCTRLH_G__
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#ifdef __WXMAC__
-#include "wx/imaglist.h"
-#else
-#include "wx/generic/imaglist.h"
-#endif
+#ifndef _WX_GENERIC_LISTCTRL_H_
+#define _WX_GENERIC_LISTCTRL_H_
 
-#include "wx/control.h"
-#include "wx/timer.h"
-#include "wx/dcclient.h"
 #include "wx/scrolwin.h"
-#include "wx/settings.h"
-#include "wx/listbase.h"
 #include "wx/textctrl.h"
 
-#if wxUSE_DRAG_AND_DROP
-class WXDLLEXPORT wxDropTarget;
-#endif
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+class WXDLLIMPEXP_FWD_CORE wxImageList;
 
-class WXDLLEXPORT wxListItem;
-class WXDLLEXPORT wxListEvent;
-
-#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
-class WXDLLEXPORT wxListCtrl;
-#define wxImageListType wxImageList
-#else
-#define wxImageListType wxGenericImageList
+#if wxUSE_DRAG_AND_DROP
+class WXDLLIMPEXP_FWD_CORE wxDropTarget;
 #endif
 
 //-----------------------------------------------------------------------------
 // internal classes
 //-----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxListHeaderData;
-class WXDLLEXPORT wxListItemData;
-class WXDLLEXPORT wxListLineData;
-
-class WXDLLEXPORT wxListHeaderWindow;
-class WXDLLEXPORT wxListMainWindow;
-
-class WXDLLEXPORT wxListRenameTimer;
-class WXDLLEXPORT wxListTextCtrl;
+class WXDLLIMPEXP_FWD_CORE wxListHeaderWindow;
+class WXDLLIMPEXP_FWD_CORE wxListMainWindow;
 
 //-----------------------------------------------------------------------------
 // wxListCtrl
 //-----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxGenericListCtrl: public wxControl
+class WXDLLIMPEXP_CORE wxGenericListCtrl: public wxControl,
+                                          public wxScrollHelper
 {
 public:
-    wxGenericListCtrl();
+
+    wxGenericListCtrl() : wxScrollHelper(this)
+    {
+        Init();
+    }
+
     wxGenericListCtrl( wxWindow *parent,
                 wxWindowID winid = wxID_ANY,
                 const wxPoint &pos = wxDefaultPosition,
@@ -74,10 +48,14 @@ public:
                 long style = wxLC_ICON,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString &name = wxListCtrlNameStr)
+            : wxScrollHelper(this)
     {
         Create(parent, winid, pos, size, style, validator, name);
     }
-    ~wxGenericListCtrl();
+
+    virtual ~wxGenericListCtrl();
+
+    void Init();
 
     bool Create( wxWindow *parent,
                  wxWindowID winid = wxID_ANY,
@@ -104,8 +82,10 @@ public:
     wxString GetItemText( long item ) const;
     void SetItemText( long item, const wxString& str );
     wxUIntPtr GetItemData( long item ) const;
-    bool SetItemData( long item, long data );
+    bool SetItemPtrData(long item, wxUIntPtr data);
+    bool SetItemData(long item, long data) { return SetItemPtrData(item, data); }
     bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
+    bool GetSubItemRect( long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
     bool GetItemPosition( long item, wxPoint& pos ) const;
     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
     int GetItemCount() const;
@@ -127,9 +107,9 @@ public:
     void SetWindowStyleFlag( long style );
     void RecreateWindow() {}
     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
-    wxImageListType *GetImageList( int which ) const;
-    void SetImageList( wxImageListType *imageList, int which );
-    void AssignImageList( wxImageListType *imageList, int which );
+    wxImageList *GetImageList( int which ) const;
+    void SetImageList( wxImageList *imageList, int which );
+    void AssignImageList( wxImageList *imageList, int which );
     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 
     void ClearAll();
@@ -158,10 +138,7 @@ public:
     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 );
-    // Must provide overload to avoid hiding it (and warnings about it)
-    virtual void Update() { wxControl::Update(); }
+    bool SortItems( wxListCtrlCompare fn, wxIntPtr data );
 
     // are we in report mode?
     bool InReportView() const { return HasFlag(wxLC_REPORT); }
@@ -182,6 +159,10 @@ public:
     wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
 #endif // WXWIN_COMPATIBILITY_2_6
 
+
+    // overridden base class virtuals
+    // ------------------------------
+
     virtual wxVisualAttributes GetDefaultAttributes() const
     {
         return GetClassDefaultAttributes(GetWindowVariant());
@@ -190,19 +171,21 @@ public:
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
+    virtual void Update();
+
+
     // implementation only from now on
     // -------------------------------
 
+    // generic version extension, don't use in portable code
+    bool Update( long item );
+
     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();
-
     virtual bool SetBackgroundColour( const wxColour &colour );
     virtual bool SetForegroundColour( const wxColour &colour );
     virtual wxColour GetBackgroundColour() const;
@@ -221,9 +204,9 @@ public:
     // implementation
     // --------------
 
-    wxImageListType         *m_imageListNormal;
-    wxImageListType         *m_imageListSmall;
-    wxImageListType         *m_imageListState;  // what's that ?
+    wxImageList         *m_imageListNormal;
+    wxImageList         *m_imageListSmall;
+    wxImageList         *m_imageListState;  // what's that ?
     bool                 m_ownsImageListNormal,
                          m_ownsImageListSmall,
                          m_ownsImageListState;
@@ -256,30 +239,37 @@ protected:
     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 
     // it calls our OnGetXXX() functions
-    friend class WXDLLEXPORT wxListMainWindow;
+    friend class WXDLLIMPEXP_FWD_CORE wxListMainWindow;
+
+    virtual wxBorder GetDefaultBorder() const;
+
+    virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
 
 private:
-    // create the header window
-    void CreateHeaderWindow();
+    void CreateOrDestroyHeaderWindowAsNeeded();
+    void OnScroll( wxScrollWinEvent& event );
+    void OnSize( wxSizeEvent &event );
 
-    // calculate and set height of the header
-    void CalculateAndSetHeaderHeight();
+    // we need to return a special WM_GETDLGCODE value to process just the
+    // arrows but let the other navigation characters through
+#if defined(__WXMSW__) && !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__)
+    virtual WXLRESULT
+    MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+#endif // __WXMSW__
 
-    // reposition the header and the main window in the report view depending
-    // on whether it should be shown or not
-    void ResizeReportView(bool showHeader);
+    WX_FORWARD_TO_SCROLL_HELPER()
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericListCtrl)
 };
 
-#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
+#if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__)) && (!(defined(__WXMAC__) && wxOSX_USE_CARBON) || defined(__WXUNIVERSAL__ ))
 /*
  * wxListCtrl has to be a real class or we have problems with
  * the run-time information.
  */
 
-class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
+class WXDLLIMPEXP_CORE wxListCtrl: public wxGenericListCtrl
 {
     DECLARE_DYNAMIC_CLASS(wxListCtrl)
 
@@ -295,7 +285,8 @@ public:
     : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
     {
     }
+
 };
 #endif // !__WXMSW__ || __WXUNIVERSAL__
 
-#endif // __LISTCTRLH_G__
+#endif // _WX_GENERIC_LISTCTRL_H_