anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup Class Reference

Inheritance diagram for anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup:

Collaboration diagram for anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup:

Public Member Functions
	SnapModePopup (AudacityProject &project)
void	Init () override
bool	Create (wxWindow *parent) override
wxWindow *	GetControl () override
wxString	GetStringValue () const override
void	OnPopup () override
void	SetStringValue (const wxString &value) override
bool	FindItem (const wxString &item, wxString *trueItem=NULL) override
void	OnComboKeyEvent (wxKeyEvent &event) override
void	OnComboCharEvent (wxKeyEvent &event) override
void	UpdateCurrentIndex (const Identifier &identifier)

Private Attributes
AudacityProject &	mProject
wxWeakRef< wxWindow >	mControl
std::vector< Identifier >	mSnapToList
std::ptrdiff_t	mCurrentIndex { -1 }
Observer::Subscription	mSnappingModeChangedSubscription

Detailed Description

Definition at line 56 of file SnappingToolBar.cpp.

Constructor & Destructor Documentation

SnapModePopup()

anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::SnapModePopup ( AudacityProject &  project )

inlineexplicit

Definition at line 59 of file SnappingToolBar.cpp.

       : 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());
            }))
   {
   }

References anonymous_namespace{SnappingToolBar.cpp}::GetSnapToLabel(), and TranslatableString::Translation().

Here is the call graph for this function:

Member Function Documentation

Create()

bool anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::Create ( wxWindow *  parent )

inlineoverride

Definition at line 85 of file SnappingToolBar.cpp.

   {
      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;
   }

References safenew.

FindItem()

bool anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::FindItem ( const wxString &  item, wxString *  trueItem = NULL  )

inlineoverride

Definition at line 165 of file SnappingToolBar.cpp.

   {
      return wxComboPopup::FindItem(item, trueItem);
   }

GetControl()

wxWindow * anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::GetControl ( )

inlineoverride

Definition at line 98 of file SnappingToolBar.cpp.

   {
      return mControl;
   }

GetStringValue()

wxString anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::GetStringValue ( ) const

inlineoverride

Definition at line 103 of file SnappingToolBar.cpp.

   {
      return GetSnapToLabel(ReadSnapTo()).Translation();
   }

References anonymous_namespace{SnappingToolBar.cpp}::GetSnapToLabel(), ReadSnapTo(), and TranslatableString::Translation().

Here is the call graph for this function:

Init()

void anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::Init ( )

inlineoverride

Definition at line 75 of file SnappingToolBar.cpp.

   {
      // 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());
   }

References Registry::detail::BaseItem::name, ReadSnapTo(), and SnapFunctionsRegistry::Visit().

Here is the call graph for this function:

OnComboCharEvent()

void anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnComboCharEvent ( wxKeyEvent &  event )

inlineoverride

Definition at line 205 of file SnappingToolBar.cpp.

   {
      // Consume the event to prevent editing
   }

OnComboKeyEvent()

void anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnComboKeyEvent ( wxKeyEvent &  event )

inlineoverride

Definition at line 170 of file SnappingToolBar.cpp.

   {
      const auto keyCode = event.GetKeyCode();
 
      if (keyCode == WXK_RETURN || keyCode == WXK_NUMPAD_ENTER)
      {
         GetComboCtrl()->ShowPopup();
         return;
      }
 
      int direction = 0;
 
      if (
         keyCode == WXK_UP || keyCode == WXK_NUMPAD_UP || keyCode == WXK_LEFT ||
         keyCode == WXK_NUMPAD_LEFT)
         direction = -1;
      else if (
         keyCode == WXK_DOWN || keyCode == WXK_NUMPAD_DOWN ||
         keyCode == WXK_RIGHT || keyCode == WXK_NUMPAD_RIGHT)
         direction = 1;
 
      if (direction == 0)
         return;
 
      const auto newIndex = std::clamp<ptrdiff_t>(
         mCurrentIndex + direction, 0, mSnapToList.size() - 1);
 
      if (newIndex == mCurrentIndex)
         return;
 
      mCurrentIndex = newIndex;
 
      ProjectSnap::Get(mProject).SetSnapTo(mSnapToList[mCurrentIndex]);
   }

References ProjectSnap::Get(), and ProjectSnap::SetSnapTo().

Here is the call graph for this function:

OnPopup()

void anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup ( )

inlineoverride

Definition at line 108 of file SnappingToolBar.cpp.

   {
      // Build a popup menu based on snap functions registry
      wxMenu menu;
      std::vector<wxMenu*> menuStack{ &menu };
 
      const auto visitor = std::tuple{
         [&](const SnapRegistryGroup& item, auto &) {
            if (item.Inlined())
               return;
 
            auto menu = safenew wxMenu;
            
            menuStack.back()->AppendSubMenu(menu, item.Label().Translation());
            menuStack.push_back(menu);
         },
         [&, this](const SnapRegistryItem& item, auto &) {
            auto menuItem = menuStack.back()->AppendCheckItem(wxID_ANY, item.label.Translation());
 
            if (ReadSnapTo() == item.name)
               menuItem->Check();
 
            menuStack.back()->Bind(
               wxEVT_MENU,
               [this, id = item.name](wxCommandEvent&) {
                  ProjectSnap::Get(mProject).SetSnapTo(id);
               },
               menuItem->GetId()
            );
         },
         [&](const SnapRegistryGroup& item, auto &) {
            assert(!menuStack.empty());
            
            if (item.Inlined())
            {
               menuStack.back()->AppendSeparator();
               return;
            }
 
            menuStack.pop_back();
         }
      };
      SnapFunctionsRegistry::Visit(visitor);
 
      BasicMenu::Handle { &menu }.Popup(
         wxWidgetsWindowPlacement { GetComboCtrl() },
         { 0, GetComboCtrl()->GetSize().y });
 
      // Hide the combobox list after the menu was closed
      BasicUI::CallAfter([this] { Dismiss(); });
   }

References BasicUI::CallAfter(), ProjectSnap::Get(), SnapRegistryGroup::Inlined(), SnapRegistryGroupData::label, SnapRegistryGroup::Label(), BasicMenu::Handle::Popup(), ReadSnapTo(), safenew, ProjectSnap::SetSnapTo(), TranslatableString::Translation(), and SnapFunctionsRegistry::Visit().

Here is the call graph for this function:

SetStringValue()

void anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::SetStringValue ( const wxString &  value )

inlineoverride

Definition at line 160 of file SnappingToolBar.cpp.

   {
       wxComboPopup::SetStringValue(value);
   }

UpdateCurrentIndex()

void anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::UpdateCurrentIndex ( const Identifier &  identifier )

inline

Definition at line 210 of file SnappingToolBar.cpp.

   {
      if (
         mCurrentIndex < mSnapToList.size() &&
         mSnapToList[mCurrentIndex] == identifier)
         return;
 
      mCurrentIndex = static_cast<size_t>(std::distance(
         mSnapToList.begin(),
         std::find(mSnapToList.begin(), mSnapToList.end(), identifier)));
   }

Member Data Documentation

mControl

wxWeakRef<wxWindow> anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::mControl

private

Definition at line 224 of file SnappingToolBar.cpp.

mCurrentIndex

std::ptrdiff_t anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::mCurrentIndex { -1 }

private

Definition at line 227 of file SnappingToolBar.cpp.

mProject

AudacityProject& anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::mProject

private

Definition at line 223 of file SnappingToolBar.cpp.

mSnappingModeChangedSubscription

Observer::Subscription anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::mSnappingModeChangedSubscription

private

Definition at line 229 of file SnappingToolBar.cpp.

mSnapToList

std::vector<Identifier> anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::mSnapToList

private

Definition at line 226 of file SnappingToolBar.cpp.

---

The documentation for this class was generated from the following file:

• SnappingToolBar.cpp