Class SnapModePopup

src/toolbars/SnappingToolBar.cpp:56–230

* This class provides a hack to use popup menu instead of the dropdown list. * This allows to organize the list of items in a more user-friendly way. */

 * This allows to organize the list of items in a more user-friendly way.
 */
class SnapModePopup final : public wxComboPopup
{
public:
   explicit SnapModePopup(AudacityProject& project)
       : mProject { project }
       , mSnappingModeChangedSubscription(ProjectSnap::Get(project).Subscribe(
            [this](auto& msg) {
               UpdateCurrentIndex(msg.newSnapTo);

               auto comboCtrl = GetComboCtrl();

               comboCtrl->SetValue(
                  GetSnapToLabel(msg.newSnapTo).Translation());

               comboCtrl->SetName(GetComboCtrl()->GetValue());
            }))
   {
   }

   void Init () override
   {
      // Build a linear list from all the items in the snap functions registry
      SnapFunctionsRegistry::Visit([this](const SnapRegistryItem& item, auto&) {
         mSnapToList.push_back(item.name);
      });

      UpdateCurrentIndex(ReadSnapTo());
   }

   bool Create(wxWindow* parent) override
   {
      mControl = safenew wxWindow(parent, wxID_ANY);

      // This call cannot happen in Init(), because the combobox is not yet in a valid
      // state. Doing a deferred call from Init() is unsafe,
      // as in some cases Audacity recreates the combobox multiple times before the next
      // event loop iteration.
      GetComboCtrl()->SetValue(GetStringValue());

      return mControl;
   }

   wxWindow* GetControl() override
   {
      return mControl;
   }

   wxString GetStringValue() const override
   {
      return GetSnapToLabel(ReadSnapTo()).Translation();
   }

   void OnPopup() override
   {
      // Build a popup menu based on snap functions registry
      wxMenu menu;
      std::vector<wxMenu*> menuStack{ &menu };