From a400a380f28cfd8c60c5a230911112b87b652e2e Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 28 Jun 2020 01:47:06 +0200
Subject: [PATCH] Add wxGrid::DoEnableCellEditControl() with bool return value

Checking the new function return value is simpler than checking the
value of m_cellEditCtrlEnabled after calling EnableCellEditControl().

Do this now also when starting editing using the mouse, as it was simply
forgotten before and so StartingClick() was still called even if editing
was vetoed.

Also add DoDisableCellEditControl(), but this one exists purely for the
symmetry.
---
 include/wx/generic/grid.h |  8 +++++++
 src/generic/grid.cpp      | 46 +++++++++++++++++++++++----------------
 2 files changed, 35 insertions(+), 19 deletions(-)

diff --git a/include/wx/generic/grid.h b/include/wx/generic/grid.h
index 4088a3eb73..40c8e74bc4 100644
--- a/include/wx/generic/grid.h
+++ b/include/wx/generic/grid.h
@@ -2912,6 +2912,14 @@ private:
     void DoShowCellEditControl();
     void DoHideCellEditControl();
 
+    // Unconditionally try showing the editor for the current cell.
+    //
+    // Returns false if the user code vetoed wxEVT_GRID_EDITOR_SHOWN.
+    bool DoEnableCellEditControl();
+
+    // Unconditionally disable (accepting the changes) the editor.
+    void DoDisableCellEditControl();
+
     // Accept the changes in the edit control, i.e. save them to the table and
     // dismiss the editor. Also reset m_cellEditCtrlEnabled.
     void DoAcceptCellEditControl();
diff --git a/src/generic/grid.cpp b/src/generic/grid.cpp
index c6beb5c655..64568ea787 100644
--- a/src/generic/grid.cpp
+++ b/src/generic/grid.cpp
@@ -4657,9 +4657,9 @@ wxGrid::DoGridCellLeftUp(wxMouseEvent& event,
         if ( coords == m_currentCellCoords && m_waitForSlowClick && CanEnableCellControl() )
         {
             ClearSelection();
-            EnableCellEditControl();
 
-            GetCurrentCellEditorPtr()->StartingClick();
+            if ( DoEnableCellEditControl() )
+                GetCurrentCellEditorPtr()->StartingClick();
 
             m_waitForSlowClick = false;
         }
@@ -5968,18 +5968,14 @@ void wxGrid::OnChar( wxKeyEvent& event )
 
         // <F2> is special and will always start editing, for
         // other keys - ask the editor itself
-        if ( (event.GetKeyCode() == WXK_F2 && !event.HasModifiers())
-             || editor->IsAcceptedKey(event) )
+        const bool specialEditKey = event.GetKeyCode() == WXK_F2 &&
+                                        !event.HasModifiers();
+        if ( specialEditKey || editor->IsAcceptedKey(event) )
         {
             // ensure cell is visble
             MakeCellVisible(m_currentCellCoords);
-            EnableCellEditControl();
 
-            // a problem can arise if the cell is not completely
-            // visible (even after calling MakeCellVisible the
-            // control is not created and calling StartingKey will
-            // crash the app
-            if ( event.GetKeyCode() != WXK_F2 && editor->IsCreated() && m_cellEditCtrlEnabled )
+            if ( DoEnableCellEditControl() && !specialEditKey )
                 editor->StartingKey(event);
         }
         else
@@ -7150,22 +7146,34 @@ void wxGrid::EnableCellEditControl( bool enable )
             // this should be checked by the caller!
             wxCHECK_RET( CanEnableCellControl(), wxT("can't enable editing for this cell!") );
 
-            if ( SendEvent(wxEVT_GRID_EDITOR_SHOWN) == -1 )
-                return;
-
-            m_cellEditCtrlEnabled = true;
-
-            DoShowCellEditControl();
+            DoEnableCellEditControl();
         }
         else
         {
-            SendEvent(wxEVT_GRID_EDITOR_HIDDEN);
-
-            DoAcceptCellEditControl();
+            DoDisableCellEditControl();
         }
     }
 }
 
+bool wxGrid::DoEnableCellEditControl()
+{
+    if ( SendEvent(wxEVT_GRID_EDITOR_SHOWN) == -1 )
+        return false;
+
+    m_cellEditCtrlEnabled = true;
+
+    DoShowCellEditControl();
+
+    return true;
+}
+
+void wxGrid::DoDisableCellEditControl()
+{
+    SendEvent(wxEVT_GRID_EDITOR_HIDDEN);
+
+    DoAcceptCellEditControl();
+}
+
 bool wxGrid::IsCurrentCellReadOnly() const
 {
     return const_cast<wxGrid *>(this)->