anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper Class Reference

Inheritance diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper:

Collaboration diagram for anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper:

Static Public Member Functions
static std::optional< wxString >	PickEffect (AudacityProject &project, wxWindow *parent, const wxString &selectedEffectID)
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Private Member Functions
void	Populate (AudacityProject &project, Visitor< Traits > &visitor)
	EffectsMenuHelper ()
std::shared_ptr< MenuItem >	GetMenuItem ()
void	UpdatePrefs () override
void	UpdateEffectMenuItems ()

Static Private Member Functions
static EffectsMenuHelper &	Get ()

Private Attributes
std::shared_ptr< MenuRegistry::MenuItem >	mCachedMenu
Observer::Subscription	mPluginsChangedSubscription

Additional Inherited Members
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Detailed Description

Definition at line 107 of file RealtimeEffectPanel.cpp.

Constructor & Destructor Documentation

EffectsMenuHelper()

anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::EffectsMenuHelper ( )

inlineprivate

Definition at line 166 of file RealtimeEffectPanel.cpp.

      {
         mPluginsChangedSubscription = PluginManager::Get().Subscribe(
            [this](PluginsChangedMessage)
            {
               mCachedMenu.reset();
            }
         );
      }

References PluginManager::Get(), and Observer::Publisher< Message, NotifyAll >::Subscribe().

Here is the call graph for this function:

Member Function Documentation

Get()

static EffectsMenuHelper & anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::Get ( )

inlinestaticprivate

Definition at line 151 of file RealtimeEffectPanel.cpp.

      {
         static EffectsMenuHelper helper;
         return helper;
      }

GetMenuItem()

std::shared_ptr< MenuItem > anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::GetMenuItem ( )

inlineprivate

Definition at line 176 of file RealtimeEffectPanel.cpp.

      {
         if(!mCachedMenu)
            UpdateEffectMenuItems();
 
         assert(mCachedMenu);
         if(mCachedMenu)
            return mCachedMenu;
         return {};
      }

PickEffect()

static std::optional< wxString > anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::PickEffect ( AudacityProject &  project, wxWindow *  parent, const wxString &  selectedEffectID  )

inlinestatic

Definition at line 114 of file RealtimeEffectPanel.cpp.

      {
         wxMenu menu;
         if(!selectedEffectID.empty())
         {
            //no need to handle language change since menu creates its own event loop
            menu.Append(wxID_REMOVE, _("No Effect"));
            menu.AppendSeparator();
         }
 
         RealtimeEffectsMenuVisitor visitor { menu };
 
         Get().Populate(project, visitor);
 
         int commandId = wxID_NONE;
 
#if defined(__WXMSW__) || defined(__WXMAC__)
         menu.AppendSeparator();
         menu.Append(wxID_MORE, _("Get more effects..."));
#endif
         menu.Bind(wxEVT_MENU, [&](wxCommandEvent evt) { commandId = evt.GetId(); });
 
         if(parent->PopupMenu(&menu, parent->GetClientRect().GetLeftBottom()) && commandId != wxID_NONE)
         {
            if(commandId == wxID_REMOVE)
               return wxString {};
            if(commandId == wxID_MORE)
               OpenInDefaultBrowser("https://www.musehub.com");
            else
               return visitor.GetPluginID(commandId).GET();
         }
 
         return {};
      }

References _, BasicUI::Get(), BasicUI::OpenInDefaultBrowser(), and project.

Here is the call graph for this function:

Populate()

void anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::Populate ( AudacityProject &  project, Visitor< Traits > &  visitor  )

inlineprivate

Definition at line 157 of file RealtimeEffectPanel.cpp.

      {
         auto cachedMenuItem = GetMenuItem();
         if(!cachedMenuItem)
            return;
 
         VisitWithFunctions(visitor, cachedMenuItem.get(), {}, project);
      }

References project, and Registry::VisitWithFunctions().

Here is the call graph for this function:

UpdateEffectMenuItems()

void anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::UpdateEffectMenuItems ( )

inlineprivate

Definition at line 192 of file RealtimeEffectPanel.cpp.

      {
         using namespace MenuRegistry;
         auto root = std::shared_ptr{ Menu("", TranslatableString{}) };
 
         static auto realtimeEffectPredicate = [](const PluginDescriptor& desc)
         {
            return desc.IsEffectRealtime();
         };
 
         const auto groupby = RealtimeEffectsGroupBy.Read();
 
         auto analyzeSection = Section("", Menu("", XO("Analyze")));
         auto submenu =
            static_cast<MenuItem*>(analyzeSection->begin()->get());
         MenuHelper::PopulateEffectsMenu(
            *submenu,
            EffectTypeAnalyze,
            {}, groupby, nullptr,
            realtimeEffectPredicate
         );
 
         if(!submenu->empty())
         {
            root->push_back(move(analyzeSection));
         }
 
         MenuHelper::PopulateEffectsMenu(
            *root,
            EffectTypeProcess,
            {}, groupby, nullptr,
            realtimeEffectPredicate
         );
 
         mCachedMenu.swap(root);
      }

References anonymous_namespace{ExportPCM.cpp}::desc, EffectTypeAnalyze, EffectTypeProcess, MenuRegistry::Menu, MenuHelper::PopulateEffectsMenu(), ChoiceSetting::Read(), RealtimeEffectsGroupBy, MenuRegistry::Section, and XO().

Here is the call graph for this function:

UpdatePrefs()

void anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::UpdatePrefs ( )

inlineoverrideprivatevirtual

Implements PrefsListener.

Definition at line 187 of file RealtimeEffectPanel.cpp.

      {
         mCachedMenu.reset();
      }

Member Data Documentation

mCachedMenu

std::shared_ptr<MenuRegistry::MenuItem> anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::mCachedMenu

private

Definition at line 110 of file RealtimeEffectPanel.cpp.

mPluginsChangedSubscription

Observer::Subscription anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper::mPluginsChangedSubscription

private

Definition at line 111 of file RealtimeEffectPanel.cpp.

---

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

• RealtimeEffectPanel.cpp