GUIPrefs Class Reference

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

Private Member Functions
void	Populate ()

Private Attributes
wxArrayStringEx	mLangCodes
TranslatableStrings	mLangNames
wxArrayStringEx	mRangeCodes
TranslatableStrings	mRangeChoices
int	mDefaultRangeIndex

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 26 of file GUIPrefs.h.

Constructor & Destructor Documentation

GUIPrefs()

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

Definition at line 40 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 47 of file GUIPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool GUIPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 162 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();
 
   DecibelScaleCutoff.Invalidate();
 
   return true;
}

References AColor::ApplyUpdatedImages(), DecibelScaleCutoff, ThemeBase::DeleteUnusedThemes(), eIsSavingToPrefs, audacity::BasicSettings::Flush(), gPrefs, Setting< T >::Invalidate(), ThemeBase::LoadPreferredTheme(), PopulateOrExchange(), audacity::BasicSettings::Read(), S, GUISettings::SetLang(), theTheme, audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

GetDescription()

TranslatableString GUIPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 56 of file GUIPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol GUIPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 51 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 61 of file GUIPrefs.cpp.

{
   return "Interface_Preferences";
}

Populate()

void GUIPrefs::Populate ( )

private

Definition at line 66 of file GUIPrefs.cpp.

{
   // First any pre-processing for constructing the GUI.
   Languages::GetLanguages(
      FileNames::AudacityPathList(), mLangCodes, mLangNames);
 
   WaveformSettings::GetRangeChoices(
      &mRangeChoices, &mRangeCodes, &mDefaultRangeIndex);
 
#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(), WaveformSettings::GetRangeChoices(), wxArrayStringEx::insert(), mDefaultRangeIndex, mLangCodes, mLangNames, 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 97 of file GUIPrefs.cpp.

{
   ChoiceSetting LanguageSetting{ wxT("/Locale/Language"),
      { ByColumns, mLangNames, mLangCodes }
   };
   ChoiceSetting DBSetting{ DecibelScaleCutoff,
      { ByColumns, mRangeChoices, mRangeCodes },
      mDefaultRangeIndex
   };
 
   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.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});
#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.EndScroller();
}

References ByColumns, DecibelScaleCutoff, GUITheme(), mDefaultRangeIndex, mLangCodes, mLangNames, mRangeChoices, mRangeCodes, S, 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

mDefaultRangeIndex

int GUIPrefs::mDefaultRangeIndex

private

Definition at line 46 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mLangCodes

wxArrayStringEx GUIPrefs::mLangCodes

private

Definition at line 41 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mLangNames

TranslatableStrings GUIPrefs::mLangNames

private

Definition at line 42 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mRangeChoices

TranslatableStrings GUIPrefs::mRangeChoices

private

Definition at line 45 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mRangeCodes

wxArrayStringEx GUIPrefs::mRangeCodes

private

Definition at line 44 of file GUIPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

---

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

• GUIPrefs.h
• GUIPrefs.cpp