Audacity 3.2.0
Public Member Functions | Private Member Functions | List of all members
EffectsPrefs Class Referencefinal

A PrefsPanel for general GUI preferences. More...

#include <EffectsPrefs.h>

Inheritance diagram for EffectsPrefs:
[legend]
Collaboration diagram for EffectsPrefs:
[legend]

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
 
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
 
wxTabTraversalWrapperoperator= (wxTabTraversalWrapper &&)=delete
 

Private Member Functions

void Populate ()
 

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 FactoriesDefaultFactories ()
 

Detailed Description

A PrefsPanel for general GUI preferences.

Definition at line 25 of file EffectsPrefs.h.

Constructor & Destructor Documentation

◆ EffectsPrefs()

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

Definition at line 33 of file EffectsPrefs.cpp.

34: PrefsPanel(parent, winid, XO("Effects"))
35{
36 Populate();
37}
XO("Cut/Copy/Paste")
PrefsPanel(wxWindow *parent, wxWindowID winid, const TranslatableString &title)
Definition: PrefsPanel.h:94

References Populate().

Here is the call graph for this function:

◆ ~EffectsPrefs()

EffectsPrefs::~EffectsPrefs ( )

Definition at line 39 of file EffectsPrefs.cpp.

40{
41}

Member Function Documentation

◆ Commit()

bool EffectsPrefs::Commit ( )
overridevirtual

Implements PrefsPanel.

Definition at line 149 of file EffectsPrefs.cpp.

150{
153
154 return true;
155}
@ eIsSavingToPrefs
Definition: ShuttleGui.h:47
#define S(N)
Definition: ToChars.cpp:64
void PopulateOrExchange(ShuttleGui &S) override
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:630

References eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString EffectsPrefs::GetDescription ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 48 of file EffectsPrefs.cpp.

49{
50 return XO("Preferences for Effects");
51}

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol EffectsPrefs::GetSymbol ( ) const
overridevirtual

Implements ComponentInterface.

Definition at line 43 of file EffectsPrefs.cpp.

44{
46}
#define EFFECTS_PREFS_PLUGIN_SYMBOL
Definition: EffectsPrefs.h:23

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 53 of file EffectsPrefs.cpp.

54{
55 return "Effects_Preferences";
56}

◆ Populate()

void EffectsPrefs::Populate ( )
private

Definition at line 58 of file EffectsPrefs.cpp.

59{
60 //------------------------- Main section --------------------
61 // Now construct the GUI itself.
62 // Use 'eIsCreatingFromPrefs' so that the GUI is
63 // initialised with values from gPrefs.
66 // ----------------------- End of main section --------------
67}
@ eIsCreatingFromPrefs
Definition: ShuttleGui.h:46

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 108 of file EffectsPrefs.cpp.

109{
110 S.SetBorder(2);
111 S.StartScroller();
112
113 S.StartStatic(XO("Effect Options"));
114 {
115 S.StartMultiColumn(2);
116 {
117 S.MinSize()
118 .TieChoice( XXO("Effect menu &organization:"), EffectsGroupBy);
119 S.MinSize()
120 .TieChoice( XXO("Realtime effect o&rganization:"), RealtimeEffectsGroupBy);
121 }
122 S.TieCheckBox(XXO("&Skip effects scanning at startup"), SkipEffectsScanAtStartup);
123 S.EndMultiColumn();
124 }
125 S.EndStatic();
126
127#ifdef EXPERIMENTAL_EQ_SSE_THREADED
128 S.StartStatic(XO("Instruction Set"));
129 {
130 S.TieCheckBox(XXO("&Use SSE/SSE2/.../AVX"),
131 {wxT("/SSE/GUI"),
132 true});
133 }
134 S.EndStatic();
135#endif
136
137 if (auto pButton = S.AddButton(XXO("Open Plugin &Manager"), wxALIGN_LEFT))
138 pButton->Bind(wxEVT_BUTTON, [this](auto) {
139 //Adding dependency on PluginRegistrationDialog, not good. Alternatively
140 //that could be done with events, though event should be visible here too...
141 PluginRegistrationDialog dialog(wxGetTopLevelParent(this));
142 if(dialog.ShowModal() == wxID_OK)
144 });
145
146 S.EndScroller();
147}
wxT("CloseDown"))
ChoiceSetting EffectsGroupBy
BoolSetting SkipEffectsScanAtStartup
ChoiceSetting RealtimeEffectsGroupBy
XXO("&Cut/Copy/Paste Toolbar")
static void RebuildAllMenuBars()

References EffectsGroupBy, RealtimeEffectsGroupBy, MenuCreator::RebuildAllMenuBars(), S, 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:

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