Base class for a panel in the PrefsDialog. Classes derived from this class include BatchPrefs, DirectoriesPrefs, GUIPrefs, KeyConfigPrefs, MousePrefs, QualityPrefs, SpectrumPrefs and ThemePrefs. More...

#include <PrefsPanel.h>

Inheritance diagram for PrefsPanel:

[legend]

Collaboration diagram for PrefsPanel:

[legend]

Classes
struct	PrefsItem

struct	PrefsNode

struct	Registration

struct	Traits

Public Types
using	Factories = std::vector< PrefsPanel::PrefsNode >

using	Factory = std::function< PrefsPanel (wxWindow parent, wxWindowID winid, AudacityProject *) >

Public Member Functions
	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

Static Public Member Functions
static Factories &	DefaultFactories ()

Additional Inherited Members
Private Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Detailed Description

Base class for a panel in the PrefsDialog. Classes derived from this class include BatchPrefs, DirectoriesPrefs, GUIPrefs, KeyConfigPrefs, MousePrefs, QualityPrefs, SpectrumPrefs and ThemePrefs.

The interface works like this: Each panel in the preferences dialog must derive from PrefsPanel. You must override Apply() with code to validate fields (returning false if any are bad), updating the global preferences object gPrefs, and instructing the applicable parts of the program to re-read the preference options.

To actually add the new panel, edit the PrefsDialog constructor to append the panel to its list of panels.

Definition at line 49 of file PrefsPanel.h.

Member Typedef Documentation

◆ Factories

using PrefsPanel::Factories = std::vector<PrefsPanel::PrefsNode>

Definition at line 72 of file PrefsPanel.h.

◆ Factory

using PrefsPanel::Factory = std::function< PrefsPanel * ( wxWindow *parent, wxWindowID winid, AudacityProject *) >

Definition at line 80 of file PrefsPanel.h.

Constructor & Destructor Documentation

◆ PrefsPanel()

PrefsPanel::PrefsPanel	(	wxWindow *	parent,
		wxWindowID	winid,
		const TranslatableString &	title
	)

inline

Definition at line 94 of file PrefsPanel.h.

   :  wxPanelWrapper(parent, winid)
   {
      SetLabel(title);     // Provide visual label
      SetName(title);      // Provide audible label
   }

References wxPanelWrapper::SetLabel(), wxPanelWrapper::SetName(), and title.

Here is the call graph for this function:

◆ ~PrefsPanel()

PrefsPanel::~PrefsPanel ( )

virtual

Definition at line 47 of file PrefsPanel.cpp.

48{

49}

Member Function Documentation

◆ Cancel()

void PrefsPanel::Cancel ( )

virtual

Reimplemented in anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel, KeyConfigPrefs, and ThemePrefs.

Definition at line 51 of file PrefsPanel.cpp.

52{

53}

Referenced by PrefsDialog::OnCancel().

Here is the caller graph for this function:

◆ Commit()

virtual bool PrefsPanel::Commit ( )

pure virtual

Implemented in LibraryPrefs, anonymous_namespace{AudioComPrefsPanel.cpp}::AudioComPrefsPanel, ApplicationPrefs, BatchPrefs, DevicePrefs, DirectoriesPrefs, EffectsPrefs, ExtImportPrefs, GUIPrefs, ImportExportPrefs, KeyConfigPrefs, MidiIOPrefs, ModulePrefs, PlaybackPrefs, QualityPrefs, RecordingPrefs, SpectrumPrefs, ThemePrefs, TracksBehaviorsPrefs, TracksPrefs, and WaveformPrefs.

Referenced by PrefsDialog::OnOK().

Here is the caller graph for this function:

◆ DefaultFactories()

PrefsPanel::Factories & PrefsPanel::DefaultFactories ( )

static

Definition at line 66 of file PrefsPanel.cpp.

{
   // Once only, cause initial population of preferences for the ordering
   // of some preference pages that used to be given in a table but are now
   // separately registered in several .cpp files; the sequence of registration
   // depends on unspecified accidents of static initialization order across
   // compilation units, so we need something specific here to preserve old
   // default appearance of the preference dialog.
   // But this needs only to mention some strings -- there is no compilation or
   // link dependency of this source file on those other implementation files.
   static Registry::OrderingPreferenceInitializer init{
      PathStart,
      {
         {wxT(""),
       wxT("Device,Playback,Recording,Quality,GUI,Tracks,ImportExport,Directories,Warnings,Effects,KeyConfig,Mouse")
         },
         {wxT("/Tracks"), wxT("TracksBehaviors,Spectrum")},
      }
   };
 
   static Factories sFactories;
   static std::once_flag flag;
 
   std::call_once(flag, []{
      // Collect registry tree nodes into a vector, in preorder.
      std::vector<size_t> childCounts;
      std::vector<size_t> indices;
      childCounts.push_back(0);
      Factories factories;
 
      Registry::GroupItem<Traits> top{ PathStart };
      Registry::Visit(std::tuple{
         [&](const PrefsItem &item, auto&) {
            if (!item.factory)
               return;
            indices.push_back(factories.size());
            factories.emplace_back(item.factory, 0, item.expanded);
            ++childCounts.back();
            childCounts.push_back(0);
         },
         Registry::NoOp,
         [&](const PrefsItem &item, auto&) {
            if (!item.factory)
               return;
            auto &factory = factories[indices.back()];
            factory.nChildren = childCounts.back();
            childCounts.pop_back();
            indices.pop_back();
         }
      }, &top, &PrefsItem::Registry());
      sFactories.swap(factories);
   });
   return sFactories;
}