A PrefsPanel for general GUI preferences. More...

#include <GUIPrefs.h>

Inheritance diagram for GUIPrefs:

Collaboration diagram for GUIPrefs:

Public Member Functions
	GUIPrefs (wxWindow *parent, wxWindowID winid)

	~GUIPrefs ()

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

Static Public Member Functions
static void	GetRangeChoices (TranslatableStrings pChoices, wxArrayStringEx pCodes, int *pDefaultRangeIndex=nullptr)

static void	GetLTSChoices (TranslatableStrings pChoices, wxArrayStringEx pCodes, int *pDefaultIndex=nullptr)

Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Private Member Functions
void	Populate ()

Private Attributes
wxArrayStringEx	mLangCodes

TranslatableStrings	mLangNames

wxArrayStringEx	mRangeCodes

TranslatableStrings	mRangeChoices

int	mDefaultRangeIndex

TranslatableStrings	mUTSNames

std::vector< int >	mUTSLabels

wxArrayStringEx	mLTSCodes

TranslatableStrings	mLTSChoices

int	mDefaultLTSIndex

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >

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

Detailed Description

A PrefsPanel for general GUI preferences.

Definition at line 25 of file GUIPrefs.h.

Constructor & Destructor Documentation

◆ GUIPrefs()

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

Definition at line 39 of file GUIPrefs.cpp.

:  PrefsPanel(parent, winid, XC("Interface", "GUI"))
{
   Populate();
}

References Populate().

Here is the call graph for this function:

◆ ~GUIPrefs()

GUIPrefs::~GUIPrefs ( )

Definition at line 46 of file GUIPrefs.cpp.

47{

48}

Member Function Documentation

◆ Commit()

bool GUIPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 257 of file GUIPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   // If language has changed, we want to change it now, not on the next reboot.
   wxString lang = gPrefs->Read(wxT("/Locale/Language"), wxT(""));
   wxString usedLang = GUISettings::SetLang(lang);
   // Bug 1523: Previously didn't check no-language (=System Language)
   if (!(lang.empty() || lang == L"System") && (lang != usedLang)) {
      // lang was not usable and is not system language.  We got overridden.
      gPrefs->Write(wxT("/Locale/Language"), usedLang);
      gPrefs->Flush();
   }
 
   // Reads preference GUITheme
   {
      wxBusyCursor busy;
      theTheme.LoadPreferredTheme();
      theTheme.DeleteUnusedThemes();
   }
   AColor::ApplyUpdatedImages();
 
   GUIBlendThemes.Invalidate();
   DecibelScaleCutoff.Invalidate();
   BeatsPerMinute.Invalidate();
   UpperTimeSignature.Invalidate();
   LowerTimeSignature.Invalidate();
 
   return true;
}

References AColor::ApplyUpdatedImages(), BeatsPerMinute, DecibelScaleCutoff, ThemeBase::DeleteUnusedThemes(), eIsSavingToPrefs, FileConfig::Flush(), gPrefs, GUIBlendThemes, Setting< T >::Invalidate(), ThemeBase::LoadPreferredTheme(), LowerTimeSignature, PopulateOrExchange(), S, GUISettings::SetLang(), theTheme, UpperTimeSignature, and wxT().

Here is the call graph for this function:

◆ GetDescription()

TranslatableString GUIPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 55 of file GUIPrefs.cpp.

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

References XO().

Here is the call graph for this function:

◆ GetLTSChoices()

void GUIPrefs::GetLTSChoices	(	TranslatableStrings *	pChoices,
		wxArrayStringEx *	pCodes,
		int *	pDefaultIndex = `nullptr`
	)

static

Definition at line 102 of file GUIPrefs.cpp.

{
   static wxArrayStringEx sCodes;
   static TranslatableStrings sChoices;
 
   static std::once_flag flag;
   std::call_once(flag, [&]{
      sCodes.Clear();
      sChoices.clear();
 
      for (int i = 1; i <= 64; i *= 2) {
         auto lts = wxString::Format(wxT("%d"), i);
         sCodes.Add(lts);
         sChoices.push_back(Verbatim(lts));
      }
   });
 
   if (pCodes)
      *pCodes = sCodes;
 
   if (pChoices)
      *pChoices = sChoices;
 
   if (pDefaultIndex)
      *pDefaultIndex = 2; // 4 == LowerTimeSig
}

References flag, Verbatim(), and wxT().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRangeChoices()

void GUIPrefs::GetRangeChoices	(	TranslatableStrings *	pChoices,
		wxArrayStringEx *	pCodes,
		int *	pDefaultRangeIndex = `nullptr`
	)

static

Definition at line 65 of file GUIPrefs.cpp.

{
   static const auto sCodes = {
      wxT("36") ,
      wxT("48") ,
      wxT("60") ,
      wxT("72") ,
      wxT("84") ,
      wxT("96") ,
      wxT("120") ,
      wxT("145") ,
   };
   if (pCodes)
      *pCodes = sCodes;
 
   static const std::initializer_list<TranslatableString> sChoices = {
      XO("-36 dB (shallow range for high-amplitude editing)") ,
      XO("-48 dB (PCM range of 8 bit samples)") ,
      XO("-60 dB (PCM range of 10 bit samples)") ,
      XO("-72 dB (PCM range of 12 bit samples)") ,
      XO("-84 dB (PCM range of 14 bit samples)") ,
      XO("-96 dB (PCM range of 16 bit samples)") ,
      XO("-120 dB (approximate limit of human hearing)") ,
      XO("-145 dB (PCM range of 24 bit samples)") ,
   };
 
   if (pChoices)
      *pChoices = sChoices;
 
   if (pDefaultRangeIndex)
      *pDefaultRangeIndex = 2; // 60 == ENV_DB_RANGE
}

References wxT(), and XO().

Referenced by WaveformSettings::ConvertToActualDBRange(), WaveformSettings::ConvertToEnumeratedDBRange(), Populate(), and WaveformPrefs::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol GUIPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 50 of file GUIPrefs.cpp.

{
   return GUI_PREFS_PLUGIN_SYMBOL;
}

References GUI_PREFS_PLUGIN_SYMBOL.

◆ HelpPageName()

ManualPageID GUIPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 60 of file GUIPrefs.cpp.

{
   return "Interface_Preferences";
}

◆ Populate()

void GUIPrefs::Populate ( )

private

Definition at line 133 of file GUIPrefs.cpp.

{
   // First any pre-processing for constructing the GUI.
   Languages::GetLanguages(
      FileNames::AudacityPathList(), mLangCodes, mLangNames);
 
   GetRangeChoices(&mRangeChoices, &mRangeCodes, &mDefaultRangeIndex);
 
   GetLTSChoices(&mLTSChoices, &mLTSCodes, &mDefaultLTSIndex);
 
#if 0
   mLangCodes.insert( mLangCodes.end(), {
      // only for testing...
      "kg" ,
      "ep" ,
   } );
 
   mLangNames.insert( mLangNames.end(), {
      "Klingon" ,
      "Esperanto" ,
   } );
#endif
 
   //------------------------- 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 FileNames::AudacityPathList(), eIsCreatingFromPrefs, Languages::GetLanguages(), GetLTSChoices(), GetRangeChoices(), wxArrayStringEx::insert(), mDefaultLTSIndex, mDefaultRangeIndex, mLangCodes, mLangNames, mLTSChoices, mLTSCodes, mRangeChoices, mRangeCodes, PopulateOrExchange(), and S.

Referenced by GUIPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

void GUIPrefs::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 165 of file GUIPrefs.cpp.

{
   ChoiceSetting LanguageSetting{ wxT("/Locale/Language"),
      { ByColumns, mLangNames, mLangCodes }
   };
   ChoiceSetting DBSetting{ DecibelScaleCutoff,
      { ByColumns, mRangeChoices, mRangeCodes },
      mDefaultRangeIndex
   };
 
   ChoiceSetting LowerTimeSigSettings{ LowerTimeSignature,
      { ByColumns, mLTSChoices, mLTSCodes },
      mDefaultLTSIndex
   };
 
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Display"));
   {
      S.StartMultiColumn(2);
      {
         S.TieChoice( XXO("&Language:"), LanguageSetting);
         // S.TieChoice( XXO("Location of &Manual:"), GUIManualLocation);
         S.TieChoice( XXO("Th&eme:"), GUITheme());
         S.TieChoice( XXO("Meter dB &range:"), DBSetting);
      }
      S.EndMultiColumn();
 
      S.StartMultiColumn(2);
      {
         S.TieNumericTextBox(XXO("Beats per &minute:"), BeatsPerMinute, 10);
         S.TieIntegerTextBox(XXO("Upper time &signature:"), UpperTimeSignature, 6);
         S.TieChoice(XXO("Lower time &signature:"), LowerTimeSigSettings);
      }
      S.EndMultiColumn();
 
   }
   S.EndStatic();
 
   S.StartStatic(XO("Options"));
   {
      // Start wording of options with a verb, if possible.
      S.TieCheckBox(XXO("Show 'How to Get &Help' at launch"),
                    {wxT("/GUI/ShowSplashScreen"),
                     true});
      S.TieCheckBox(XXO("Show e&xtra menus"),
                    {wxT("/GUI/ShowExtraMenus"),
                     false});
#ifdef EXPERIMENTAL_THEME_PREFS
      // We do not want to make this option mainstream.  It's a
      // convenience for developers.
      S.TieCheckBox(XXO("Show alternative &styling (Mac vs PC)"),
                    {wxT("/GUI/ShowMac"),
                     false});
#endif
      S.TieCheckBox(XXO("&Beep on completion of longer activities"),
                    {wxT("/GUI/BeepOnCompletion"),
                     false});
      S.TieCheckBox(XXO("Re&tain labels if selection snaps to a label"),
                    {wxT("/GUI/RetainLabels"),
                     false});
      S.TieCheckBox(XXO("B&lend system and Audacity theme"),
                     GUIBlendThemes);
#ifndef __WXMAC__
      /* i18n-hint: RTL stands for 'Right to Left'  */
      S.TieCheckBox(XXO("Use mostly Left-to-Right layouts in RTL languages"),
         {"/GUI/RtlWorkaround",
          true});
#endif
#ifdef EXPERIMENTAL_CEE_NUMBERS_OPTION
      S.TieCheckBox(XXO("Never use comma as decimal point"),
                    {wxT("/Locale/CeeNumberFormat"),
                     false});
#endif
   }
   S.EndStatic();
 
   S.StartStatic(XO("Timeline"));
   {
      S.TieCheckBox(XXO("Show Timeline Tooltips"),
                    {wxT("/QuickPlay/ToolTips"),
                     true});
      S.TieCheckBox(XXO("Show Scrub Ruler"),
                    {wxT("/QuickPlay/ScrubbingEnabled"),
                     false});
   }
   S.EndStatic();
 
   S.EndScroller();
}

References BeatsPerMinute, ByColumns, DecibelScaleCutoff, GUIBlendThemes, GUITheme(), LowerTimeSignature, mDefaultLTSIndex, mDefaultRangeIndex, mLangCodes, mLangNames, mLTSChoices, mLTSCodes, mRangeChoices, mRangeCodes, S, UpperTimeSignature, 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

◆ mDefaultLTSIndex

int GUIPrefs::mDefaultLTSIndex

private

Definition at line 64 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mDefaultRangeIndex

int GUIPrefs::mDefaultRangeIndex

private

Definition at line 57 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mLangCodes

wxArrayStringEx GUIPrefs::mLangCodes

private

Definition at line 52 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mLangNames

TranslatableStrings GUIPrefs::mLangNames

private

Definition at line 53 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mLTSChoices

TranslatableStrings GUIPrefs::mLTSChoices

private

Definition at line 63 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mLTSCodes

wxArrayStringEx GUIPrefs::mLTSCodes

private

Definition at line 62 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mRangeChoices

TranslatableStrings GUIPrefs::mRangeChoices

private

Definition at line 56 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mRangeCodes

wxArrayStringEx GUIPrefs::mRangeCodes

private

Definition at line 55 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

◆ mUTSLabels

std::vector<int> GUIPrefs::mUTSLabels

private

Definition at line 60 of file GUIPrefs.h.

◆ mUTSNames

TranslatableStrings GUIPrefs::mUTSNames

private

Definition at line 59 of file GUIPrefs.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GUIPrefs()

◆ ~GUIPrefs()

Member Function Documentation

◆ Commit()

◆ GetDescription()

◆ GetLTSChoices()

◆ GetRangeChoices()

◆ GetSymbol()

◆ HelpPageName()

◆ Populate()

◆ PopulateOrExchange()

Member Data Documentation

◆ mDefaultLTSIndex

◆ mDefaultRangeIndex

◆ mLangCodes

◆ mLangNames

◆ mLTSChoices

◆ mLTSCodes

◆ mRangeChoices

◆ mRangeCodes

◆ mUTSLabels

◆ mUTSNames