Fixed nested scrolling in the MidiObject dialog on macOs #1972 (#2112)

Author: oleg68

CHANGELOG.md

@@ -1,3 +1,4 @@
+- Fixed nested scrolling in the MidiObject dialog on macOs https://github.com/GrandOrgue/grandorgue/issues/1972
 - Increased the maximum number of user-defined temperaments to 999 https://github.com/GrandOrgue/grandorgue/issues/1982
 # 3.15.4 (2024-12-20)
 - Eliminated a MacOs debug alert when opening a settings dialog https://github.com/GrandOrgue/grandorgue/issues/2003

src/grandorgue/gui/dialogs/GOMidiListDialog.cpp

@@ -8,47 +8,60 @@
 #include "GOMidiListDialog.h"
 
 #include <wx/button.h>
-#include <wx/listctrl.h>
 #include <wx/sizer.h>
 
+#include "gui/size/GOAdditionalSizeKeeperProxy.h"
+#include "gui/wxcontrols/GOGrid.h"
 #include "midi/objects/GOMidiObject.h"
 
 #include "GOEvent.h"
 
+enum {
+  ID_LIST = 200,
+  ID_EDIT,
+  ID_STATUS,
+  ID_BUTTON,
+  ID_BUTTON_LAST = ID_BUTTON + 2,
+};
+
 BEGIN_EVENT_TABLE(GOMidiListDialog, GOSimpleDialog)
-EVT_LIST_ITEM_SELECTED(ID_LIST, GOMidiListDialog::OnObjectClick)
-EVT_LIST_ITEM_ACTIVATED(ID_LIST, GOMidiListDialog::OnObjectDoubleClick)
+EVT_GRID_CMD_SELECT_CELL(ID_LIST, GOMidiListDialog::OnObjectClick)
+EVT_GRID_CMD_CELL_LEFT_DCLICK(ID_LIST, GOMidiListDialog::OnObjectDoubleClick)
 EVT_BUTTON(ID_STATUS, GOMidiListDialog::OnStatus)
 EVT_BUTTON(ID_EDIT, GOMidiListDialog::OnEdit)
 EVT_COMMAND_RANGE(
   ID_BUTTON, ID_BUTTON_LAST, wxEVT_BUTTON, GOMidiListDialog::OnButton)
 END_EVENT_TABLE()
 
+enum { GRID_COL_TYPE = 0, GRID_COL_ELEMENT };
+
 GOMidiListDialog::GOMidiListDialog(
   GODocumentBase *doc,
   wxWindow *parent,
   GODialogSizeSet &dialogSizes,
-  const std::vector<GOMidiObject *> &midi_elements)
+  const std::vector<GOMidiObject *> &midiObjects)
   : GOSimpleDialog(
     parent,
     wxT("MIDI Objects"),
     _("MIDI Objects"),
     dialogSizes,
     wxEmptyString,
     0,
-    wxOK | wxHELP),
-    GOView(doc, this) {
+    wxCLOSE | wxHELP),
+    GOView(doc, this),
+    r_MidiObjects(midiObjects) {
   wxBoxSizer *topSizer = new wxBoxSizer(wxVERTICAL);
   topSizer->AddSpacer(5);
 
-  m_Objects = new wxListView(
-    this,
-    ID_LIST,
-    wxDefaultPosition,
-    wxSize(300, 600),
-    wxLC_REPORT | wxLC_SINGLE_SEL | wxLC_HRULES | wxLC_VRULES);
-  m_Objects->InsertColumn(0, _("Type"));
-  m_Objects->InsertColumn(1, _("Element"));
+  m_Objects = new GOGrid(this, ID_LIST, wxDefaultPosition, wxSize(250, 200));
+  m_Objects->CreateGrid(0, 2, wxGrid::wxGridSelectRows);
+  m_Objects->HideRowLabels();
+  m_Objects->EnableEditing(false);
+  m_Objects->SetColLabelValue(GRID_COL_TYPE, _("Type"));
+  m_Objects->SetColLabelValue(GRID_COL_ELEMENT, _("Element"));
+  m_Objects->SetColSize(GRID_COL_TYPE, 100);
+  m_Objects->SetColSize(GRID_COL_ELEMENT, 100);
+
   topSizer->Add(m_Objects, 1, wxEXPAND | wxALL, 5);
 
   wxBoxSizer *sizer = new wxBoxSizer(wxHORIZONTAL);
@@ -69,61 +82,93 @@ GOMidiListDialog::GOMidiListDialog(
   buttons->Add(m_Status);
   topSizer->Add(buttons, 0, wxALIGN_RIGHT | wxALL, 1);
 
-  for (unsigned i = 0; i < midi_elements.size(); i++) {
-    GOMidiObject *obj = midi_elements[i];
+  topSizer->AddSpacer(5);
+  LayoutWithInnerSizer(topSizer);
+}
 
-    m_Objects->InsertItem(i, obj->GetMidiTypeName());
-    m_Objects->SetItemPtrData(i, (wxUIntPtr)obj);
-    m_Objects->SetItem(i, 1, obj->GetName());
-  }
+static const wxString WX_GRID_MIDI_OBJECTS = wxT("GridMidiObjects");
 
-  m_Objects->SetColumnWidth(0, wxLIST_AUTOSIZE);
-  m_Objects->SetColumnWidth(1, wxLIST_AUTOSIZE);
+void GOMidiListDialog::ApplyAdditionalSizes(
+  const GOAdditionalSizeKeeper &sizeKeeper) {
+  GOAdditionalSizeKeeperProxy proxyMidiObjects(
+    const_cast<GOAdditionalSizeKeeper &>(sizeKeeper), WX_GRID_MIDI_OBJECTS);
 
-  topSizer->AddSpacer(5);
-  LayoutWithInnerSizer(topSizer);
+  m_Objects->ApplyColumnSizes(proxyMidiObjects);
+}
+
+void GOMidiListDialog::CaptureAdditionalSizes(
+  GOAdditionalSizeKeeper &sizeKeeper) const {
+  GOAdditionalSizeKeeperProxy proxyMidiObjects(
+    sizeKeeper, WX_GRID_MIDI_OBJECTS);
+
+  m_Objects->CaptureColumnSizes(proxyMidiObjects);
+}
+
+bool GOMidiListDialog::TransferDataToWindow() {
+  unsigned oldRowCnt = m_Objects->GetNumberRows();
+  unsigned newRowCnt = r_MidiObjects.size();
+
+  if (oldRowCnt)
+    m_Objects->DeleteRows(0, oldRowCnt);
+
+  m_Objects->AppendRows(newRowCnt);
+  for (unsigned i = 0; i < newRowCnt; i++) {
+    GOMidiObject *obj = r_MidiObjects[i];
+
+    m_Objects->SetCellValue(i, GRID_COL_TYPE, obj->GetMidiTypeName());
+    m_Objects->SetCellValue(i, GRID_COL_ELEMENT, obj->GetName());
+  }
+  return true;
 }
 
-GOMidiListDialog::~GOMidiListDialog() {}
+GOMidiObject *GOMidiListDialog::GetSelectedObject() const {
+  return r_MidiObjects[m_Objects->GetGridCursorRow()];
+}
 
 void GOMidiListDialog::OnButton(wxCommandEvent &event) {
-  GOMidiObject *obj
-    = (GOMidiObject *)m_Objects->GetItemData(m_Objects->GetFirstSelected());
+  GOMidiObject *obj = GetSelectedObject();
   obj->TriggerElementActions(event.GetId() - ID_BUTTON);
 }
 
+void GOMidiListDialog::OnObjectClick(wxGridEvent &event) {
+  int index = event.GetRow();
+  bool isAnySelected = index >= 0;
+
+  m_Edit->Enable(isAnySelected);
+  m_Status->Enable(isAnySelected);
+  if (isAnySelected) {
+    m_Objects->SelectRow(index);
+    GOMidiObject *obj = r_MidiObjects[index];
+    std::vector<wxString> actions = obj->GetElementActions();
+
+    for (unsigned i = 0; i < m_Buttons.size(); i++)
+      if (i < actions.size()) {
+        m_Buttons[i]->SetLabel(actions[i]);
+        m_Buttons[i]->Show();
+      } else
+        m_Buttons[i]->Hide();
+  }
+  Layout();
+  event.StopPropagation();
+}
+
+void GOMidiListDialog::OnObjectDoubleClick(wxGridEvent &event) {
+  GOMidiObject *obj = GetSelectedObject();
+
+  obj->ShowConfigDialog();
+}
+
 void GOMidiListDialog::OnStatus(wxCommandEvent &event) {
-  GOMidiObject *obj
-    = (GOMidiObject *)m_Objects->GetItemData(m_Objects->GetFirstSelected());
+  GOMidiObject *obj = GetSelectedObject();
   wxString status = obj->GetElementStatus();
+
   GOMessageBox(
     wxString::Format(_("Status: %s"), status),
     obj->GetMidiTypeName() + _(" ") + obj->GetName(),
     wxOK);
 }
 
-void GOMidiListDialog::OnObjectClick(wxListEvent &event) {
-  m_Edit->Enable();
-  m_Status->Enable();
-  GOMidiObject *obj
-    = (GOMidiObject *)m_Objects->GetItemData(m_Objects->GetFirstSelected());
-  std::vector<wxString> actions = obj->GetElementActions();
-  for (unsigned i = 0; i < m_Buttons.size(); i++)
-    if (i < actions.size()) {
-      m_Buttons[i]->SetLabel(actions[i]);
-      m_Buttons[i]->Show();
-    } else
-      m_Buttons[i]->Hide();
-  Layout();
-}
-
-void GOMidiListDialog::OnObjectDoubleClick(wxListEvent &event) {
-  GOMidiObject *obj
-    = (GOMidiObject *)m_Objects->GetItemData(m_Objects->GetFirstSelected());
-  obj->ShowConfigDialog();
-}
-
 void GOMidiListDialog::OnEdit(wxCommandEvent &event) {
-  wxListEvent listevent;
+  wxGridEvent listevent;
   OnObjectDoubleClick(listevent);
 }

src/grandorgue/gui/dialogs/GOMidiListDialog.h

@@ -14,39 +14,41 @@
 #include "document-base/GOView.h"
 
 class wxButton;
-class wxListEvent;
-class wxListView;
+class wxGridEvent;
 
+class GOGrid;
 class GOMidiObject;
 
 class GOMidiListDialog : public GOSimpleDialog, public GOView {
 private:
-  wxListView *m_Objects;
+  const std::vector<GOMidiObject *> &r_MidiObjects;
+
+  GOGrid *m_Objects;
   wxButton *m_Edit;
   wxButton *m_Status;
   std::vector<wxButton *> m_Buttons;
 
-  enum {
-    ID_LIST = 200,
-    ID_EDIT,
-    ID_STATUS,
-    ID_BUTTON,
-    ID_BUTTON_LAST = ID_BUTTON + 2,
-  };
-
-  void OnObjectClick(wxListEvent &event);
-  void OnObjectDoubleClick(wxListEvent &event);
-  void OnEdit(wxCommandEvent &event);
-  void OnStatus(wxCommandEvent &event);
-  void OnButton(wxCommandEvent &event);
-
 public:
   GOMidiListDialog(
     GODocumentBase *doc,
     wxWindow *parent,
     GODialogSizeSet &dialogSizes,
-    const std::vector<GOMidiObject *> &midi_elements);
-  ~GOMidiListDialog();
+    const std::vector<GOMidiObject *> &midiObjects);
+
+private:
+  void ApplyAdditionalSizes(const GOAdditionalSizeKeeper &sizeKeeper) override;
+  void CaptureAdditionalSizes(
+    GOAdditionalSizeKeeper &sizeKeeper) const override;
+
+  bool TransferDataToWindow() override;
+
+  GOMidiObject *GetSelectedObject() const;
+
+  void OnObjectClick(wxGridEvent &event);
+  void OnObjectDoubleClick(wxGridEvent &event);
+  void OnEdit(wxCommandEvent &event);
+  void OnStatus(wxCommandEvent &event);
+  void OnButton(wxCommandEvent &event);
 
   DECLARE_EVENT_TABLE()
 };