WaveformPrefs Class Reference

A PrefsPanel for spectrum settings. More...

#include <WaveformPrefs.h>

Inheritance diagram for WaveformPrefs:

Collaboration diagram for WaveformPrefs:

Public Member Functions
	WaveformPrefs (wxWindow *parent, wxWindowID winid, AudacityProject *pProject, WaveChannel *wc)
virtual	~WaveformPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
bool	Commit () override
bool	ShowsPreviewButton () override
bool	Validate () override
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 ()
void	OnControl (wxCommandEvent &)
void	OnScale (wxCommandEvent &)
void	OnDefaults (wxCommandEvent &)
void	EnableDisableRange ()

Private Attributes
AudacityProject *	mProject {}
WaveChannel *const	mWc
bool	mDefaulted
wxCheckBox *	mDefaultsCheckbox
wxChoice *	mScaleChoice
wxChoice *	mRangeChoice
wxArrayStringEx	mRangeCodes
TranslatableStrings	mRangeChoices
WaveformSettings	mTempSettings
bool	mPopulating

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 spectrum settings.

Definition at line 25 of file WaveformPrefs.h.

Constructor & Destructor Documentation

WaveformPrefs()

WaveformPrefs::WaveformPrefs	(	wxWindow *	parent,
		wxWindowID	winid,
		AudacityProject *	pProject,
		WaveChannel *	wc
	)

Definition at line 33 of file WaveformPrefs.cpp.

: PrefsPanel(parent, winid, XO("Waveforms"))
, mProject{ pProject }
, mWc(wc)
, mPopulating(false)
{
   if (mWc) {
      auto &settings = WaveformSettings::Get(*wc);
      mDefaulted = (&WaveformSettings::defaults() == &settings);
      mTempSettings = settings;
   }
   else  {
      mTempSettings = WaveformSettings::defaults();
      mDefaulted = false;
   }
 
   mTempSettings.ConvertToEnumeratedDBRange();
   Populate();
}

References WaveformSettings::ConvertToEnumeratedDBRange(), WaveformSettings::defaults(), WaveformSettings::Get(), mDefaulted, mTempSettings, mWc, Populate(), and settings().

Here is the call graph for this function:

~WaveformPrefs()

WaveformPrefs::~WaveformPrefs ( )

virtual

Definition at line 55 of file WaveformPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool WaveformPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 158 of file WaveformPrefs.cpp.

{
   const bool isOpenPage = this->IsShown();
 
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
 
   mTempSettings.ConvertToActualDBRange();
   WaveformSettings::Globals::Get().SavePrefs();
 
   if (mWc) {
      if (mDefaulted)
         WaveformSettings::Set(*mWc, {});
      else {
         auto &settings = WaveformSettings::Get(*mWc);
         settings = mTempSettings;
      }
   }
 
   WaveformSettings *const pSettings = &WaveformSettings::defaults();
   if (!mWc || mDefaulted) {
      *pSettings = mTempSettings;
      pSettings->SavePrefs();
   }
   pSettings->LoadPrefs(); // always; in case Globals changed
 
   mTempSettings.ConvertToEnumeratedDBRange();
 
   if (mWc && isOpenPage) {
      WaveChannelView::Get(*mWc).SetDisplay(WaveChannelViewConstants::Waveform);
   }
 
   if (isOpenPage) {
      if ( mProject ) {
         auto &tp = TrackPanel::Get( *mProject );
         tp.UpdateVRulers();
         tp.Refresh(false);
      }
   }
 
   return true;
}

References WaveformSettings::ConvertToActualDBRange(), WaveformSettings::ConvertToEnumeratedDBRange(), WaveformSettings::defaults(), eIsGettingFromDialog, WaveformSettings::Globals::Get(), TrackPanel::Get(), WaveformSettings::Get(), WaveChannelView::Get(), WaveformSettings::LoadPrefs(), mDefaulted, mProject, mTempSettings, mWc, PopulateOrExchange(), S, WaveformSettings::Globals::SavePrefs(), WaveformSettings::SavePrefs(), WaveformSettings::Set(), WaveChannelView::SetDisplay(), settings(), and WaveChannelViewConstants::Waveform.

Here is the call graph for this function:

EnableDisableRange()

void WaveformPrefs::EnableDisableRange ( )

private

Definition at line 238 of file WaveformPrefs.cpp.

{
   mRangeChoice->Enable(
      mScaleChoice->GetSelection() == WaveformSettings::stLogarithmicDb);
}

References mRangeChoice, mScaleChoice, and WaveformSettings::stLogarithmicDb.

Referenced by OnScale(), and PopulateOrExchange().

Here is the caller graph for this function:

GetDescription()

TranslatableString WaveformPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 64 of file WaveformPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol WaveformPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 59 of file WaveformPrefs.cpp.

{
   return WAVEFORM_PREFS_PLUGIN_SYMBOL;
}

References WAVEFORM_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID WaveformPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 69 of file WaveformPrefs.cpp.

{
   return "Waveform_Preferences";
}

OnControl()

void WaveformPrefs::OnControl ( wxCommandEvent &  )

private

Definition at line 206 of file WaveformPrefs.cpp.

{
   // Common routine for most controls
   // If any per-track setting is changed, break the association with defaults
   // Skip this, and View Settings... will be able to change defaults instead
   // when the checkbox is on, as in the original design.
 
   if (mDefaultsCheckbox && !mPopulating) {
      mDefaulted = false;
      mDefaultsCheckbox->SetValue(false);
   }
}

References mDefaulted, mDefaultsCheckbox, and mPopulating.

Referenced by OnScale().

Here is the caller graph for this function:

OnDefaults()

void WaveformPrefs::OnDefaults ( wxCommandEvent &  )

private

Definition at line 227 of file WaveformPrefs.cpp.

{
   if (mDefaultsCheckbox->IsChecked()) {
      mTempSettings = WaveformSettings::defaults();
      mTempSettings.ConvertToEnumeratedDBRange();
      mDefaulted = true;
      ShuttleGui S(this, eIsSettingToDialog);
      PopulateOrExchange(S);
   }
}

References WaveformSettings::ConvertToEnumeratedDBRange(), WaveformSettings::defaults(), eIsSettingToDialog, mDefaulted, mDefaultsCheckbox, mTempSettings, PopulateOrExchange(), and S.

Here is the call graph for this function:

OnScale()

void WaveformPrefs::OnScale ( wxCommandEvent &  e )

private

Definition at line 219 of file WaveformPrefs.cpp.

{
   EnableDisableRange();
 
   // do the common part
   OnControl(e);
}

References EnableDisableRange(), and OnControl().

Here is the call graph for this function:

Populate()

void WaveformPrefs::Populate ( )

private

Definition at line 81 of file WaveformPrefs.cpp.

{
   // Reuse the same choices and codes as for Interface prefs
   WaveformSettings::GetRangeChoices(&mRangeChoices, &mRangeCodes);
 
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreatingFromPrefs, WaveformSettings::GetRangeChoices(), mRangeChoices, mRangeCodes, PopulateOrExchange(), and S.

Referenced by WaveformPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void WaveformPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 93 of file WaveformPrefs.cpp.

{
   mPopulating = true;
 
   S.SetBorder(2);
   S.StartScroller();
 
   // S.StartStatic(XO("Track Settings"));
   {
      mDefaultsCheckbox = 0;
      if (mWc) {
         /* i18n-hint: use is a verb */
         mDefaultsCheckbox = S.Id(ID_DEFAULTS).TieCheckBox(XXO("&Use Preferences"), mDefaulted);
      }
 
      S.StartStatic(XO("Display"));
      {
         S.StartTwoColumn();
         {
            mScaleChoice =
               S.Id(ID_SCALE).TieChoice(XXO("S&cale:"),
                  mTempSettings.scaleType,
                  Msgids( WaveformSettings::GetScaleNames() ) );
 
            mRangeChoice =
               S.Id(ID_RANGE).TieChoice(XXO("Waveform dB &range:"),
               mTempSettings.dBRange,
               mRangeChoices);
         }
         S.EndTwoColumn();
      }
      S.EndStatic();
   }
   // S.EndStatic();
 
   /*
   S.StartStatic(XO("Global settings"));
   {
   }
   S.EndStatic();
   */
 
   S.EndScroller();
 
   EnableDisableRange();
 
   mPopulating = false;
}

References WaveformSettings::dBRange, EnableDisableRange(), WaveformSettings::GetScaleNames(), ID_DEFAULTS, ID_RANGE, ID_SCALE, mDefaulted, mDefaultsCheckbox, mPopulating, mRangeChoice, mRangeChoices, mScaleChoice, Msgids(), mTempSettings, mWc, S, WaveformSettings::scaleType, XO(), and XXO().

Referenced by Commit(), OnDefaults(), Populate(), and Validate().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowsPreviewButton()

bool WaveformPrefs::ShowsPreviewButton ( )

overridevirtual

Reimplemented from PrefsPanel.

Definition at line 201 of file WaveformPrefs.cpp.

{
   return true;
}

Validate()

bool WaveformPrefs::Validate ( )

override

Definition at line 142 of file WaveformPrefs.cpp.

{
   // Do checking for whole numbers
 
   // ToDo: use wxIntegerValidator<unsigned> when available
 
   ShuttleGui S(this, eIsGettingFromDialog);
   PopulateOrExchange(S);
 
   // Delegate range checking to WaveformSettings class
   mTempSettings.ConvertToActualDBRange();
   const bool result = mTempSettings.Validate(false);
   mTempSettings.ConvertToEnumeratedDBRange();
   return result;
}

References WaveformSettings::ConvertToActualDBRange(), WaveformSettings::ConvertToEnumeratedDBRange(), eIsGettingFromDialog, mTempSettings, PopulateOrExchange(), S, and WaveformSettings::Validate().

Here is the call graph for this function:

Member Data Documentation

mDefaulted

bool WaveformPrefs::mDefaulted

private

Definition at line 53 of file WaveformPrefs.h.

Referenced by Commit(), OnControl(), OnDefaults(), PopulateOrExchange(), and WaveformPrefs().

mDefaultsCheckbox

wxCheckBox* WaveformPrefs::mDefaultsCheckbox

private

Definition at line 55 of file WaveformPrefs.h.

Referenced by OnControl(), OnDefaults(), and PopulateOrExchange().

mPopulating

bool WaveformPrefs::mPopulating

private

Definition at line 64 of file WaveformPrefs.h.

Referenced by OnControl(), and PopulateOrExchange().

mProject

AudacityProject* WaveformPrefs::mProject {}

private

Definition at line 50 of file WaveformPrefs.h.

Referenced by Commit().

mRangeChoice

wxChoice* WaveformPrefs::mRangeChoice

private

Definition at line 57 of file WaveformPrefs.h.

Referenced by EnableDisableRange(), and PopulateOrExchange().

mRangeChoices

TranslatableStrings WaveformPrefs::mRangeChoices

private

Definition at line 60 of file WaveformPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mRangeCodes

wxArrayStringEx WaveformPrefs::mRangeCodes

private

Definition at line 59 of file WaveformPrefs.h.

Referenced by Populate().

mScaleChoice

wxChoice* WaveformPrefs::mScaleChoice

private

Definition at line 56 of file WaveformPrefs.h.

Referenced by EnableDisableRange(), and PopulateOrExchange().

mTempSettings

WaveformSettings WaveformPrefs::mTempSettings

private

Definition at line 62 of file WaveformPrefs.h.

Referenced by Commit(), OnDefaults(), PopulateOrExchange(), Validate(), and WaveformPrefs().

mWc

WaveChannel* const WaveformPrefs::mWc

private

Definition at line 52 of file WaveformPrefs.h.

Referenced by Commit(), PopulateOrExchange(), and WaveformPrefs().

---

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

• WaveformPrefs.h
• WaveformPrefs.cpp