QualityPrefs Class Reference

A PrefsPanel used for setting audio quality. More...

#include <QualityPrefs.h>

Inheritance diagram for QualityPrefs:

Collaboration diagram for QualityPrefs:

Public Member Functions
	QualityPrefs (wxWindow *parent, wxWindowID winid)
virtual	~QualityPrefs ()
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 ()

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 used for setting audio quality.

Definition at line 26 of file QualityPrefs.h.

Constructor & Destructor Documentation

QualityPrefs()

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

Definition at line 36 of file QualityPrefs.cpp.

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

~QualityPrefs()

QualityPrefs::~QualityPrefs ( )

virtual

Definition at line 43 of file QualityPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool QualityPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 111 of file QualityPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
   
   // Tell CopySamples() to use these ditherers now
   InitDitherers();
 
   return true;
}

References eIsSavingToPrefs, InitDitherers(), PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString QualityPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 52 of file QualityPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol QualityPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 47 of file QualityPrefs.cpp.

{
   return QUALITY_PREFS_PLUGIN_SYMBOL;
}

References QUALITY_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID QualityPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 57 of file QualityPrefs.cpp.

{
   return "Quality_Preferences";
}

Populate()

void QualityPrefs::Populate ( )

private

Definition at line 62 of file QualityPrefs.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.

Here is the call graph for this function:

PopulateOrExchange()

void QualityPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 73 of file QualityPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Real-time Conversion"));
   {
      S.StartMultiColumn(2, wxEXPAND);
      {
         S.TieChoice(XXO("Sample Rate Con&verter:"),
                     Resample::FastMethodSetting);
 
         /* i18n-hint: technical term for randomization to reduce undesirable resampling artifacts */
         S.TieChoice(XXO("&Dither:"),
                     Dither::FastSetting);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("High-quality Conversion"));
   {
      S.StartMultiColumn(2);
      {
         S.TieChoice(XXO("Sample Rate Conver&ter:"),
                     Resample::BestMethodSetting);
 
         /* i18n-hint: technical term for randomization to reduce undesirable resampling artifacts */
         S.TieChoice(XXO("Dit&her:"),
                     Dither::BestSetting);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
   S.EndScroller();
 
}

References Resample::BestMethodSetting, Dither::BestSetting, Resample::FastMethodSetting, Dither::FastSetting, S, 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:

• QualityPrefs.h
• QualityPrefs.cpp