Extend history api using the ie backend to include loading history items, and getting...

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

diff --git a/include/wx/dataview.h b/include/wx/dataview.h
index b220665ddf9901b501b07be6efff8c93bbd732c5..540babf79f11b7fc99096cabd164757a161744ca 100644 (file)
--- a/include/wx/dataview.h
+++ b/include/wx/dataview.h
@@ -126,6 +126,10 @@ public:
     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
     virtual bool Cleared() = 0;
 
     virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
     virtual bool Cleared() = 0;
 

+    // some platforms, such as GTK+, may need a two step procedure for ::Reset()
+    virtual bool BeforeReset() { return true; }
+    virtual bool AfterReset() { return Cleared(); }
+

     virtual void Resort() = 0;
 
     void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
     virtual void Resort() = 0;
 
     void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }


@@ -168,6 +172,9 @@ public:
 
     bool IsDefault() const { return !(HasColour() || HasFont()); }
 
 
     bool IsDefault() const { return !(HasColour() || HasFont()); }
 

+    // Return the font based on the given one with this attribute applied to it.
+    wxFont GetEffectiveFont(const wxFont& font) const;
+

 private:
     wxColour m_colour;
     bool     m_bold;
 private:
     wxColour m_colour;
     bool     m_bold;


@@ -227,6 +234,13 @@ public:
         return false;
     }
 
         return false;
     }
 

+    // Override this if you want to disable specific items
+    virtual bool IsEnabled(const wxDataViewItem &WXUNUSED(item),
+                           unsigned int WXUNUSED(col)) const
+    {
+        return true;
+    }
+

     // define hierachy
     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
     virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
     // define hierachy
     virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
     virtual bool IsContainer( const wxDataViewItem &item ) const = 0;


@@ -245,7 +259,12 @@ public:
     bool ValueChanged( const wxDataViewItem &item, unsigned int col );
     bool Cleared();
 
     bool ValueChanged( const wxDataViewItem &item, unsigned int col );
     bool Cleared();
 

-    // delegatd action
+    // some platforms, such as GTK+, may need a two step procedure for ::Reset()
+    bool BeforeReset();
+    bool AfterReset();
+
+
+    // delegated action

     virtual void Resort();
 
     void AddNotifier( wxDataViewModelNotifier *notifier );
     virtual void Resort();
 
     void AddNotifier( wxDataViewModelNotifier *notifier );


@@ -257,6 +276,7 @@ public:
     virtual bool HasDefaultCompare() const { return false; }
 
     // internal
     virtual bool HasDefaultCompare() const { return false; }
 
     // internal

+    virtual bool IsListModel() const { return false; }

     virtual bool IsVirtualListModel() const { return false; }
 
 protected:
     virtual bool IsVirtualListModel() const { return false; }
 
 protected:


@@ -291,10 +311,18 @@ public:
         return false;
     }
 
         return false;
     }
 

+    virtual bool IsEnabledByRow(unsigned int WXUNUSED(row),
+                                unsigned int WXUNUSED(col)) const
+    {
+        return true;
+    }
+

 
     // helper methods provided by list models only
     virtual unsigned GetRow( const wxDataViewItem &item ) const = 0;
 
 
     // helper methods provided by list models only
     virtual unsigned GetRow( const wxDataViewItem &item ) const = 0;
 

+    // returns the number of rows
+    virtual unsigned int GetCount() const = 0;

 
     // implement some base class pure virtual directly
     virtual wxDataViewItem
 
     // implement some base class pure virtual directly
     virtual wxDataViewItem


@@ -328,6 +356,14 @@ public:
     {
         return GetAttrByRow( GetRow(item), col, attr );
     }
     {
         return GetAttrByRow( GetRow(item), col, attr );
     }

+
+    virtual bool IsEnabled(const wxDataViewItem &item, unsigned int col) const
+    {
+        return IsEnabledByRow( GetRow(item), col );
+    }
+
+
+    virtual bool IsListModel() const { return true; }

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


@@ -639,6 +675,12 @@ public:
     int GetIndent() const
         { return m_indent; }
 
     int GetIndent() const
         { return m_indent; }
 

+    // Current item is the one used by the keyboard navigation, it is the same
+    // as the (unique) selected item in single selection mode so these
+    // functions are mostly useful for controls with wxDV_MULTIPLE style.
+    wxDataViewItem GetCurrentItem() const;
+    void SetCurrentItem(const wxDataViewItem& item);
+

     virtual wxDataViewItem GetSelection() const = 0;
     virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
     virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
     virtual wxDataViewItem GetSelection() const = 0;
     virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
     virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;


@@ -685,6 +727,12 @@ protected:
     virtual void DoSetIndent() = 0;
 
 private:
     virtual void DoSetIndent() = 0;
 
 private:

+    // Implementation of the public Set/GetCurrentItem() methods which are only
+    // called in multi selection case (for single selection controls their
+    // implementation is trivial and is done in the base class itself).
+    virtual wxDataViewItem DoGetCurrentItem() const = 0;
+    virtual void DoSetCurrentItem(const wxDataViewItem& item) = 0;
+

     wxDataViewModel        *m_model;
     wxDataViewColumn       *m_expander_column;
     int m_indent ;
     wxDataViewModel        *m_model;
     wxDataViewColumn       *m_expander_column;
     int m_indent ;


@@ -724,7 +772,7 @@ public:
         m_model(event.m_model),
         m_value(event.m_value),
         m_column(event.m_column),
         m_model(event.m_model),
         m_value(event.m_value),
         m_column(event.m_column),

-        m_pos(m_pos),
+        m_pos(event.m_pos),

         m_cacheFrom(event.m_cacheFrom),
         m_cacheTo(event.m_cacheTo)
 #if wxUSE_DRAG_AND_DROP
         m_cacheFrom(event.m_cacheFrom),
         m_cacheTo(event.m_cacheTo)
 #if wxUSE_DRAG_AND_DROP


@@ -950,6 +998,20 @@ public:
     const wxDataViewListStore *GetStore() const
         { return (const wxDataViewListStore*) GetModel(); }
 
     const wxDataViewListStore *GetStore() const
         { return (const wxDataViewListStore*) GetModel(); }
 

+    int ItemToRow(const wxDataViewItem &item) const
+        { return item.IsOk() ? (int)GetStore()->GetRow(item) : wxNOT_FOUND; }
+    wxDataViewItem RowToItem(int row) const
+        { return row == wxNOT_FOUND ? wxDataViewItem() : GetStore()->GetItem(row); }
+
+    int GetSelectedRow() const
+        { return ItemToRow(GetSelection()); }
+    void SelectRow(unsigned row)
+        { Select(RowToItem(row)); }
+    void UnselectRow(unsigned row)
+        { Unselect(RowToItem(row)); }
+    bool IsRowSelected(unsigned row) const
+        { return IsSelected(RowToItem(row)); }
+

     bool AppendColumn( wxDataViewColumn *column, const wxString &varianttype );
     bool PrependColumn( wxDataViewColumn *column, const wxString &varianttype );
     bool InsertColumn( unsigned int pos, wxDataViewColumn *column, const wxString &varianttype );
     bool AppendColumn( wxDataViewColumn *column, const wxString &varianttype );
     bool PrependColumn( wxDataViewColumn *column, const wxString &varianttype );
     bool InsertColumn( unsigned int pos, wxDataViewColumn *column, const wxString &varianttype );


@@ -1110,7 +1172,7 @@ public:
 
     wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
     int GetChildCount( const wxDataViewItem& parent ) const;
 
     wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
     int GetChildCount( const wxDataViewItem& parent ) const;

-    
+

     void SetItemText( const wxDataViewItem& item, const wxString &text );
     wxString GetItemText( const wxDataViewItem& item ) const;
     void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
     void SetItemText( const wxDataViewItem& item, const wxString &text );
     wxString GetItemText( const wxDataViewItem& item ) const;
     void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );