Document that wxDC::FloodFill() is not implemented under wxOSX.

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

diff --git a/include/wx/generic/listctrl.h b/include/wx/generic/listctrl.h
index 3231d60f074a652fef1ccac58c356f062c5c255a..b824b4f00874dba1c7523f5cb44f011a50409cb4 100644 (file)
--- a/include/wx/generic/listctrl.h
+++ b/include/wx/generic/listctrl.h
@@ -8,96 +8,64 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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/containr.h"

 #include "wx/scrolwin.h"
 #include "wx/scrolwin.h"

-#include "wx/settings.h"
-#include "wx/listbase.h"

 #include "wx/textctrl.h"
 
 #if wxUSE_DRAG_AND_DROP
 #include "wx/textctrl.h"
 
 #if wxUSE_DRAG_AND_DROP

-class WXDLLEXPORT wxDropTarget;
-#endif
-
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-extern WXDLLEXPORT_DATA(const wxChar) wxGenericListCtrlNameStr[];
-
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxListItem;
-class WXDLLEXPORT wxListEvent;
-
-#if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__))
-#ifndef __WXMAC__
-class WXDLLEXPORT wxListCtrl;
-#endif
-#define wxImageListType wxImageList
-#else
-#define wxImageListType wxGenericImageList
+class WXDLLIMPEXP_FWD_CORE wxDropTarget;

 #endif
 
 //-----------------------------------------------------------------------------
 // internal classes
 //-----------------------------------------------------------------------------
 
 #endif
 
 //-----------------------------------------------------------------------------
 // internal classes
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListHeaderData;
-class WXDLLEXPORT wxListItemData;
-
-class WXDLLEXPORT wxListHeaderWindow;
-class WXDLLEXPORT wxListMainWindow;
-
-class WXDLLEXPORT wxListRenameTimer;
-class WXDLLEXPORT wxListTextCtrl;
+class WXDLLIMPEXP_FWD_CORE wxListHeaderWindow;
+class WXDLLIMPEXP_FWD_CORE wxListMainWindow;

 
 //-----------------------------------------------------------------------------
 // wxListCtrl
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxListCtrl
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxGenericListCtrl: public wxControl
+class WXDLLIMPEXP_CORE wxGenericListCtrl: public wxNavigationEnabled<wxListCtrlBase>,
+                                          public wxScrollHelper

 {
 public:
 
 {
 public:
 

-    wxGenericListCtrl();
+    wxGenericListCtrl() : wxScrollHelper(this)
+    {
+        Init();
+    }
+

     wxGenericListCtrl( wxWindow *parent,
                 wxWindowID winid = wxID_ANY,
                 const wxPoint &pos = wxDefaultPosition,
                 const wxSize &size = wxDefaultSize,
                 long style = wxLC_ICON,
                 const wxValidator& validator = wxDefaultValidator,
     wxGenericListCtrl( wxWindow *parent,
                 wxWindowID winid = wxID_ANY,
                 const wxPoint &pos = wxDefaultPosition,
                 const wxSize &size = wxDefaultSize,
                 long style = wxLC_ICON,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString &name = wxGenericListCtrlNameStr)
+                const wxString &name = wxListCtrlNameStr)
+            : wxScrollHelper(this)

     {
         Create(parent, winid, pos, size, style, validator, name);
     }
     {
         Create(parent, winid, pos, size, style, validator, name);
     }

+

     virtual ~wxGenericListCtrl();
 
     virtual ~wxGenericListCtrl();
 

+    void Init();
+

     bool Create( wxWindow *parent,
                  wxWindowID winid = wxID_ANY,
                  const wxPoint &pos = wxDefaultPosition,
                  const wxSize &size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,
     bool Create( wxWindow *parent,
                  wxWindowID winid = wxID_ANY,
                  const wxPoint &pos = wxDefaultPosition,
                  const wxSize &size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,

-                 const wxString &name = wxGenericListCtrlNameStr);
+                 const wxString &name = wxListCtrlNameStr);

 
     bool GetColumn( int col, wxListItem& item ) const;
 
     bool GetColumn( int col, wxListItem& item ) const;

-    bool SetColumn( int col, wxListItem& item );
+    bool SetColumn( int col, const 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
     int GetColumnWidth( int col ) const;
     bool SetColumnWidth( int col, int width);
     int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think


@@ -110,11 +78,13 @@ public:
     bool SetItemState( long item, long state, long stateMask);
     bool SetItemImage( long item, int image, int selImage = -1 );
     bool SetItemColumnImage( long item, long column, int image );
     bool SetItemState( long item, long state, long stateMask);
     bool SetItemImage( long item, int image, int selImage = -1 );
     bool SetItemColumnImage( long item, long column, int image );

-    wxString GetItemText( long item ) const;
+    wxString GetItemText( long item, int col = 0 ) const;

     void SetItemText( long item, const wxString& str );
     wxUIntPtr GetItemData( 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 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;
     bool GetItemPosition( long item, wxPoint& pos ) const;
     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
     int GetItemCount() const;


@@ -136,9 +106,9 @@ public:
     void SetWindowStyleFlag( long style );
     void RecreateWindow() {}
     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
     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();
     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 
     void ClearAll();


@@ -150,7 +120,7 @@ public:
     void SetItemCount(long count);
 
     wxTextCtrl *EditLabel(long item,
     void SetItemCount(long count);
 
     wxTextCtrl *EditLabel(long item,

-                          wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
+                          wxClassInfo* textControlClass = wxCLASSINFO(wxTextCtrl));

     wxTextCtrl* GetEditControl() const;
     void Edit( long item ) { EditLabel(item); }
 
     wxTextCtrl* GetEditControl() const;
     void Edit( long item ) { EditLabel(item); }
 


@@ -163,20 +133,8 @@ public:
     long InsertItem( long index, const wxString& label );
     long InsertItem( long index, int imageIndex );
     long InsertItem( long index, const wxString& label, int imageIndex );
     long InsertItem( long index, const wxString& label );
     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 );

     bool ScrollList( int dx, int dy );
     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(); }
-
-    // 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); }
+    bool SortItems( wxListCtrlCompare fn, wxIntPtr data );

 
     // do we have a header window?
     bool HasHeader() const
 
     // do we have a header window?
     bool HasHeader() const


@@ -186,11 +144,17 @@ public:
     void RefreshItem(long item);
     void RefreshItems(long itemFrom, long itemTo);
 
     void RefreshItem(long item);
     void RefreshItems(long itemFrom, long itemTo);
 

+    virtual void EnableBellOnNoMatch(bool on = true);
+

 #if WXWIN_COMPATIBILITY_2_6
     // obsolete, don't use
     wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
 #endif // WXWIN_COMPATIBILITY_2_6
 
 #if WXWIN_COMPATIBILITY_2_6
     // obsolete, don't use
     wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
 #endif // WXWIN_COMPATIBILITY_2_6
 

+
+    // overridden base class virtuals
+    // ------------------------------
+

     virtual wxVisualAttributes GetDefaultAttributes() const
     {
         return GetClassDefaultAttributes(GetWindowVariant());
     virtual wxVisualAttributes GetDefaultAttributes() const
     {
         return GetClassDefaultAttributes(GetWindowVariant());


@@ -199,19 +163,21 @@ public:
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 

+    virtual void Update();
+
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 

+    // generic version extension, don't use in portable code
+    bool Update( long item );
+

     void OnInternalIdle( );
     void OnInternalIdle( );

-    void OnSize( wxSizeEvent &event );

 
     // We have to hand down a few functions
     virtual void Refresh(bool eraseBackground = true,
                          const wxRect *rect = NULL);
 
 
     // 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;
     virtual bool SetBackgroundColour( const wxColour &colour );
     virtual bool SetForegroundColour( const wxColour &colour );
     virtual wxColour GetBackgroundColour() const;


@@ -225,30 +191,27 @@ public:
 #endif
 
     virtual bool ShouldInheritColours() const { return false; }
 #endif
 
     virtual bool ShouldInheritColours() const { return false; }

-    virtual void SetFocus();

 
     // implementation
     // --------------
 
 
     // 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;
     wxListHeaderWindow  *m_headerWin;
     wxListMainWindow    *m_mainWin;
     bool                 m_ownsImageListNormal,
                          m_ownsImageListSmall,
                          m_ownsImageListState;
     wxListHeaderWindow  *m_headerWin;
     wxListMainWindow    *m_mainWin;

-    wxCoord              m_headerHeight;

 
 protected:
 
 protected:

-    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+    // Implement base class pure virtual methods.
+    long DoInsertColumn(long col, const wxListItem& info);

 
 

-    // take into account the coordinates difference between the container
-    // window and the list control window itself here
-    virtual void DoClientToScreen( int *x, int *y ) const;
-    virtual void DoScreenToClient( int *x, int *y ) const;

 
 

-    virtual wxSize DoGetBestSize() const;
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+
+    virtual wxSize DoGetBestClientSize() const;

 
     // return the text for the given column of the given item
     virtual wxString OnGetItemText(long item, long column) const;
 
     // return the text for the given column of the given item
     virtual wxString OnGetItemText(long item, long column) const;


@@ -261,34 +224,38 @@ protected:
     // return the icon for the given item and column.
     virtual int OnGetItemColumnImage(long item, long column) 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;
-

     // it calls our OnGetXXX() functions
     // 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:
 
 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)
 };
 
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericListCtrl)
 };
 

-#if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__)) && !defined(__WXMAC__)
+#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.
  */
 
 /*
  * 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)
 
 {
     DECLARE_DYNAMIC_CLASS(wxListCtrl)
 


@@ -304,8 +271,8 @@ public:
     : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
     {
     }
     : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
     {
     }

-    
+

 };
 #endif // !__WXMSW__ || __WXUNIVERSAL__
 
 };
 #endif // !__WXMSW__ || __WXUNIVERSAL__
 

-#endif // __LISTCTRLH_G__
+#endif // _WX_GENERIC_LISTCTRL_H_