Replace wxDataViewCtrl::StartEditor() with EditItem().

This is more consistent with other wxDVC methods (taking column pointer
as its argument) and other DVC-like classes where the name EditLabel()
is used for similar purposes.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70377 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/dataview.h b/include/wx/dataview.h
index 0575611829ba3f8b9c8f7d355ee2f49d2f1b979d..ba69d16a7decb49cdb641dec4998319d162ec999 100644 (file)
--- a/include/wx/dataview.h
+++ b/include/wx/dataview.h
@@ -701,9 +701,10 @@ public:
 
     virtual bool SetRowHeight( int WXUNUSED(rowHeight) ) { return false; }
 
-    virtual void StartEditor( const wxDataViewItem & WXUNUSED(item),
-                              unsigned int WXUNUSED(column) )
-        { }
+    virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column) = 0;
+
+    // Use EditItem() instead
+    wxDEPRECATED( void StartEditor(const wxDataViewItem& item, unsigned int column) );
 
 #if wxUSE_DRAG_AND_DROP
     virtual bool EnableDragSource(const wxDataFormat& WXUNUSED(format))

diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h
index b6f643055fea9a340b001f42519bf54322d1712a..32e7723fd97d9a53cb34946785c7ea2cc8c45049 100644 (file)
--- a/include/wx/generic/dataview.h
+++ b/include/wx/generic/dataview.h
@@ -189,7 +189,7 @@ public:
 
     virtual wxBorder GetDefaultBorder() const;
 
-    virtual void StartEditor( const wxDataViewItem & item, unsigned int column );
+    virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
 
 protected:
     virtual void EnsureVisible( int row, int column );

diff --git a/include/wx/gtk/dataview.h b/include/wx/gtk/dataview.h
index a10d89495a27d5cd62628f324a2caf42f1869369..fad45a6b48dd8d584bae722b8e9f7b93dd11b24f 100644 (file)
--- a/include/wx/gtk/dataview.h
+++ b/include/wx/gtk/dataview.h
@@ -160,7 +160,7 @@ public:
 
     virtual bool SetRowHeight( int rowHeight );
 
-    virtual void StartEditor( const wxDataViewItem & item, unsigned int column );
+    virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
 
     virtual void Expand( const wxDataViewItem & item );
     virtual void Collapse( const wxDataViewItem & item );

diff --git a/include/wx/osx/dataview.h b/include/wx/osx/dataview.h
index 752939765c1421ec8edbf8d5ee0f9ed2f6e81c45..5962127d7b10c2f866bd8d47939c5bcd43ac08d3 100644 (file)
--- a/include/wx/osx/dataview.h
+++ b/include/wx/osx/dataview.h
@@ -201,7 +201,7 @@ public:
  // finishes editing of custom items; if no custom item is currently edited the method does nothing
   void FinishCustomItemEditing();
   
-  virtual void StartEditor( const wxDataViewItem & item, unsigned int column );
+  virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
 
  // returns the n-th pointer to a column;
  // this method is different from GetColumn(unsigned int pos) because here 'n' is not a position in the control but the n-th

diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h
index f7bf4a2afc607882e5d7a981911e825290fc412f..c193002f53c84dfeec53366bb16cb99f788fdb5e 100644 (file)
--- a/interface/wx/dataview.h
+++ b/interface/wx/dataview.h
@@ -997,6 +997,17 @@ public:
     */
     virtual bool DeleteColumn(wxDataViewColumn* column);
 
+    /**
+        Programmatically starts editing given cell of @a item.
+
+        Doesn't do anything if the item or this column is not editable.
+
+        @note Currently not implemented in wxOSX/Carbon.
+
+        @since 2.9.4
+    */
+    virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
+
     /**
        Enable drag operations using the given @a format.
     */
@@ -1213,14 +1224,6 @@ public:
     */
     virtual void SetSelections(const wxDataViewItemArray& sel);
 
-    /** 
-        Programmatically starts editing the given item on the given column.
-        Currently not implemented on wxOSX Carbon.
-        @since 2.9.2
-    */
-    
-    virtual void StartEditor(const wxDataViewItem & item, unsigned int column);
-
     /**
         Unselect the given item.
     */

diff --git a/src/common/datavcmn.cpp b/src/common/datavcmn.cpp
index ae7dcd404327a6c6b74fbe7081f0b4948eb2c0c5..6dcf50fb56e2e33c43cb2983081ba81b48c8edbb 100644 (file)
--- a/src/common/datavcmn.cpp
+++ b/src/common/datavcmn.cpp
@@ -1418,6 +1418,11 @@ wxDataViewCtrlBase::InsertColumn( unsigned int WXUNUSED(pos), wxDataViewColumn *
     return true;
 }
 
+void wxDataViewCtrlBase::StartEditor(const wxDataViewItem& item, unsigned int column)
+{
+    EditItem(item, GetColumn(column));
+}
+
 // ---------------------------------------------------------
 // wxDataViewEvent
 // ---------------------------------------------------------

diff --git a/src/generic/datavgen.cpp b/src/generic/datavgen.cpp
index a4a55c65a1a875b8d22905694ea0f251d101712f..5fd5797d8cdf44cc9a49f3d0b8356eff3e22ebc0 100644 (file)
--- a/src/generic/datavgen.cpp
+++ b/src/generic/datavgen.cpp
@@ -3599,7 +3599,7 @@ void wxDataViewMainWindow::OnChar( wxKeyEvent &event )
                     wxDataViewColumn *editableCol = FindColumnForEditing(item, wxDATAVIEW_CELL_EDITABLE);
 
                     if ( editableCol )
-                        GetOwner()->StartEditor(item, GetOwner()->GetColumnIndex(editableCol));
+                        GetOwner()->EditItem(item, editableCol);
                 }
             }
             break;
@@ -5021,13 +5021,12 @@ bool wxDataViewCtrl::IsExpanded( const wxDataViewItem & item ) const
     return false;
 }
 
-void wxDataViewCtrl::StartEditor( const wxDataViewItem & item, unsigned int column )
+void wxDataViewCtrl::EditItem(const wxDataViewItem& item, const wxDataViewColumn *column)
 {
-    wxDataViewColumn* col = GetColumn( column );
-    if (!col)
-        return;
+    wxCHECK_RET( item.IsOk(), "invalid item" );
+    wxCHECK_RET( column, "no column provided" );
 
-    m_clientArea->StartEditing(item, col);
+    m_clientArea->StartEditing(item, column);
 }
 
 #endif // !wxUSE_GENERICDATAVIEWCTRL

diff --git a/src/gtk/dataview.cpp b/src/gtk/dataview.cpp
index dd11509d67a7e2c071982b861499eb333332cd28..ffbea2a9a16063d6599f27f67c11424398867aa6 100644 (file)
--- a/src/gtk/dataview.cpp
+++ b/src/gtk/dataview.cpp
@@ -4853,18 +4853,18 @@ wxDataViewColumn *wxDataViewCtrl::GetCurrentColumn() const
     return FromGTKColumn(col);
 }
 
-void wxDataViewCtrl::StartEditor(const wxDataViewItem& item, unsigned int column)
+void wxDataViewCtrl::EditItem(const wxDataViewItem& item, const wxDataViewColumn *column)
 {
     wxCHECK_RET( m_treeview,
                  "Current item can't be set before creating the control." );
+    wxCHECK_RET( item.IsOk(), "invalid item" );
+    wxCHECK_RET( column, "no column provided" );
 
     // We need to make sure the model knows about this item or the path would
     // be invalid and gtk_tree_view_set_cursor() would silently do nothing.
     ExpandAncestors(item);
-    
-    wxDataViewColumn *dvcolumn = GetColumn(column);
-    wxASSERT_MSG(dvcolumn, "Could not retrieve column");
-    GtkTreeViewColumn *gcolumn = GTK_TREE_VIEW_COLUMN(dvcolumn->GetGtkHandle());
+
+    GtkTreeViewColumn *gcolumn = GTK_TREE_VIEW_COLUMN(column->GetGtkHandle());
 
     // We also need to preserve the existing selection from changing.
     // Unfortunately the only way to do it seems to use our own selection

diff --git a/src/osx/dataview_osx.cpp b/src/osx/dataview_osx.cpp
index ecbf403f6bc5843139fb4b925de5213311e5cb63..05ad19fcbee1e03fb45b255f550b36e71590bb2c 100644 (file)
--- a/src/osx/dataview_osx.cpp
+++ b/src/osx/dataview_osx.cpp
@@ -635,9 +635,9 @@ void wxDataViewCtrl::AddChildren(wxDataViewItem const& parentItem)
   (void) GetModel()->ItemsAdded(parentItem,items);
 }
 
-void wxDataViewCtrl::StartEditor( const wxDataViewItem & item, unsigned int column )
+void wxDataViewCtrl::EditItem(const wxDataViewItem& item, const wxDataViewColumn *column)
 {
-    GetDataViewPeer()->StartEditor(item, column);
+    GetDataViewPeer()->StartEditor(item, GetColumnPosition(column));
 }
 
 void wxDataViewCtrl::FinishCustomItemEditing()