the wxFormatString hack used in wxFileTypeInfo variadic ctors doesn't work anymore...

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

diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h
index c1df3d63dc908c5e23e7285210c75196bad51576..4207e50ef655483ac3488bf18a388815e2f9885d 100644 (file)
--- a/include/wx/generic/dataview.h
+++ b/include/wx/generic/dataview.h
@@ -2,6 +2,7 @@
 // Name:        wx/generic/dataview.h
 // Purpose:     wxDataViewCtrl generic implementation header
 // Author:      Robert Roebling
 // Name:        wx/generic/dataview.h
 // Purpose:     wxDataViewCtrl generic implementation header
 // Author:      Robert Roebling

+// Modified By: Bo Yang

 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence


@@ -15,200 +16,324 @@
 #include "wx/list.h"
 #include "wx/control.h"
 #include "wx/scrolwin.h"
 #include "wx/list.h"
 #include "wx/control.h"
 #include "wx/scrolwin.h"

+#include "wx/icon.h"

 
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // classes
 // classes

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 

-class WXDLLIMPEXP_CORE wxDataViewCtrl;
-class WXDLLIMPEXP_CORE wxDataViewMainWindow;
-class WXDLLIMPEXP_CORE wxDataViewHeaderWindow;
+class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
+class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
+class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;

 
 

-// --------------------------------------------------------- 
-// wxDataViewCell
-// --------------------------------------------------------- 
+// ---------------------------------------------------------
+// wxDataViewRenderer
+// ---------------------------------------------------------

 
 

-class wxDataViewCell: public wxDataViewCellBase
+class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase

 {
 public:
 {
 public:

-    wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
-    ~wxDataViewCell();
+    wxDataViewRenderer( const wxString &varianttype, 
+                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                        int align = wxDVR_DEFAULT_ALIGNMENT );
+    virtual ~wxDataViewRenderer();

 
     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
 
     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;

-    virtual wxSize GetSize() = 0;
-    
-    virtual bool Activate( wxRect cell,
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    
-    virtual bool LeftClick( wxPoint cursor, wxRect cell, 
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    virtual bool RightClick( wxPoint cursor, wxRect cell,
-                           wxDataViewListModel *model, size_t col, size_t row )   
-                           { return false; }
-    virtual bool StartDrag( wxPoint cursor, wxRect cell, 
-                           wxDataViewListModel *model, size_t col, size_t row )   
+    virtual wxSize GetSize() const = 0;
+
+    virtual void SetAlignment( int align )
+        { m_align=align; }
+    virtual int GetAlignment() const
+        { return m_align; }
+
+    virtual void SetMode( wxDataViewCellMode mode )
+        { m_mode=mode; }
+    virtual wxDataViewCellMode GetMode() const
+        { return m_mode; }
+
+    virtual bool Activate( wxRect WXUNUSED(cell),
+                           wxDataViewModel *WXUNUSED(model),
+                           const wxDataViewItem & WXUNUSED(item), 
+                           unsigned int WXUNUSED(col) )

                            { return false; }
                            { return false; }

-    
+
+    virtual bool LeftClick( wxPoint WXUNUSED(cursor),
+                            wxRect WXUNUSED(cell),
+                            wxDataViewModel *WXUNUSED(model),
+                            const wxDataViewItem & WXUNUSED(item), 
+                            unsigned int WXUNUSED(col) )
+                            { return false; }
+    virtual bool RightClick( wxPoint WXUNUSED(cursor),
+                             wxRect WXUNUSED(cell),
+                             wxDataViewModel *WXUNUSED(model),
+                             const wxDataViewItem & WXUNUSED(item), 
+                             unsigned int WXUNUSED(col) )
+                             { return false; }
+    virtual bool StartDrag( wxPoint WXUNUSED(cursor),
+                            wxRect WXUNUSED(cell),
+                            wxDataViewModel *WXUNUSED(model),
+                            const wxDataViewItem & WXUNUSED(item), 
+                            unsigned int WXUNUSED(col) )
+                            { return false; }
+

     // Create DC on request
     virtual wxDC *GetDC();
     // Create DC on request
     virtual wxDC *GetDC();

-    
+

 private:
 private:

-    wxDC        *m_dc;
-    
+    wxDC                        *m_dc;
+    int                          m_align;
+    wxDataViewCellMode           m_mode;
+
+protected:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
+};
+
+// ---------------------------------------------------------
+// wxDataViewCustomRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
+{
+public:
+    wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
+                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                              int align = wxDVR_DEFAULT_ALIGNMENT );
+

 protected:
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)

 };
 };

-    
-// --------------------------------------------------------- 
-// wxDataViewCustomCell
-// --------------------------------------------------------- 

 
 

-class wxDataViewCustomCell: public wxDataViewCell
+
+// ---------------------------------------------------------
+// wxDataViewTextRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewCustomCell( const wxString &varianttype = wxT("string"), 
-                          wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
-    
+    wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                            int align = wxDVR_DEFAULT_ALIGNMENT );
+
+    bool SetValue( const wxVariant &value );
+    bool GetValue( wxVariant &value ) const;
+
+    bool Render( wxRect cell, wxDC *dc, int state );
+    wxSize GetSize() const;
+
+    // in-place editing
+    virtual bool HasEditorCtrl();
+    virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
+    virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
+        
+private:
+    wxString   m_text;
+

 protected:
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)

 };
 };

-    
-// --------------------------------------------------------- 
-// wxDataViewTextCell
-// --------------------------------------------------------- 

 
 

-class wxDataViewTextCell: public wxDataViewCustomCell
+// ---------------------------------------------------------
+// wxDataViewBitmapRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewTextCell( const wxString &varianttype = wxT("string"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
+                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                              int align = wxDVR_DEFAULT_ALIGNMENT );

 
     bool SetValue( const wxVariant &value );
 
     bool SetValue( const wxVariant &value );

-    bool GetValue( wxVariant &value );
-    
+    bool GetValue( wxVariant &value ) const;
+

     bool Render( wxRect cell, wxDC *dc, int state );
     bool Render( wxRect cell, wxDC *dc, int state );

-    wxSize GetSize();
-    
+    wxSize GetSize() const;
+

 private:
 private:

-    wxString m_text;
-    
+    wxIcon m_icon;
+    wxBitmap m_bitmap;
+

 protected:
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)

 };
 };

-    
-// --------------------------------------------------------- 
-// wxDataViewToggleCell
-// --------------------------------------------------------- 

 
 

-class wxDataViewToggleCell: public wxDataViewCustomCell
+// ---------------------------------------------------------
+// wxDataViewToggleRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewToggleCell( const wxString &varianttype = wxT("bool"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
+                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                              int align = wxDVR_DEFAULT_ALIGNMENT );

 
     bool SetValue( const wxVariant &value );
 
     bool SetValue( const wxVariant &value );

-    bool GetValue( wxVariant &value );
-    
+    bool GetValue( wxVariant &value ) const;
+

     bool Render( wxRect cell, wxDC *dc, int state );
     bool Render( wxRect cell, wxDC *dc, int state );

-    wxSize GetSize();
-    
+    bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item, 
+                            unsigned int col );
+    wxSize GetSize() const;
+

 private:
     bool    m_toggle;
 private:
     bool    m_toggle;

-    
+

 protected:
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)

 };
 };

-    
-// --------------------------------------------------------- 
-// wxDataViewProgressCell
-// --------------------------------------------------------- 

 
 

-class wxDataViewProgressCell: public wxDataViewCustomCell
+// ---------------------------------------------------------
+// wxDataViewProgressRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewProgressCell( const wxString &label = wxEmptyString, 
-                            const wxString &varianttype = wxT("long"), 
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
-    ~wxDataViewProgressCell();
-    
+    wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
+                                const wxString &varianttype = wxT("long"),
+                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                                int align = wxDVR_DEFAULT_ALIGNMENT );
+    virtual ~wxDataViewProgressRenderer();
+

     bool SetValue( const wxVariant &value );
     bool SetValue( const wxVariant &value );

-    
+    bool GetValue( wxVariant& value ) const;
+

     virtual bool Render( wxRect cell, wxDC *dc, int state );
     virtual bool Render( wxRect cell, wxDC *dc, int state );

-    virtual wxSize GetSize();
-    
+    virtual wxSize GetSize() const;
+

 private:
     wxString    m_label;
     int         m_value;
 private:
     wxString    m_label;
     int         m_value;

-    
+

 protected:
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)

 };
 };

-    
-// --------------------------------------------------------- 
-// wxDataViewDateCell
-// --------------------------------------------------------- 

 
 

-class wxDataViewDateCell: public wxDataViewCustomCell
+// ---------------------------------------------------------
+// wxDataViewDateRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewDateCell( const wxString &varianttype = wxT("datetime"), 
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE );
-    
+    wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
+                            int align = wxDVR_DEFAULT_ALIGNMENT );
+

     bool SetValue( const wxVariant &value );
     bool SetValue( const wxVariant &value );

-    
+    bool GetValue( wxVariant& value ) const;
+

     virtual bool Render( wxRect cell, wxDC *dc, int state );
     virtual bool Render( wxRect cell, wxDC *dc, int state );

-    virtual wxSize GetSize();
+    virtual wxSize GetSize() const;

     virtual bool Activate( wxRect cell,
     virtual bool Activate( wxRect cell,

-                           wxDataViewListModel *model, size_t col, size_t row );
-    
+                           wxDataViewModel *model, const wxDataViewItem & item, unsigned int col );
+

 private:
     wxDateTime    m_date;
 private:
     wxDateTime    m_date;

-    
+

 protected:
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)

 };
 };

-    
-// --------------------------------------------------------- 
+
+// ---------------------------------------------------------

 // wxDataViewColumn
 // wxDataViewColumn

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 

-class WXDLLIMPEXP_CORE wxDataViewColumn: public wxDataViewColumnBase
+class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase

 {
 {

+    friend class wxDataViewHeaderWindowBase;
+    friend class wxDataViewHeaderWindow;
+    friend class wxDataViewHeaderWindowMSW;
+

 public:
 public:

-    wxDataViewColumn( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 );
+    wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer, 
+                      unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH, 
+                      wxAlignment align = wxALIGN_CENTER,
+                      int flags = wxDATAVIEW_COL_RESIZABLE );
+    wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer, 
+                      unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH, 
+                      wxAlignment align = wxALIGN_CENTER,
+                      int flags = wxDATAVIEW_COL_RESIZABLE );

     virtual ~wxDataViewColumn();
 
     virtual ~wxDataViewColumn();
 

-    virtual void SetTitle( const wxString &title );
-    
-    void SetWidth( int width ) { m_width = width; }
-    int GetWidth() { return m_width; }
-    
+    // setters:
+
+    virtual void SetTitle( const wxString &title )
+        { m_title=title; }
+    virtual void SetAlignment( wxAlignment align )
+        { m_align=align; }
+    virtual void SetMinWidth( int minWidth )
+        { m_minWidth=minWidth; }
+    virtual void SetWidth( int width );
+    virtual void SetSortable( bool sortable );
+    virtual void SetResizeable( bool resizeable );
+    virtual void SetHidden( bool hidden );
+    virtual void SetSortOrder( bool ascending );
+
+
+    // getters:
+
+    virtual wxString GetTitle() const
+        { return m_title; }
+    virtual wxAlignment GetAlignment() const
+        { return m_align; }
+    virtual int GetWidth() const
+        { return m_width; }
+    virtual int GetMinWidth() const
+        { return m_minWidth; }
+    virtual bool IsSortable() const
+        { return (m_flags & wxDATAVIEW_COL_SORTABLE) != 0; }
+    virtual bool IsResizeable() const
+        { return (m_flags & wxDATAVIEW_COL_RESIZABLE) != 0; }
+    virtual bool IsHidden() const
+        { return (m_flags & wxDATAVIEW_COL_HIDDEN) != 0; }
+    virtual bool IsSortOrderAscending() const;
+
+

 private:
 private:

-    int     m_width;
+    int                      m_width;
+    int                      m_minWidth;
+    int                      m_flags;
+    wxAlignment              m_align;
+    wxString                 m_title;
+    bool                     m_ascending;
+
+    void Init(int width);
+
+    // like SetWidth() but does not ask the header window of the
+    // wxDataViewCtrl to reflect the width-change.
+    void SetInternalWidth(int width);

 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
 };
 
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
 };
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewCtrl
 // wxDataViewCtrl

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 

-class WXDLLIMPEXP_CORE wxDataViewCtrl: public wxDataViewCtrlBase, 
+class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,

                                        public wxScrollHelperNative
 {
                                        public wxScrollHelperNative
 {

+    friend class wxDataViewMainWindow;
+    friend class wxDataViewHeaderWindowBase;
+    friend class wxDataViewHeaderWindow;
+    friend class wxDataViewHeaderWindowMSW;
+    friend class wxDataViewColumn;
+

 public:
     wxDataViewCtrl() : wxScrollHelperNative(this)
     {
 public:
     wxDataViewCtrl() : wxScrollHelperNative(this)
     {

+        m_sortingColumn = 0;

         Init();
     }
         Init();
     }

-    
+

     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
            const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize, long style = 0,
     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
            const wxPoint& pos = wxDefaultPosition,
            const wxSize& size = wxDefaultSize, long style = 0,

-           const wxValidator& validator = wxDefaultValidator ) 
+           const wxValidator& validator = wxDefaultValidator )

              : wxScrollHelperNative(this)
     {
         Create(parent, id, pos, size, style, validator );
              : wxScrollHelperNative(this)
     {
         Create(parent, id, pos, size, style, validator );


@@ -223,19 +348,66 @@ public:
            const wxSize& size = wxDefaultSize, long style = 0,
            const wxValidator& validator = wxDefaultValidator );
 
            const wxSize& size = wxDefaultSize, long style = 0,
            const wxValidator& validator = wxDefaultValidator );
 

-    virtual bool AssociateModel( wxDataViewListModel *model );
+    virtual bool AssociateModel( wxDataViewModel *model );

     virtual bool AppendColumn( wxDataViewColumn *col );
     virtual bool AppendColumn( wxDataViewColumn *col );

-    
+
+    virtual void DoSetExpanderColumn();
+    virtual void DoSetIndent();
+
+    virtual wxDataViewItem GetSelection();
+    virtual int GetSelections( wxDataViewItemArray & sel ) const;
+    virtual void SetSelections( const wxDataViewItemArray & sel );
+    virtual void Select( const wxDataViewItem & item );
+    virtual void Unselect( const wxDataViewItem & item );
+    virtual bool IsSelected( const wxDataViewItem & item ) const;
+
+    virtual void SelectAll();
+    virtual void UnselectAll();
+
+    virtual void EnsureVisible( const wxDataViewItem & item,
+                                wxDataViewColumn *column = NULL );
+    virtual void HitTest( const wxPoint & point, wxDataViewItem & item, unsigned int & column ) const;
+    virtual wxRect GetItemRect( const wxDataViewItem & item, unsigned int column ) const;
+
+protected:
+    virtual int GetSelections( wxArrayInt & sel ) const; 
+    virtual void SetSelections( const wxArrayInt & sel );
+    virtual void Select( int row );
+    virtual void Unselect( int row );
+    virtual bool IsSelected( int row ) const;
+    virtual void SelectRange( int from, int to );
+    virtual void UnselectRange( int from, int to );
+
+    virtual void EnsureVisible( int row );
+
+    virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
+    virtual int GetRowByItem( const wxDataViewItem & item ) const;
+
+    unsigned int GetSortingColumn() { return m_sortingColumn; }
+    void SetSortingColumn( unsigned int column ) { m_sortingColumn = column; }
+
+public:     // utility functions not part of the API
+
+    // returns the "best" width for the idx-th column
+    unsigned int GetBestColumnWidth(int WXUNUSED(idx)) const
+    {
+        return GetClientSize().GetWidth() / GetColumnCount();
+    }
+
+    // updates the header window after a change in a column setting
+    void OnColumnChange();
+
+    wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
+

 private:
 private:

-    friend class wxDataViewMainWindow;
-    friend class wxDataViewHeaderWindow;
-    wxDataViewListModelNotifier *m_notifier;
+    wxDataViewModelNotifier *m_notifier;

     wxDataViewMainWindow        *m_clientArea;
     wxDataViewHeaderWindow      *m_headerArea;
     wxDataViewMainWindow        *m_clientArea;
     wxDataViewHeaderWindow      *m_headerArea;

-    
+    unsigned int m_sortingColumn;
+

 private:
     void OnSize( wxSizeEvent &event );
 private:
     void OnSize( wxSizeEvent &event );

-    
+

     // we need to return a special WM_GETDLGCODE value to process just the
     // arrows but let the other navigation characters through
 #ifdef __WXMSW__
     // we need to return a special WM_GETDLGCODE value to process just the
     // arrows but let the other navigation characters through
 #ifdef __WXMSW__