EffectsPrefs Class Reference

A PrefsPanel for general GUI preferences. More...

#include <EffectsPrefs.h>

Inheritance diagram for EffectsPrefs:

Collaboration diagram for EffectsPrefs:

Public Member Functions
	EffectsPrefs (wxWindow *parent, wxWindowID winid)
	~EffectsPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
void	PopulateOrExchange (ShuttleGui &S) override
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	Populate ()

Private Attributes
std::vector< std::pair< PluginProvider *, EffectsLocationPanel * > >	mLocations

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel for general GUI preferences.

Definition at line 27 of file EffectsPrefs.h.

Constructor & Destructor Documentation

EffectsPrefs()

EffectsPrefs::EffectsPrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Definition at line 196 of file EffectsPrefs.cpp.

:  PrefsPanel(parent, winid, XO("Effects"))
{
   Populate();
}

References Populate().

Here is the call graph for this function:

~EffectsPrefs()

EffectsPrefs::~EffectsPrefs

(

)

Definition at line 202 of file EffectsPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool EffectsPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 350 of file EffectsPrefs.cpp.

{
   auto& pluginManager = PluginManager::Get();
 
   for(auto [provider, panel] : mLocations)
      pluginManager.StoreCustomPaths(*provider, panel->GetLocations());
 
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   return true;
}

References eIsSavingToPrefs, PluginManager::Get(), mLocations, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString EffectsPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 211 of file EffectsPrefs.cpp.

{
   return XO("Preferences for Effects");
}

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol EffectsPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 206 of file EffectsPrefs.cpp.

{
   return EFFECTS_PREFS_PLUGIN_SYMBOL;
}

References EFFECTS_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID EffectsPrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 216 of file EffectsPrefs.cpp.

{
   return "Effects_Preferences";
}

Populate()

void EffectsPrefs::Populate ( )

private

Definition at line 221 of file EffectsPrefs.cpp.

{
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreatingFromPrefs, PopulateOrExchange(), and S.

Referenced by EffectsPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void EffectsPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 271 of file EffectsPrefs.cpp.

{
   const auto scroller = S.StartScroller();
 
   S.StartStatic(XO("Effect Options"));
   {
      S.StartMultiColumn(2);
      {
         S.SetBorder(3);
         S.MinSize()
          .TieChoice( XXO("Effect menu &organization:"), EffectsGroupBy);
         S.MinSize()
          .TieChoice( XXO("Realtime effect o&rganization:"), RealtimeEffectsGroupBy);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
#ifdef EXPERIMENTAL_EQ_SSE_THREADED
   S.StartStatic(XO("Instruction Set"));
   {
      S.TieCheckBox(XXO("&Use SSE/SSE2/.../AVX"),
                    {wxT("/SSE/GUI"),
                    true});
   }
   S.EndStatic();
#endif
 
   auto& pluginManager = PluginManager::Get();
   for(auto& [id, provider] : ModuleManager::Get().Providers())
   {
      if(!provider->SupportsCustomModulePaths())
         continue;
 
      /*i18n-hint: Title of the panel containing user-defined paths where plugins could be found
       * First argument is replaced with plugin type (e.g. "LV2 plugin locations")
       */
      const auto panelTitle = XO("%s plugin locations")
            .Format(provider->GetOptionalFamilySymbol().Translation());
      S.StartStatic(panelTitle);
      {
         if(S.GetMode() == eIsCreating)
         {
            const auto panel = safenew EffectsLocationPanel(S.GetParent());
#if wxUSE_ACCESSIBILITY
            panel->SetName(panelTitle);
            safenew WindowAccessible(panel);
#endif
 
            panel->AddLocations(pluginManager.ReadCustomPaths(*provider.get()));
            S.Prop(1).AddWindow(panel, wxEXPAND);
            mLocations.emplace_back(provider.get(), panel);
 
            panel->Bind(EVT_PLUGIN_LOCATIONS_CHANGED, [wnd = wxWeakRef(scroller)](const auto&)
            {
               if(!wnd)
                  return;
               wnd->Layout();
               wnd->FitInside();
            });
         }
      }
      S.EndStatic();
   }
 
   S.TieCheckBox(XXO("&Skip effects scanning at startup"), SkipEffectsScanAtStartup);
 
   if (auto pButton = S.AddButton(XXO("Open Plugin &Manager"), wxALIGN_LEFT))
      pButton->Bind(wxEVT_BUTTON, [this](auto) {
         //Adding dependency on PluginRegistrationDialog, not good. Alternatively
         //that could be done with events, though event should be visible here too...
         PluginRegistrationDialog dialog(wxGetTopLevelParent(this));
         if(dialog.ShowModal() == wxID_OK)
            MenuCreator::RebuildAllMenuBars();
      });
 
   S.EndScroller();
}

References EffectsGroupBy, eIsCreating, ModuleManager::Get(), PluginManager::Get(), mLocations, RealtimeEffectsGroupBy, MenuCreator::RebuildAllMenuBars(), S, safenew, SkipEffectsScanAtStartup, wxT(), XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mLocations

std::vector<std::pair<PluginProvider*, EffectsLocationPanel*> > EffectsPrefs::mLocations

private

Definition at line 42 of file EffectsPrefs.h.

Referenced by Commit(), and PopulateOrExchange().

---

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

• EffectsPrefs.h
• EffectsPrefs.cpp