]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/dataview.h
add support for sorting to grid columns
[wxWidgets.git] / include / wx / generic / dataview.h
index 136d7b944b45db14d504f60a9aa01353b67f7ba8..db9202eea9e084c4d9c1cfcb4830049843f607d6 100644 (file)
@@ -33,7 +33,7 @@ class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
 class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
 {
 public:
-    wxDataViewRenderer( const wxString &varianttype, 
+    wxDataViewRenderer( const wxString &varianttype,
                         wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
                         int align = wxDVR_DEFAULT_ALIGNMENT );
     virtual ~wxDataViewRenderer();
@@ -41,10 +41,8 @@ public:
     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
     virtual wxSize GetSize() const = 0;
 
-    virtual void SetAlignment( int align )
-        { m_align=align; }
-    virtual int GetAlignment() const
-        { return m_align; }
+    virtual void SetAlignment( int align );
+    virtual int GetAlignment() const;
 
     virtual void SetMode( wxDataViewCellMode mode )
         { m_mode=mode; }
@@ -53,37 +51,49 @@ public:
 
     virtual bool Activate( wxRect WXUNUSED(cell),
                            wxDataViewModel *WXUNUSED(model),
-                           const wxDataViewItem & WXUNUSED(item), 
+                           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), 
+                            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), 
+                             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), 
+                            const wxDataViewItem & WXUNUSED(item),
                             unsigned int WXUNUSED(col) )
                             { return false; }
 
     // Create DC on request
     virtual wxDC *GetDC();
 
+    void SetHasAttr( bool set )  { m_hasAttr = set; }
+    void SetAttr( const wxDataViewItemAttr &attr ) { m_attr = attr; }
+    bool GetWantsAttr() { return m_wantsAttr; }
+
+    // implementation
+    int CalculateAlignment() const;
+
 private:
     wxDC                        *m_dc;
     int                          m_align;
     wxDataViewCellMode           m_mode;
 
+protected:
+    bool                         m_wantsAttr;
+    bool                         m_hasAttr;
+    wxDataViewItemAttr           m_attr;
+
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
 };
@@ -99,6 +109,8 @@ public:
                               wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
                               int align = wxDVR_DEFAULT_ALIGNMENT );
 
+    void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
+
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
 };
@@ -125,14 +137,31 @@ public:
     virtual bool HasEditorCtrl();
     virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
     virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
-        
-private:
+
+protected:
     wxString   m_text;
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
 };
 
+// ---------------------------------------------------------
+// wxDataViewTextRendererAttr
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewTextRendererAttr: public wxDataViewTextRenderer
+{
+public:
+    wxDataViewTextRendererAttr( const wxString &varianttype = wxT("string"),
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                            int align = wxDVR_DEFAULT_ALIGNMENT );
+
+    bool Render( wxRect cell, wxDC *dc, int state );
+
+protected:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRendererAttr)
+};
+
 // ---------------------------------------------------------
 // wxDataViewBitmapRenderer
 // ---------------------------------------------------------
@@ -173,7 +202,7 @@ public:
     bool GetValue( wxVariant &value ) const;
 
     bool Render( wxRect cell, wxDC *dc, int state );
-    bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item, 
+    bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item,
                             unsigned int col );
     wxSize GetSize() const;
 
@@ -211,6 +240,35 @@ 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() { 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
 // ---------------------------------------------------------
@@ -241,79 +299,86 @@ protected:
 // wxDataViewColumn
 // ---------------------------------------------------------
 
-class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
+class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase
 {
-    friend class wxDataViewHeaderWindowBase;
-    friend class wxDataViewHeaderWindow;
-    friend class wxDataViewHeaderWindowMSW;
-
 public:
-    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();
-
-    // 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;
+    wxDataViewColumn(const wxString& title,
+                     wxDataViewRenderer *renderer,
+                     unsigned int model_column,
+                     int width = wxDVC_DEFAULT_WIDTH,
+                     wxAlignment align = wxALIGN_CENTER,
+                     int flags = wxDATAVIEW_COL_RESIZABLE)
+        : wxDataViewColumnBase(renderer, model_column),
+          m_title(title)
+    {
+        Init(width, align, flags);
+    }
 
+    wxDataViewColumn(const wxBitmap& bitmap,
+                     wxDataViewRenderer *renderer,
+                     unsigned int model_column,
+                     int width = wxDVC_DEFAULT_WIDTH,
+                     wxAlignment align = wxALIGN_CENTER,
+                     int flags = wxDATAVIEW_COL_RESIZABLE)
+        : wxDataViewColumnBase(bitmap, renderer, model_column)
+    {
+        Init(width, align, flags);
+    }
 
-private:
-    int                      m_width;
-    int                      m_minWidth;
-    int                      m_flags;
-    wxAlignment              m_align;
-    wxString                 m_title;
-    bool                     m_ascending;
+    // implement wxHeaderColumnBase methods
+    virtual void SetTitle(const wxString& title) { m_title = title; }
+    virtual wxString GetTitle() const { return m_title; }
 
-    void Init(int width);
+    virtual void SetWidth(int width) { m_width = width; }
+    virtual int GetWidth() const { return m_width; }
 
-    // like SetWidth() but does not ask the header window of the
-    // wxDataViewCtrl to reflect the width-change.
-    void SetInternalWidth(int width);
+    virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; }
+    virtual int GetMinWidth() const { return m_minWidth; }
 
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
+    virtual void SetAlignment(wxAlignment align) { m_align = align; }
+    virtual wxAlignment GetAlignment() const { return m_align; }
+
+    virtual void SetFlags(int flags) { m_flags = 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 void SetSortOrder(bool ascending) { m_sortAscending = ascending; }
+    virtual bool IsSortOrderAscending() const { return m_sortAscending; }
+
+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;
+    }
+
+    wxString m_title;
+    int m_width,
+        m_minWidth;
+    wxAlignment m_align;
+    int m_flags;
+    bool m_sort,
+         m_sortAscending;
+
+    friend class wxDataViewHeaderWindowBase;
+    friend class wxDataViewHeaderWindow;
+    friend class wxDataViewHeaderWindowMSW;
 };
 
 // ---------------------------------------------------------
 // wxDataViewCtrl
 // ---------------------------------------------------------
 
+WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
+                          class WXDLLIMPEXP_ADV);
+
 class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
                                        public wxScrollHelperNative
 {
@@ -326,7 +391,6 @@ class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
 public:
     wxDataViewCtrl() : wxScrollHelperNative(this)
     {
-        m_sortingColumn = 0;
         Init();
     }
 
@@ -349,11 +413,22 @@ public:
            const wxValidator& validator = wxDefaultValidator );
 
     virtual bool AssociateModel( wxDataViewModel *model );
+
     virtual bool AppendColumn( wxDataViewColumn *col );
+    virtual bool PrependColumn( wxDataViewColumn *col );
+    virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 
     virtual void DoSetExpanderColumn();
     virtual void DoSetIndent();
 
+    virtual unsigned int GetColumnCount() const;
+    virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
+    virtual bool DeleteColumn( wxDataViewColumn *column );
+    virtual bool ClearColumns();
+    virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
+
+    virtual wxDataViewColumn *GetSortingColumn() const;
+
     virtual wxDataViewItem GetSelection() const;
     virtual int GetSelections( wxDataViewItemArray & sel ) const;
     virtual void SetSelections( const wxDataViewItemArray & sel );
@@ -369,8 +444,13 @@ public:
     virtual void HitTest( const wxPoint & point, wxDataViewItem & item, wxDataViewColumn* &column ) const;
     virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const;
 
+    virtual void Expand( const wxDataViewItem & item );
+    virtual void Collapse( const wxDataViewItem & item );
+
+    virtual void SetFocus();
+
 protected:
-    virtual int GetSelections( wxArrayInt & sel ) const; 
+    virtual int GetSelections( wxArrayInt & sel ) const;
     virtual void SetSelections( const wxArrayInt & sel );
     virtual void Select( int row );
     virtual void Unselect( int row );
@@ -383,8 +463,8 @@ protected:
     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; }
+    int GetSortingColumnIndex() const { return m_sortingColumnIdx; }
+    void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; }
 
 public:     // utility functions not part of the API
 
@@ -394,19 +474,35 @@ public:     // utility functions not part of the API
         return GetClientSize().GetWidth() / GetColumnCount();
     }
 
-    // updates the header window after a change in a column setting
-    void OnColumnChange();
+    // called by header window after reorder
+    void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
+
+    // update the display after a change to an individual column
+    void OnColumnChange(unsigned int idx);
+
+    // update after a change to the number of columns
+    void OnColumnsCountChanged();
 
     wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
 
+    // return the index of the given column in m_cols
+    int GetColumnIndex(const wxDataViewColumn *column) const;
+
+    // return the column displayed at the given position in the control
+    wxDataViewColumn *GetColumnAt(unsigned int pos) const;
+
 private:
-    wxDataViewModelNotifier *m_notifier;
-    wxDataViewMainWindow        *m_clientArea;
-    wxDataViewHeaderWindow      *m_headerArea;
-    unsigned int m_sortingColumn;
+    wxDataViewColumnList      m_cols;
+    wxDataViewModelNotifier  *m_notifier;
+    wxDataViewMainWindow     *m_clientArea;
+    wxDataViewHeaderWindow   *m_headerArea;
+
+    // the index of the column currently used for sorting or -1
+    int m_sortingColumnIdx;
 
 private:
     void OnSize( wxSizeEvent &event );
+    virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
 
     // we need to return a special WM_GETDLGCODE value to process just the
     // arrows but let the other navigation characters through