added wxUTF8StringBuffer for writing UTF8 data into wxString efficiently, similarly...

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

diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h
index d300b95f1daaab9ba3e41c10b30850593ef0c999..083d4b1cfb1478ccea9c3a45c563a798e21b1ec7 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


@@ -21,190 +22,219 @@
 // classes
 // ---------------------------------------------------------
 
 // classes
 // ---------------------------------------------------------
 

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

 
 // ---------------------------------------------------------
 
 // ---------------------------------------------------------

-// wxDataViewCell
+// wxDataViewRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

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

 {
 public:
 {
 public:

-    wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
-    virtual ~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 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),
 
     virtual bool Activate( wxRect WXUNUSED(cell),

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

                            { return false; }
 
     virtual bool LeftClick( wxPoint WXUNUSED(cursor),
                             wxRect WXUNUSED(cell),
                            { return false; }
 
     virtual bool LeftClick( wxPoint WXUNUSED(cursor),
                             wxRect WXUNUSED(cell),

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

                             { return false; }
     virtual bool RightClick( wxPoint WXUNUSED(cursor),
                              wxRect WXUNUSED(cell),
                             { return false; }
     virtual bool RightClick( wxPoint WXUNUSED(cursor),
                              wxRect WXUNUSED(cell),

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

                              { return false; }
     virtual bool StartDrag( wxPoint WXUNUSED(cursor),
                             wxRect WXUNUSED(cell),
                              { return false; }
     virtual bool StartDrag( wxPoint WXUNUSED(cursor),
                             wxRect WXUNUSED(cell),

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

                             { return false; }
 
     // Create DC on request
     virtual wxDC *GetDC();
 
 private:
                             { return false; }
 
     // Create DC on request
     virtual wxDC *GetDC();
 
 private:

-    wxDC        *m_dc;
+    wxDC                        *m_dc;
+    int                          m_align;
+    wxDataViewCellMode           m_mode;

 
 protected:
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------

-// wxDataViewCustomCell
+// wxDataViewCustomRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxDataViewCustomCell: public wxDataViewCell
+class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer

 {
 public:
 {
 public:

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

 
 protected:
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)

 };
 
 };
 

+

 // ---------------------------------------------------------
 // ---------------------------------------------------------

-// wxDataViewTextCell
+// wxDataViewTextRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxDataViewTextCell: public wxDataViewCustomCell
+class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewTextCell( 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 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;

 
 

+    // in-place editing
+    virtual bool HasEditorCtrl();
+    virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
+    virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
+        

 private:
 private:

-    wxString m_text;
+    wxString   m_text;

 
 protected:
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------

-// wxDataViewBitmapCell
+// wxDataViewBitmapRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxDataViewBitmapCell: public wxDataViewCustomCell
+class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer

 {
 public:
 {
 public:

-    wxDataViewBitmapCell( const wxString &varianttype = wxT("wxBitmap"),
-                        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:
     wxIcon m_icon;
     wxBitmap m_bitmap;
 
 protected:
 
 private:
     wxIcon m_icon;
     wxBitmap m_bitmap;
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------

-// wxDataViewToggleCell
+// wxDataViewToggleRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxDataViewToggleCell: public wxDataViewCustomCell
+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 );

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

 
 private:
     bool    m_toggle;
 
 protected:
 
 private:
     bool    m_toggle;
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------

-// wxDataViewProgressCell
+// wxDataViewProgressRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

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

 {
 public:
 {
 public:

-    wxDataViewProgressCell( const wxString &label = wxEmptyString,
-                            const wxString &varianttype = wxT("long"),
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
-    virtual ~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;
 
 protected:
 
 private:
     wxString    m_label;
     int         m_value;
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------

-// wxDataViewDateCell
+// wxDataViewDateRenderer

 // ---------------------------------------------------------
 
 // ---------------------------------------------------------
 

-class WXDLLIMPEXP_ADV wxDataViewDateCell: public wxDataViewCustomCell
+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, unsigned int col, unsigned int row );
+                           wxDataViewModel *model, const wxDataViewItem & item, unsigned int col );

 
 private:
     wxDateTime    m_date;
 
 protected:
 
 private:
     wxDateTime    m_date;
 
 protected:

-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)

 };
 
 // ---------------------------------------------------------
 };
 
 // ---------------------------------------------------------


@@ -213,18 +243,68 @@ protected:
 
 class WXDLLIMPEXP_ADV 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, unsigned int model_column, 
-        int width = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
+    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 );
+    // 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;

 
 

-    virtual int GetWidth();

 
 private:
     int                      m_width;
 
 private:
     int                      m_width;

-    int                      m_fixedWidth;
+    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)


@@ -237,6 +317,12 @@ protected:
 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
                                        public wxScrollHelperNative
 {
 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
                                        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)
     {


@@ -261,21 +347,51 @@ 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 SetSelection( int row ); // -1 for unselect
-    virtual void SetSelectionRange( unsigned int from, unsigned int to );
-    virtual void SetSelections( const wxArrayInt& aSelections);
-    
-    virtual bool IsSelected( unsigned int row ) const;
-    virtual int GetSelection() const;
-    virtual int GetSelections(wxArrayInt& aSelections) const;
+    virtual void DoSetExpanderColumn();
+    virtual void DoSetIndent();
+
+    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 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 SelectAll();
+    virtual void UnselectAll();
+
+    virtual void EnsureVisible( int row );
+    virtual void EnsureVisible( const wxDataViewItem & item, wxDataViewColumn *column = NULL );
+
+    virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
+    virtual int GetRowByItem( const wxDataViewItem & item ) const;
+
+
+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;