removing outdated code

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

diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h
index 3e32fa8ffac9e0d0e7976e3b031d4d1a46206507..9115dcb3ca7d4ea6aff955f5b623d9cac081edf0 100644 (file)
--- a/include/wx/generic/dataview.h
+++ b/include/wx/generic/dataview.h
@@ -17,297 +17,11 @@
 #include "wx/control.h"
 #include "wx/scrolwin.h"
 #include "wx/icon.h"
 #include "wx/control.h"
 #include "wx/scrolwin.h"
 #include "wx/icon.h"

+#include "wx/vector.h"

 
 

-// ---------------------------------------------------------
-// classes
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;

 class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
 class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
 
 class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
 class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
 

-// ---------------------------------------------------------
-// wxDataViewRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
-{
-public:
-    wxDataViewRenderer( const wxString &varianttype,
-                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                        int align = wxDVR_DEFAULT_ALIGNMENT );
-    virtual ~wxDataViewRenderer();
-
-    // these methods are used to draw the cell contents, Render() doesn't care
-    // about the attributes while RenderWithAttr() does -- override it if you
-    // want to take the attributes defined for this cell into account, otherwise
-    // overriding Render() is enough
-    virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
-
-    // NB: RenderWithAttr() also has more standard parameter order and types
-    virtual bool
-    RenderWithAttr(wxDC& dc,
-                   const wxRect& rect,
-                   int align,   // combination of horizontal and vertical
-                   const wxDataViewItemAttr *attr, // may be NULL if none
-                   int state);
-
-    virtual wxSize GetSize() const = 0;
-
-    virtual void SetAlignment( int align );
-    virtual int GetAlignment() const;
-
-    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; }
-
-    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();
-
-    // implementation
-    int CalculateAlignment() const;
-
-private:
-    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 );
-
-    // Draw the text using the provided attributes
-    void RenderText(wxDC& dc,
-                    const wxRect& rect,
-                    int align,
-                    const wxString& text,
-                    const wxDataViewItemAttr *attr, // may be NULL if none
-                    int state,
-                    int xoffset = 0);
-
-    // Overload using standard attributes
-    void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
-};
-
-
-// ---------------------------------------------------------
-// wxDataViewTextRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer
-{
-public:
-    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;
-
-    virtual bool RenderWithAttr(wxDC& dc,
-                                const wxRect& rect,
-                                int align,
-                                const wxDataViewItemAttr *attr,
-                                int state);
-    virtual bool Render(wxRect WXUNUSED(cell),
-                        wxDC * WXUNUSED(dc),
-                        int WXUNUSED(state))
-    {
-        wxFAIL_MSG("only RenderWithAttr() should be called");
-        return false;
-    }
-
-    wxSize GetSize() const;
-
-    // in-place editing
-    virtual bool HasEditorCtrl() const;
-    virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect,
-                                         const wxVariant &value );
-    virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
-
-protected:
-    wxString   m_text;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewBitmapRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
-                              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;
-
-private:
-    wxIcon m_icon;
-    wxBitmap m_bitmap;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewToggleRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
-                              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 );
-    bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item,
-                            unsigned int col );
-    wxSize GetSize() const;
-
-private:
-    bool    m_toggle;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewProgressRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
-{
-public:
-    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 GetValue( wxVariant& value ) const;
-
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-
-private:
-    wxString    m_label;
-    int         m_value;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewIconTextRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
-                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                                int align = wxDVR_DEFAULT_ALIGNMENT );
-    virtual ~wxDataViewIconTextRenderer();
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant &value ) const;
-
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-
-    virtual bool HasEditorCtrl() const { return true; }
-    virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect,
-                                         const wxVariant &value );
-    virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
-
-private:
-    wxDataViewIconText   m_value;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
-};
-
-// ---------------------------------------------------------
-// wxDataViewDateRenderer
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
-{
-public:
-    wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
-                            wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
-                            int align = wxDVR_DEFAULT_ALIGNMENT );
-
-    bool SetValue( const wxVariant &value );
-    bool GetValue( wxVariant& value ) const;
-
-    virtual bool Render( wxRect cell, wxDC *dc, int state );
-    virtual wxSize GetSize() const;
-    virtual bool Activate( wxRect cell,
-                           wxDataViewModel *model,
-                           const wxDataViewItem& item,
-                           unsigned int col );
-
-private:
-    wxDateTime    m_date;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
-};
-

 // ---------------------------------------------------------
 // wxDataViewColumn
 // ---------------------------------------------------------
 // ---------------------------------------------------------
 // wxDataViewColumn
 // ---------------------------------------------------------


@@ -339,38 +53,37 @@ public:
     }
 
     // implement wxHeaderColumnBase methods
     }
 
     // implement wxHeaderColumnBase methods

-    virtual void SetTitle(const wxString& title) { m_title = title; }
+    virtual void SetTitle(const wxString& title) { m_title = title; UpdateDisplay(); }

     virtual wxString GetTitle() const { return m_title; }
 
     virtual wxString GetTitle() const { return m_title; }
 

-    virtual void SetWidth(int width) { m_width = width; }
-    virtual int GetWidth() const { return m_width; }
+    virtual void SetWidth(int width) { m_width = width; UpdateDisplay(); }
+    virtual int GetWidth() const;

 
 

-    virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; }
+    virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; UpdateDisplay(); }

     virtual int GetMinWidth() const { return m_minWidth; }
 
     virtual int GetMinWidth() const { return m_minWidth; }
 

-    virtual void SetAlignment(wxAlignment align) { m_align = align; }
+    virtual void SetAlignment(wxAlignment align) { m_align = align; UpdateDisplay(); }

     virtual wxAlignment GetAlignment() const { return m_align; }
 
     virtual wxAlignment GetAlignment() const { return m_align; }
 

-    virtual void SetFlags(int flags) { m_flags = flags; }
+    virtual void SetFlags(int flags) { m_flags = flags; UpdateDisplay(); }

     virtual int GetFlags() const { return m_flags; }
 
     virtual int GetFlags() const { return m_flags; }
 

-    virtual void SetAsSortKey(bool sort = true) { m_sort = sort; }

     virtual bool IsSortKey() const { return m_sort; }
 
     virtual bool IsSortKey() const { return m_sort; }
 

-    virtual void SetSortOrder(bool ascending) { m_sortAscending = ascending; }
+    virtual void UnsetAsSortKey() { m_sort = false; UpdateDisplay(); }
+
+    virtual void SetSortOrder(bool ascending);
+

     virtual bool IsSortOrderAscending() const { return m_sortAscending; }
 
     virtual bool IsSortOrderAscending() const { return m_sortAscending; }
 

+    virtual void SetBitmap( const wxBitmap& bitmap ) { wxDataViewColumnBase::SetBitmap(bitmap); UpdateDisplay(); }
+
+

 private:
     // common part of all ctors
 private:
     // common part of all ctors

-    void Init(int width, wxAlignment align, int flags)
-    {
-        m_width = width == wxCOL_WIDTH_DEFAULT ? wxDVC_DEFAULT_WIDTH : width;
-        m_minWidth = 0;
-        m_align = align;
-        m_flags = flags;
-        m_sort = false;
-        m_sortAscending = true;
-    }
+    void Init(int width, wxAlignment align, int flags);
+
+    void UpdateDisplay();

 
     wxString m_title;
     int m_width,
 
     wxString m_title;
     int m_width,


@@ -410,10 +123,11 @@ public:
     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,
+           const wxString& name = wxDataViewCtrlNameStr )

              : wxScrollHelper(this)
     {
              : wxScrollHelper(this)
     {

-        Create(parent, id, pos, size, style, validator );
+        Create(parent, id, pos, size, style, validator, name);

     }
 
     virtual ~wxDataViewCtrl();
     }
 
     virtual ~wxDataViewCtrl();


@@ -423,7 +137,8 @@ public:
     bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize, long style = 0,
     bool Create(wxWindow *parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize, long style = 0,

-                const wxValidator& validator = wxDefaultValidator );
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxDataViewCtrlNameStr);

 
     virtual bool AssociateModel( wxDataViewModel *model );
 
 
     virtual bool AssociateModel( wxDataViewModel *model );
 


@@ -442,7 +157,7 @@ public:
 
     virtual wxDataViewColumn *GetSortingColumn() const;
 
 
     virtual wxDataViewColumn *GetSortingColumn() const;
 

-    virtual wxDataViewItem GetSelection() const;
+    virtual int GetSelectedItemsCount() const;

     virtual int GetSelections( wxDataViewItemArray & sel ) const;
     virtual void SetSelections( const wxDataViewItemArray & sel );
     virtual void Select( const wxDataViewItem & item );
     virtual int GetSelections( wxDataViewItemArray & sel ) const;
     virtual void SetSelections( const wxDataViewItemArray & sel );
     virtual void Select( const wxDataViewItem & item );


@@ -459,6 +174,8 @@ public:
     virtual wxRect GetItemRect( const wxDataViewItem & item,
                                 const wxDataViewColumn *column = NULL ) const;
 
     virtual wxRect GetItemRect( const wxDataViewItem & item,
                                 const wxDataViewColumn *column = NULL ) const;
 

+    virtual bool SetRowHeight( int rowHeight );
+

     virtual void Expand( const wxDataViewItem & item );
     virtual void Collapse( const wxDataViewItem & item );
     virtual bool IsExpanded( const wxDataViewItem & item ) const;
     virtual void Expand( const wxDataViewItem & item );
     virtual void Collapse( const wxDataViewItem & item );
     virtual bool IsExpanded( const wxDataViewItem & item ) const;


@@ -472,19 +189,18 @@ public:
 
     virtual wxBorder GetDefaultBorder() const;
 
 
     virtual wxBorder GetDefaultBorder() const;
 

-    void StartEditor( const wxDataViewItem & item, unsigned int column );
+    virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);

 
 

-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 );
+    // These methods are specific to generic wxDataViewCtrl implementation and
+    // should not be used in portable code.
+    wxColour GetAlternateRowColour() const { return m_alternateRowColour; }
+    void SetAlternateRowColour(const wxColour& colour);

 
 

+protected:

     virtual void EnsureVisible( int row, int column );
 
     virtual void EnsureVisible( int row, int column );
 

+    // Notice that row here may be invalid (i.e. >= GetRowCount()), this is not
+    // an error and this function simply returns an invalid item in this case.

     virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
     virtual int GetRowByItem( const wxDataViewItem & item ) const;
 
     virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
     virtual int GetRowByItem( const wxDataViewItem & item ) const;
 


@@ -494,10 +210,7 @@ protected:
 public:     // utility functions not part of the API
 
     // returns the "best" width for the idx-th 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();
-    }
+    unsigned int GetBestColumnWidth(int idx) const;

 
     // called by header window after reorder
     void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
 
     // called by header window after reorder
     void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );


@@ -516,12 +229,40 @@ public:     // utility functions not part of the API
     // return the column displayed at the given position in the control
     wxDataViewColumn *GetColumnAt(unsigned int pos) const;
 
     // return the column displayed at the given position in the control
     wxDataViewColumn *GetColumnAt(unsigned int pos) const;
 

+    virtual wxDataViewColumn *GetCurrentColumn() const;
+
+    virtual void OnInternalIdle();
+

 private:
 private:

+    virtual wxDataViewItem DoGetCurrentItem() const;
+    virtual void DoSetCurrentItem(const wxDataViewItem& item);
+
+    void InvalidateColBestWidths();
+    void InvalidateColBestWidth(int idx);
+    void UpdateColWidths();
+

     wxDataViewColumnList      m_cols;
     wxDataViewColumnList      m_cols;

+    // cached column best widths information, values are for
+    // respective columns from m_cols and the arrays have same size
+    struct CachedColWidthInfo
+    {
+        CachedColWidthInfo() : width(0), dirty(true) {}
+        int width;  // cached width or 0 if not computed
+        bool dirty; // column was invalidated, header needs updating
+    };
+    wxVector<CachedColWidthInfo> m_colsBestWidths;
+    // This indicates that at least one entry in m_colsBestWidths has 'dirty'
+    // flag set. It's cheaper to check one flag in OnInternalIdle() than to
+    // iterate over m_colsBestWidths to check if anything needs to be done.
+    bool                      m_colsDirty;
+

     wxDataViewModelNotifier  *m_notifier;
     wxDataViewMainWindow     *m_clientArea;
     wxDataViewHeaderWindow   *m_headerArea;
 
     wxDataViewModelNotifier  *m_notifier;
     wxDataViewMainWindow     *m_clientArea;
     wxDataViewHeaderWindow   *m_headerArea;
 

+    // user defined color to draw row lines, may be invalid
+    wxColour m_alternateRowColour;
+

     // the index of the column currently used for sorting or -1
     int m_sortingColumnIdx;
 
     // the index of the column currently used for sorting or -1
     int m_sortingColumnIdx;