]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/listctrl.h
DoSetClientSize omissions fixed; some doc fixes
[wxWidgets.git] / include / wx / generic / listctrl.h
index da9d2dcdcdfe2668ca5a58711bb3747544655c50..697ce88046e45694492d6e2a5d30229e0c61d97b 100644 (file)
@@ -17,7 +17,7 @@
 
 #include "wx/defs.h"
 #include "wx/object.h"
-#include "wx/imaglist.h"
+#include "wx/generic/imaglist.h"
 #include "wx/control.h"
 #include "wx/timer.h"
 #include "wx/textctrl.h"
 #include "wx/scrolwin.h"
 #include "wx/settings.h"
 
+#if wxUSE_DRAG_AND_DROP
+class WXDLLEXPORT wxDropTarget;
+#endif
+
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
-class wxListItem;
-class wxListEvent;
-class wxListCtrl;
+class WXDLLEXPORT wxListItem;
+class WXDLLEXPORT wxListEvent;
+class WXDLLEXPORT wxListCtrl;
 
 //-----------------------------------------------------------------------------
 // internal classes
 //-----------------------------------------------------------------------------
 
-class wxListHeaderData;
-class wxListItemData;
-class wxListLineData;
+class WXDLLEXPORT wxListHeaderData;
+class WXDLLEXPORT wxListItemData;
+class WXDLLEXPORT wxListLineData;
 
-class wxListHeaderWindow;
-class wxListMainWindow;
+class WXDLLEXPORT wxListHeaderWindow;
+class WXDLLEXPORT wxListMainWindow;
 
-class wxListRenameTimer;
+class WXDLLEXPORT wxListRenameTimer;
 //class wxListTextCtrl;
 
 //-----------------------------------------------------------------------------
@@ -164,7 +168,7 @@ enum {
 // wxListItem
 //-----------------------------------------------------------------------------
 
-class wxListItem: public wxObject
+class WXDLLEXPORT wxListItem: public wxObject
 {
   DECLARE_DYNAMIC_CLASS(wxListItem)
 
@@ -190,7 +194,7 @@ class wxListItem: public wxObject
 // wxListEvent
 //-----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxListEvent: public wxCommandEvent
+class WXDLLEXPORT wxListEvent: public wxNotifyEvent
 {
   DECLARE_DYNAMIC_CLASS(wxListEvent)
 
@@ -209,30 +213,32 @@ class WXDLLEXPORT wxListEvent: public wxCommandEvent
 
 typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 
-#define EVT_LIST_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_DELETE_ITEM(id, fn) { wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) { wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_GET_INFO(id, fn) { wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_SET_INFO(id, fn) { wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_ITEM_SELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_ITEM_DESELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_KEY_DOWN(id, fn) { wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_INSERT_ITEM(id, fn) { wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-#define EVT_LIST_COL_CLICK(id, fn) { wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
-
+#define EVT_LIST_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_DELETE_ITEM(id, fn) { wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) { wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_GET_INFO(id, fn) { wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_SET_INFO(id, fn) { wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_ITEM_SELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_ITEM_DESELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_KEY_DOWN(id, fn) { wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_INSERT_ITEM(id, fn) { wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_COL_CLICK(id, fn) { wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) { wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
+#define EVT_LIST_ITEM_ACTIVATED(id, fn) { wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL },
 
 //-----------------------------------------------------------------------------
 //  wxListItemData (internal)
 //-----------------------------------------------------------------------------
 
-class wxListItemData : public wxObject
+class WXDLLEXPORT wxListItemData : public wxObject
 {
   DECLARE_DYNAMIC_CLASS(wxListItemData);
 
-  protected:
+  public:
     wxString   m_text;
     int        m_image;
     long       m_data;
@@ -267,7 +273,7 @@ class wxListItemData : public wxObject
 //  wxListHeaderData (internal)
 //-----------------------------------------------------------------------------
 
-class wxListHeaderData : public wxObject
+class WXDLLEXPORT wxListHeaderData : public wxObject
 {
   DECLARE_DYNAMIC_CLASS(wxListHeaderData);
 
@@ -302,29 +308,29 @@ class wxListHeaderData : public wxObject
 //  wxListLineData (internal)
 //-----------------------------------------------------------------------------
 
-class wxListLineData : public wxObject
+class WXDLLEXPORT wxListLineData : public wxObject
 {
   DECLARE_DYNAMIC_CLASS(wxListLineData);
 
-  protected:
+  public:
     wxList              m_items;
-    wxRectangle         m_bound_all;
-    wxRectangle         m_bound_label;
-    wxRectangle         m_bound_icon;
-    wxRectangle         m_bound_hilight;
+    wxRect         m_bound_all;
+    wxRect         m_bound_label;
+    wxRect         m_bound_icon;
+    wxRect         m_bound_hilight;
     int                 m_mode;
     bool                m_hilighted;
     wxBrush            *m_hilightBrush;
     int                 m_spacing;
     wxListMainWindow   *m_owner;
 
-    void DoDraw( wxPaintDC *dc, bool hilight, bool paintBG );
+    void DoDraw( wxDC *dc, bool hilight, bool paintBG );
 
   public:
     wxListLineData( void ) {};
     wxListLineData( wxListMainWindow *owner, int mode, wxBrush *hilightBrush );
-    void CalculateSize( wxPaintDC *dc, int spacing );
-    void SetPosition( wxPaintDC *dc, int x, int y,  int window_width );
+    void CalculateSize( wxDC *dc, int spacing );
+    void SetPosition( wxDC *dc, int x, int y,  int window_width );
     void SetColumnPosition( int index, int x );
     void GetSize( int &width, int &height );
     void GetExtent( int &x, int &y, int &width, int &height );
@@ -336,22 +342,22 @@ class wxListLineData : public wxObject
     void GetText( int index, wxString &s );
     void SetText( int index, const wxString s );
     int GetImage( int index );
-    void GetRect( wxRectangle &rect );
+    void GetRect( wxRect &rect );
     void Hilight( bool on );
     void ReverseHilight( void );
-    void DrawRubberBand( wxPaintDC *dc, bool on );
-    void Draw( wxPaintDC *dc );
-    bool IsInRect( int x, int y, const wxRectangle &rect );
+    void DrawRubberBand( wxDC *dc, bool on );
+    void Draw( wxDC *dc );
+    bool IsInRect( int x, int y, const wxRect &rect );
     bool IsHilighted( void );
-    void AssignRect( wxRectangle &dest, int x, int y, int width, int height );
-    void AssignRect( wxRectangle &dest, const wxRectangle &source );
+    void AssignRect( wxRect &dest, int x, int y, int width, int height );
+    void AssignRect( wxRect &dest, const wxRect &source );
 };
 
 //-----------------------------------------------------------------------------
 //  wxListHeaderWindow (internal)
 //-----------------------------------------------------------------------------
 
-class wxListHeaderWindow : public wxWindow
+class WXDLLEXPORT wxListHeaderWindow : public wxWindow
 {
   DECLARE_DYNAMIC_CLASS(wxListHeaderWindow)
 
@@ -359,14 +365,20 @@ class wxListHeaderWindow : public wxWindow
     wxListMainWindow  *m_owner;
     wxCursor          *m_currentCursor;
     wxCursor          *m_resizeCursor;
+    bool               m_isDraging;
+    int                m_column;
+    int                m_minX;
+    int                m_currentX;
 
   public:
     wxListHeaderWindow( void );
+    ~wxListHeaderWindow( void );
     wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
       long style = 0, const wxString &name = "columntitles" );
-    void DoDrawRect( wxPaintDC *dc, int x, int y, int w, int h );
+    void DoDrawRect( wxDC *dc, int x, int y, int w, int h );
     void OnPaint( wxPaintEvent &event );
+    void DrawCurrent();
     void OnMouse( wxMouseEvent &event );
     void OnSetFocus( wxFocusEvent &event );
 
@@ -377,7 +389,7 @@ class wxListHeaderWindow : public wxWindow
 // wxListRenameTimer (internal)
 //-----------------------------------------------------------------------------
 
-class wxListRenameTimer: public wxTimer
+class WXDLLEXPORT wxListRenameTimer: public wxTimer
 {
  private:
    wxListMainWindow   *m_owner;
@@ -391,7 +403,7 @@ class wxListRenameTimer: public wxTimer
 //  wxListTextCtrl (internal)
 //-----------------------------------------------------------------------------
 
-class wxListTextCtrl: public wxTextCtrl
+class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl
 {
   DECLARE_DYNAMIC_CLASS(wxListTextCtrl);
 
@@ -418,7 +430,7 @@ class wxListTextCtrl: public wxTextCtrl
 //  wxListMainWindow (internal)
 //-----------------------------------------------------------------------------
 
-class wxListMainWindow: public wxScrolledWindow
+class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow
 {
   DECLARE_DYNAMIC_CLASS(wxListMainWindow);
 
@@ -430,7 +442,6 @@ class wxListMainWindow: public wxScrolledWindow
     int                  m_visibleLines;
     wxBrush             *m_hilightBrush;
     wxColour            *m_hilightColour;
-    wxFont              *m_myFont;
     int                  m_xScroll,m_yScroll;
     bool                 m_dirty;
     wxImageList         *m_small_image_list;
@@ -456,7 +467,6 @@ class wxListMainWindow: public wxScrolledWindow
     void RefreshLine( wxListLineData *line );
     void OnPaint( wxPaintEvent &event );
     void HilightAll( bool on );
-    void ActivateLine( wxListLineData *line );
     void SendNotify( wxListLineData *line, wxEventType command );
     void FocusLine( wxListLineData *line );
     void UnfocusLine( wxListLineData *line );
@@ -474,8 +484,7 @@ class wxListMainWindow: public wxScrolledWindow
     void OnSetFocus( wxFocusEvent &event );
     void OnKillFocus( wxFocusEvent &event );
     void OnSize( wxSizeEvent &event );
-    wxFont *GetMyFont( void );
-    void DrawImage( int index, wxPaintDC *dc, int x, int y );
+    void DrawImage( int index, wxDC *dc, int x, int y );
     void GetImageSize( int index, int &width, int &height );
     int GetIndexOfLine( const wxListLineData *line );
     int GetTextLength( wxString &s );  // should be const
@@ -494,7 +503,7 @@ class wxListMainWindow: public wxScrolledWindow
     void SetItemState( long item, long state, long stateMask );
     int GetItemState( long item, long stateMask );
     int GetItemCount( void );
-    void GetItemRect( long index, wxRectangle &rect );
+    void GetItemRect( long index, wxRect &rect );
     bool GetItemPosition(long item, wxPoint& pos);
     int GetSelectedItemCount( void );
     void SetMode( long mode );
@@ -515,7 +524,6 @@ class wxListMainWindow: public wxScrolledWindow
     void InsertColumn( long col, wxListItem &item );
 //    void AddColumn( wxListItem &item );
     void SortItems( wxListCtrlCompare fn, long data );
-    virtual bool OnListNotify( wxListEvent &event );
 
   DECLARE_EVENT_TABLE()
 };
@@ -524,56 +532,64 @@ class wxListMainWindow: public wxScrolledWindow
 // wxListCtrl
 //-----------------------------------------------------------------------------
 
-class wxListCtrl: public wxControl
+class WXDLLEXPORT wxListCtrl: public wxControl
 {
   DECLARE_DYNAMIC_CLASS(wxListCtrl);
 
   public:
 
     wxListCtrl(void);
-    wxListCtrl( wxWindow *parent, wxWindowID id,
+    wxListCtrl( wxWindow *parent, wxWindowID id = -1,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      long style = 0, const wxString &name = "listctrl" );
+      long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
+       const wxString &name = "listctrl" )
+    {
+      Create(parent, id, pos, size, style, validator, name);
+    }
     ~wxListCtrl(void);
-    bool Create( wxWindow *parent, wxWindowID id,
+    bool Create( wxWindow *parent, wxWindowID id = -1,
       const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      long style = 0, const wxString &name = "listctrl" );
+      long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
+       const wxString &name = "listctrl" );
     void OnSize( wxSizeEvent &event );
-    bool GetColumn( int col, wxListItem& item );
+    bool GetColumn( int col, wxListItem& item ) const;
     bool SetColumn( int col, wxListItem& item );
-    int GetColumnWidth( int col );
+    int GetColumnWidth( int col ) const;
     bool SetColumnWidth( int col, int width);
-    int GetCountPerPage(void); // not the same in wxGLC as in Windows, I think
+    int GetCountPerPage(void) const; // not the same in wxGLC as in Windows, I think
 //  wxText& GetEditControl(void) const; // not supported in wxGLC
-    bool GetItem( wxListItem& info );
+    bool GetItem( wxListItem& info ) const;
     bool SetItem( wxListItem& info ) ;
     long SetItem( long index, int col, const wxString& label, int imageId = -1 );
-    int  GetItemState( long item, long stateMask );
+    int  GetItemState( long item, long stateMask ) const;
     bool SetItemState( long item, long state, long stateMask);
     bool SetItemImage( long item, int image, int selImage);
-    wxString GetItemText( long item );
+    wxString GetItemText( long item ) const;
     void SetItemText( long item, const wxString& str );
-    long GetItemData( long item );
+    long GetItemData( long item ) const;
     bool SetItemData( long item, long data );
-    bool GetItemRect( long item, wxRectangle& rect, int code = wxLIST_RECT_BOUNDS );
-    bool GetItemPosition( long item, wxPoint& pos );
+    bool GetItemRect( long item, 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(void);
+    int GetItemCount(void) const;
+    int GetColumnCount(void) const;
     void SetItemSpacing( int spacing, bool isSmall = FALSE );
-    int GetItemSpacing( bool isSmall );
-    int GetSelectedItemCount(void);
+    int GetItemSpacing( bool isSmall ) const;
+    int GetSelectedItemCount(void) const;
 //  wxColour GetTextColour(void) const; // wxGLC has colours for every Item (see wxListItem)
 //  void SetTextColour(const wxColour& col);
-    long GetTopItem(void);
+    long GetTopItem(void) const;
     void SetSingleStyle( long style, bool add = TRUE ) ;
     void SetWindowStyleFlag(long style);
     void RecreateWindow(void) {};
     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const;
-    wxImageList *GetImageList(int which);
+    wxImageList *GetImageList(int which) const;
     void SetImageList(wxImageList *imageList, int which) ;
     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
+    void ClearAll();
     bool DeleteItem( long item );
-    bool DeleteAllItems(void) ;
+    bool DeleteAllItems(void);
+    bool DeleteAllColumns(void);
     bool DeleteColumn( int col );
 //  wxText& Edit(long item) ;  // not supported in wxGLC
     bool EnsureVisible( long item );
@@ -591,29 +607,35 @@ class wxListCtrl: public wxControl
     bool ScrollList(int dx, int dy);
     bool SortItems(wxListCtrlCompare fn, long data);
     bool Update(long item);
-    virtual bool OnListNotify(wxListEvent& WXUNUSED(event)) { return FALSE; }
     void OnIdle( wxIdleEvent &event );
     
     // We have to hand down a few functions
     
+    void SetBackgroundColour( const wxColour &colour );
+    void SetForegroundColour( const wxColour &colour );
+    void SetFont( const wxFont &font );
+    
+#if wxUSE_DRAG_AND_DROP
     void SetDropTarget( wxDropTarget *dropTarget )
       { m_mainWin->SetDropTarget( dropTarget ); }
     wxDropTarget *GetDropTarget() const
       { return m_mainWin->GetDropTarget(); }
+#endif
+
     void SetCursor( const wxCursor &cursor )
-      { m_mainWin->SetCursor( cursor); }
+      { if (m_mainWin) m_mainWin->wxWindow::SetCursor( cursor); }
     wxColour GetBackgroundColour() const
-      { return m_mainWin->GetBackgroundColour(); }
-    void SetBackgroundColour( const wxColour &colour )
-      { m_mainWin->SetBackgroundColour(colour); }
+      { if (m_mainWin) return m_mainWin->GetBackgroundColour();
+        else return wxColour(); }
     wxColour GetForegroundColour() const
-      { return m_mainWin->GetForegroundColour(); }
-    void SetForegroundColour( const wxColour &colour )
-      { m_mainWin->SetForegroundColour(colour); }
+      { if (m_mainWin) return m_mainWin->GetForegroundColour();
+        else return wxColour(); }
     bool PopupMenu( wxMenu *menu, int x, int y )
       { return m_mainWin->PopupMenu( menu, x, y ); }
+    void SetFocus()
+      { m_mainWin->SetFocus(); }
 
-  protected:
+  // implementation
 
 //  wxListTextCtrl       m_textCtrl;
     wxImageList         *m_imageListNormal;