Merge branch 'im/gridcombo' of https://github.com/imciner2/wxWidgets

Close the cell editor when the editor's combobox is closed.

See https://github.com/wxWidgets/wxWidgets/pull/1941

include/wx/generic/grid.h

@@ -2827,7 +2827,6 @@ protected:
     void OnKeyDown( wxKeyEvent& );
     void OnKeyUp( wxKeyEvent& );
     void OnChar( wxKeyEvent& );
-    void OnHideEditor( wxCommandEvent& );
 
 
     bool SetCurrentCell( const wxGridCellCoords& coords );

include/wx/generic/grideditors.h

@@ -27,6 +27,8 @@ public:
     {
     }
 
+    void DismissEditor();
+
     void OnKillFocus(wxFocusEvent& event);
     void OnKeyDown(wxKeyEvent& event);
     void OnChar(wxKeyEvent& event);
@@ -335,6 +337,8 @@ public:
 protected:
     wxComboBox *Combo() const { return (wxComboBox *)m_control; }
 
+    void OnComboCloseUp(wxCommandEvent& evt);
+
     wxString        m_value;
     wxArrayString   m_choices;
     bool            m_allowOthers;

include/wx/generic/private/grid.h

@@ -17,10 +17,6 @@
 
 #include "wx/headerctrl.h"
 
-// Internally used (and hence intentionally not exported) event telling wxGrid
-// to hide the currently shown editor.
-wxDECLARE_EVENT( wxEVT_GRID_HIDE_EDITOR, wxCommandEvent );
-
 // ----------------------------------------------------------------------------
 // array classes
 // ----------------------------------------------------------------------------

src/generic/grid.cpp

@@ -2519,7 +2519,6 @@ wxBEGIN_EVENT_TABLE( wxGrid, wxScrolledCanvas )
     EVT_KEY_DOWN( wxGrid::OnKeyDown )
     EVT_KEY_UP( wxGrid::OnKeyUp )
     EVT_CHAR ( wxGrid::OnChar )
-    EVT_COMMAND(wxID_ANY, wxEVT_GRID_HIDE_EDITOR, wxGrid::OnHideEditor )
 wxEND_EVENT_TABLE()
 
 bool wxGrid::Create(wxWindow *parent, wxWindowID id,
@@ -7543,11 +7542,6 @@ void wxGrid::DoSaveEditControlValue()
         }
 }
 
-void wxGrid::OnHideEditor(wxCommandEvent& WXUNUSED(event))
-{
-    DisableCellEditControl();
-}
-
 //
 // ------ Grid location functions
 //  Note that all of these functions work with the logical coordinates of

src/generic/grideditors.cpp

@@ -66,12 +66,19 @@
 // implementation
 // ============================================================================
 
-wxDEFINE_EVENT( wxEVT_GRID_HIDE_EDITOR, wxCommandEvent );
-
 // ----------------------------------------------------------------------------
 // wxGridCellEditorEvtHandler
 // ----------------------------------------------------------------------------
 
+void wxGridCellEditorEvtHandler::DismissEditor()
+{
+    // Tell the grid to dismiss the control but don't do it immediately as it
+    // could result in the editor being destroyed right now and a crash in the
+    // code searching for the next event handler, so tell the grid to close it
+    // after this event is processed.
+    m_grid->CallAfter(&wxGrid::DisableCellEditControl);
+}
+
 void wxGridCellEditorEvtHandler::OnKillFocus(wxFocusEvent& event)
 {
     // We must let the native control have this event so in any case don't mark
@@ -82,16 +89,7 @@ void wxGridCellEditorEvtHandler::OnKillFocus(wxFocusEvent& event)
     if (m_inSetFocus)
         return;
 
-    // Tell the grid to dismiss the control but don't do it immediately as it
+    DismissEditor();
-    // could result in the editor being destroyed right now and a crash in the
-    // code searching for the next event handler, so post an event asking the
-    // grid to do it slightly later instead.
-
-    // FIXME-VC6: Once we drop support for VC6, we should use a simpler
-    //            m_grid->CallAfter(&wxGrid::DisableCellEditControl) and get
-    //            rid of wxEVT_GRID_HIDE_EDITOR entirely.
-    m_grid->GetEventHandler()->
-        AddPendingEvent(wxCommandEvent(wxEVT_GRID_HIDE_EDITOR));
 }
 
 void wxGridCellEditorEvtHandler::OnKeyDown(wxKeyEvent& event)
@@ -100,7 +98,7 @@ void wxGridCellEditorEvtHandler::OnKeyDown(wxKeyEvent& event)
     {
         case WXK_ESCAPE:
             m_editor->Reset();
-            m_grid->DisableCellEditControl();
+            DismissEditor();
             break;
 
         case WXK_TAB:
@@ -1580,7 +1578,11 @@ void wxGridCellChoiceEditor::BeginEdit(int row, int col, wxGrid* grid)
 
     wxGridCellEditorEvtHandler* evtHandler = NULL;
     if (m_control)
+    {
+        // This event handler is needed to properly dismiss the editor when the popup is closed
+        m_control->Bind(wxEVT_COMBOBOX_CLOSEUP, &wxGridCellChoiceEditor::OnComboCloseUp, this);
         evtHandler = wxDynamicCast(m_control->GetEventHandler(), wxGridCellEditorEvtHandler);
+    }
 
     // Don't immediately end if we get a kill focus event within BeginEdit
     if (evtHandler)
@@ -1679,6 +1681,19 @@ wxString wxGridCellChoiceEditor::GetValue() const
   return Combo()->GetValue();
 }
 
+void wxGridCellChoiceEditor::OnComboCloseUp(wxCommandEvent& WXUNUSED(evt))
+{
+    wxGridCellEditorEvtHandler* evtHandler = wxDynamicCast(m_control->GetEventHandler(),
+                                                           wxGridCellEditorEvtHandler);
+
+    if ( !evtHandler )
+        return;
+
+    // Close the grid editor when the combobox closes, otherwise it leaves the
+    // dropdown arrow visible in the cell.
+    evtHandler->DismissEditor();
+}
+
 #endif // wxUSE_COMBOBOX
 
 #if wxUSE_COMBOBOX
@@ -1830,7 +1845,7 @@ struct wxGridCellDateEditorKeyHandler
 
             case WXK_RETURN:
             case WXK_NUMPAD_ENTER:
-                wxPostEvent(m_handler, wxCommandEvent(wxEVT_GRID_HIDE_EDITOR));
+                m_handler->DismissEditor();
                 event.Skip();
                 break;