SpectrumPrefs Class Reference

A PrefsPanel for spectrum settings. More...

#include <SpectrumPrefs.h>

Inheritance diagram for SpectrumPrefs:

Collaboration diagram for SpectrumPrefs:

Public Member Functions
	SpectrumPrefs (wxWindow *parent, wxWindowID winid, AudacityProject *pProject, WaveChannel *wc)
virtual	~SpectrumPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
void	Preview () override
bool	Commit () override
void	PopulateOrExchange (ShuttleGui &S) override
void	Rollback ()
bool	ShowsPreviewButton () override
bool	Validate () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
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 (size_t windowSize)
void	PopulatePaddingChoices (size_t windowSize)
void	OnControl (wxCommandEvent &event)
void	OnWindowSize (wxCommandEvent &event)
void	OnDefaults (wxCommandEvent &)
void	OnAlgorithm (wxCommandEvent &)
void	EnableDisableSTFTOnlyControls ()

Private Attributes
AudacityProject *	mProject {}
WaveChannel *const	mWc
bool	mDefaulted
bool	mOrigDefaulted
wxTextCtrl *	mMinFreq
wxTextCtrl *	mMaxFreq
wxTextCtrl *	mGain
wxTextCtrl *	mRange
wxTextCtrl *	mFrequencyGain
int	mZeroPaddingChoice
wxChoice *	mZeroPaddingChoiceCtrl
TranslatableStrings	mZeroPaddingChoices
TranslatableStrings	mTypeChoices
wxChoice *	mAlgorithmChoice
wxCheckBox *	mDefaultsCheckbox
SpectrogramSettings	mTempSettings
SpectrogramSettings	mOrigSettings
std::vector< WaveChannelSubViewPlacement >	mOrigPlacements
float	mOrigMin
float	mOrigMax
bool	mPopulating
bool	mCommitted {}

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 41 of file SpectrumPrefs.h.

Constructor & Destructor Documentation

SpectrumPrefs()

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

Definition at line 37 of file SpectrumPrefs.cpp.

:  PrefsPanel(parent, winid, wc ? XO("Spectrogram Settings") : XO("Spectrograms"))
, mProject{ pProject }
, mWc(wc)
, mPopulating(false)
{
   if (mWc) {
      auto &settings = SpectrogramSettings::Get(*wc);
      mOrigDefaulted = mDefaulted = (&SpectrogramSettings::defaults() == &settings);
      mTempSettings = mOrigSettings = settings;
      SpectrogramBounds::Get(*wc).GetBounds(*wc, mOrigMin, mOrigMax);
      mTempSettings.maxFreq = mOrigMax;
      mTempSettings.minFreq = mOrigMin;
      mOrigPlacements = WaveChannelView::Get(*mWc).SavePlacements();
   }
   else  {
      mTempSettings = mOrigSettings = SpectrogramSettings::defaults();
      mOrigDefaulted = mDefaulted = false;
   }
 
   const auto windowSize = mTempSettings.WindowSize();
   mTempSettings.ConvertToEnumeratedWindowSizes();
   Populate(windowSize);
}

References SpectrogramSettings::ConvertToEnumeratedWindowSizes(), SpectrogramSettings::defaults(), SpectrogramSettings::Get(), WaveChannelView::Get(), SpectrogramBounds::Get(), SpectrogramBounds::GetBounds(), SpectrogramSettings::maxFreq, mDefaulted, SpectrogramSettings::minFreq, mOrigDefaulted, mOrigMax, mOrigMin, mOrigPlacements, mOrigSettings, mTempSettings, mWc, Populate(), WaveChannelView::SavePlacements(), settings(), and SpectrogramSettings::WindowSize().

Here is the call graph for this function:

~SpectrumPrefs()

SpectrumPrefs::~SpectrumPrefs ( )

virtual

Definition at line 63 of file SpectrumPrefs.cpp.

{
   if (!mCommitted)
      Rollback();
}

References mCommitted, and Rollback().

Here is the call graph for this function:

Member Function Documentation

Commit()

bool SpectrumPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 481 of file SpectrumPrefs.cpp.

{
   if (!Validate())
      return false;
 
   mCommitted = true;
   SpectrogramSettings::Globals::Get().SavePrefs(); // always
   SpectrogramSettings *const pSettings = &SpectrogramSettings::defaults();
   if (!mWc || mDefaulted) {
      pSettings->SavePrefs();
   }
   pSettings->LoadPrefs(); // always; in case Globals changed
 
   return true;
}

References SpectrogramSettings::defaults(), SpectrogramSettings::Globals::Get(), SpectrogramSettings::LoadPrefs(), mCommitted, mDefaulted, mWc, SpectrogramSettings::Globals::SavePrefs(), SpectrogramSettings::SavePrefs(), and Validate().

Here is the call graph for this function:

EnableDisableSTFTOnlyControls()

void SpectrumPrefs::EnableDisableSTFTOnlyControls ( )

private

Definition at line 546 of file SpectrumPrefs.cpp.

{
   // Enable or disable other controls that are applicable only to STFT.
   const bool STFT =
      (mAlgorithmChoice->GetSelection() != SpectrogramSettings::algPitchEAC);
   mGain->Enable(STFT);
   mRange->Enable(STFT);
   mFrequencyGain->Enable(STFT);
   mZeroPaddingChoiceCtrl->Enable(STFT);
}

References SpectrogramSettings::algPitchEAC, mAlgorithmChoice, mFrequencyGain, mGain, mRange, and mZeroPaddingChoiceCtrl.

Referenced by OnAlgorithm(), and PopulateOrExchange().

Here is the caller graph for this function:

GetDescription()

TranslatableString SpectrumPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 74 of file SpectrumPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol SpectrumPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 69 of file SpectrumPrefs.cpp.

{
   return SPECTRUM_PREFS_PLUGIN_SYMBOL;
}

References SPECTRUM_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID SpectrumPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 79 of file SpectrumPrefs.cpp.

{
   // Currently (May2017) Spectrum Settings is the only preferences
   // we ever display in a dialog on its own without others.
   // We do so when it is configuring spectrums for a track.
   // Because this happens, we want to visit a different help page.
   // So we change the page name in the case of a page on its own.
   return mWc
      ? "Spectrogram_Settings"
      : "Spectrograms_Preferences";
}

References mWc.

OnAlgorithm()

void SpectrumPrefs::OnAlgorithm ( wxCommandEvent &  evt )

private

Definition at line 540 of file SpectrumPrefs.cpp.

{
   EnableDisableSTFTOnlyControls();
   OnControl(evt);
}

References EnableDisableSTFTOnlyControls(), and OnControl().

Here is the call graph for this function:

OnControl()

void SpectrumPrefs::OnControl ( wxCommandEvent &  event )

private

Definition at line 502 of file SpectrumPrefs.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 OnAlgorithm(), and OnWindowSize().

Here is the caller graph for this function:

OnDefaults()

void SpectrumPrefs::OnDefaults ( wxCommandEvent &  )

private

Definition at line 529 of file SpectrumPrefs.cpp.

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

References SpectrogramSettings::ConvertToEnumeratedWindowSizes(), SpectrogramSettings::defaults(), eIsSettingToDialog, mDefaulted, mDefaultsCheckbox, mTempSettings, PopulateOrExchange(), and S.

Here is the call graph for this function:

OnWindowSize()

void SpectrumPrefs::OnWindowSize ( wxCommandEvent &  event )

private

Definition at line 515 of file SpectrumPrefs.cpp.

{
   // Restrict choice of zero padding, so that product of window
   // size and padding may not exceed the largest window size.
   wxChoice *const pWindowSizeControl =
      static_cast<wxChoice*>(wxWindow::FindWindowById(ID_WINDOW_SIZE, this));
   size_t windowSize = 1 <<
      (pWindowSizeControl->GetSelection() + SpectrogramSettings::LogMinWindowSize);
   PopulatePaddingChoices(windowSize);
 
   // Do the common part
   OnControl(evt);
}

References ID_WINDOW_SIZE, SpectrogramSettings::LogMinWindowSize, OnControl(), and PopulatePaddingChoices().

Here is the call graph for this function:

Populate()

void SpectrumPrefs::Populate ( size_t  windowSize )

private

Definition at line 107 of file SpectrumPrefs.cpp.

{
   PopulatePaddingChoices(windowSize);
 
   for (int i = 0; i < NumWindowFuncs(); i++) {
      mTypeChoices.push_back( WindowFuncName(i) );
   }
 
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreatingFromPrefs, mTypeChoices, NumWindowFuncs(), PopulateOrExchange(), PopulatePaddingChoices(), S, and WindowFuncName().

Referenced by SpectrumPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void SpectrumPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 160 of file SpectrumPrefs.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.StartMultiColumn(2,wxEXPAND);
   {
      S.SetStretchyCol( 0 );
      S.SetStretchyCol( 1 );
      S.StartStatic(XO("Scale"),1);
      {
         S.StartMultiColumn(2,wxEXPAND);
         {
            S.SetStretchyCol( 0 );
            S.SetStretchyCol( 1 );
            S.Id(ID_SCALE).TieChoice(XXO("S&cale:"),
               mTempSettings.scaleType,
               Msgids( SpectrogramSettings::GetScaleNames() ) );
            mMinFreq =
               S.Id(ID_MINIMUM).TieNumericTextBox(XXO("Mi&n Frequency (Hz):"),
               mTempSettings.minFreq,
               12);
            mMaxFreq =
               S.Id(ID_MAXIMUM).TieNumericTextBox(XXO("Ma&x Frequency (Hz):"),
               mTempSettings.maxFreq,
               12);
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
 
      S.StartStatic(XO("Colors"),1);
      {
         S.StartMultiColumn(2,wxEXPAND);
         {
            S.SetStretchyCol( 0 );
            S.SetStretchyCol( 1 );
            mGain =
               S.Id(ID_GAIN).TieNumericTextBox(XXO("&Gain (dB):"),
               mTempSettings.gain,
               8);
            mRange =
               S.Id(ID_RANGE).TieNumericTextBox(XXO("&Range (dB):"),
               mTempSettings.range,
               8);
 
            mFrequencyGain =
               S.Id(ID_FREQUENCY_GAIN).TieNumericTextBox(XXO("High &boost (dB/dec):"),
               mTempSettings.frequencyGain,
               8);
 
            // i18n-hint Scheme refers to a color scheme for spectrogram colors
            S.Id(ID_COLOR_SCHEME).TieChoice(XC("Sche&me:", "spectrum prefs"),
               (int&)mTempSettings.colorScheme,
               Msgids( SpectrogramSettings::GetColorSchemeNames() ) );
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
   }
   S.EndMultiColumn();
 
   S.StartStatic(XO("Algorithm"));
   {
      S.StartMultiColumn(2);
      {
         mAlgorithmChoice =
            S.Id(ID_ALGORITHM).TieChoice(XXO("A&lgorithm:"),
            mTempSettings.algorithm,
            SpectrogramSettings::GetAlgorithmNames() );
 
         S.Id(ID_WINDOW_SIZE).TieChoice(XXO("Window &size:"),
            mTempSettings.windowSize,
            {
               XO("8 - most wideband"),
               XO("16"),
               XO("32"),
               XO("64"),
               XO("128"),
               XO("256"),
               XO("512"),
               XO("1024"),
               XO("2048"),
               XO("4096"),
               XO("8192"),
               XO("16384"),
               XO("32768 - most narrowband"),
            }
         );
 
         S.Id(ID_WINDOW_TYPE).TieChoice(XXO("Window &type:"),
            mTempSettings.windowType,
            mTypeChoices);
 
         mZeroPaddingChoiceCtrl =
            S.Id(ID_PADDING_SIZE).TieChoice(XXO("&Zero padding factor:"),
            mTempSettings.zeroPaddingFactor,
            mZeroPaddingChoices);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
#ifndef SPECTRAL_SELECTION_GLOBAL_SWITCH
   S.Id(ID_SPECTRAL_SELECTION).TieCheckBox(XXO("Ena&ble Spectral Selection"),
      mTempSettings.spectralSelection);
#endif
 
#ifdef EXPERIMENTAL_FFT_Y_GRID
         S.TieCheckBox(XO("Show a grid along the &Y-axis"),
            mTempSettings.fftYGrid);
#endif //EXPERIMENTAL_FFT_Y_GRID
 
#ifdef EXPERIMENTAL_FIND_NOTES
      /* i18n-hint: FFT stands for Fast Fourier Transform and probably shouldn't be translated*/
      S.StartStatic(XO("FFT Find Notes"));
      {
         S.StartTwoColumn();
         {
            mFindNotesMinA =
               S.TieNumericTextBox(XXO("Minimum Amplitude (dB):"),
               mTempSettings.findNotesMinA,
               8);
 
            mFindNotesN =
               S.TieNumericTextBox(XXO("Max. Number of Notes (1..128):"),
               mTempSettings.numberOfMaxima,
               8);
         }
         S.EndTwoColumn();
 
         S.TieCheckBox(XXO("&Find Notes"),
            mTempSettings.fftFindNotes);
 
         S.TieCheckBox(XXO("&Quantize Notes"),
            mTempSettings.findNotesQuantize);
      }
      S.EndStatic();
#endif //EXPERIMENTAL_FIND_NOTES
   // S.EndStatic();
 
#ifdef SPECTRAL_SELECTION_GLOBAL_SWITCH
   S.StartStatic(XO("Global settings"));
   {
      S.TieCheckBox(XXO("Ena&ble spectral selection"),
         SpectrogramSettings::Globals::Get().spectralSelection);
   }
   S.EndStatic();
#endif
 
   } S.EndScroller();
   
   // Enabling and disabling belongs outside this function.
   if( S.GetMode() != eIsGettingMetadata )
      EnableDisableSTFTOnlyControls();
 
   mPopulating = false;
}

References SpectrogramSettings::algorithm, SpectrogramSettings::colorScheme, eIsGettingMetadata, EnableDisableSTFTOnlyControls(), SpectrogramSettings::frequencyGain, SpectrogramSettings::gain, SpectrogramSettings::Globals::Get(), SpectrogramSettings::GetAlgorithmNames(), SpectrogramSettings::GetColorSchemeNames(), SpectrogramSettings::GetScaleNames(), ID_ALGORITHM, ID_COLOR_SCHEME, ID_DEFAULTS, ID_FREQUENCY_GAIN, ID_GAIN, ID_MAXIMUM, ID_MINIMUM, ID_PADDING_SIZE, ID_RANGE, ID_SCALE, ID_SPECTRAL_SELECTION, ID_WINDOW_SIZE, ID_WINDOW_TYPE, mAlgorithmChoice, SpectrogramSettings::maxFreq, mDefaulted, mDefaultsCheckbox, mFrequencyGain, mGain, SpectrogramSettings::minFreq, mMaxFreq, mMinFreq, mPopulating, mRange, Msgids(), mTempSettings, mTypeChoices, mWc, mZeroPaddingChoiceCtrl, mZeroPaddingChoices, SpectrogramSettings::range, S, SpectrogramSettings::scaleType, SpectrogramSettings::spectralSelection, SpectrogramSettings::windowSize, SpectrogramSettings::windowType, XC, XO(), XXO(), and SpectrogramSettings::zeroPaddingFactor.

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

Here is the call graph for this function:

Here is the caller graph for this function:

PopulatePaddingChoices()

void SpectrumPrefs::PopulatePaddingChoices ( size_t  windowSize )

private

Definition at line 122 of file SpectrumPrefs.cpp.

{
   mZeroPaddingChoice = 1;
 
   // The choice of window size restricts the choice of padding.
   // So the padding menu might grow or shrink.
 
   // If pPaddingSizeControl is NULL, we have not yet tied the choice control.
   // If it is not NULL, we rebuild the control by hand.
   // I don't yet know an easier way to do this with ShuttleGUI functions.
   // PRL
   wxChoice *const pPaddingSizeControl =
      static_cast<wxChoice*>(wxWindow::FindWindowById(ID_PADDING_SIZE, this));
 
   if (pPaddingSizeControl) {
      mZeroPaddingChoice = pPaddingSizeControl->GetSelection();
      pPaddingSizeControl->Clear();
   }
 
   unsigned padding = 1;
   int numChoices = 0;
   const size_t maxWindowSize = 1 << (SpectrogramSettings::LogMaxWindowSize);
   while (windowSize <= maxWindowSize) {
      const auto numeral = wxString::Format(wxT("%d"), padding);
      mZeroPaddingChoices.push_back( Verbatim( numeral ) );
      if (pPaddingSizeControl)
         pPaddingSizeControl->Append(numeral);
      windowSize <<= 1;
      padding <<= 1;
      ++numChoices;
   }
 
   mZeroPaddingChoice = std::min(mZeroPaddingChoice, numChoices - 1);
 
   if (pPaddingSizeControl)
      pPaddingSizeControl->SetSelection(mZeroPaddingChoice);
}

References ID_PADDING_SIZE, SpectrogramSettings::LogMaxWindowSize, min(), mZeroPaddingChoice, mZeroPaddingChoices, Verbatim(), and wxT().

Referenced by OnWindowSize(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Preview()

void SpectrumPrefs::Preview ( )

overridevirtual

Reimplemented from PrefsPanel.

Definition at line 428 of file SpectrumPrefs.cpp.

{
   if (!Validate())
      return;
 
   const bool isOpenPage = this->IsShown();
 
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
 
   mTempSettings.ConvertToActualWindowSizes();
 
   if (mWc) {
      if (mDefaulted) {
         SpectrogramSettings::Reset(*mWc);
         // ... and so that the vertical scale also defaults:
         SpectrogramBounds::Get(*mWc).SetBounds(-1, -1);
      }
      else {
         SpectrogramSettings &settings = SpectrogramSettings::Own(*mWc);
         SpectrogramBounds::Get(*mWc)
            .SetBounds(mTempSettings.minFreq, mTempSettings.maxFreq);
         settings = mTempSettings;
      }
   }
 
   if (!mWc || mDefaulted) {
      SpectrogramSettings *const pSettings = &SpectrogramSettings::defaults();
      *pSettings = mTempSettings;
   }
   mTempSettings.ConvertToEnumeratedWindowSizes();
 
   // Bug 2278
   // This code destroys any Multi-view we had.
   // Commenting it out as it seems not to be needed.
   /*
   if (mWt && isOpenPage) {
      for (auto &&channel : mWt->Channels())
         WaveChannelView::Get(*channel)
            .SetDisplay(WaveChannelViewConstants::Spectrum);
   }
   */
 
   if (isOpenPage) {
      if ( mProject ) {
         auto &tp = TrackPanel::Get( *mProject );
         tp.UpdateVRulers();
         tp.Refresh(false);
      }
   }
}

References SpectrogramSettings::ConvertToActualWindowSizes(), SpectrogramSettings::ConvertToEnumeratedWindowSizes(), SpectrogramSettings::defaults(), eIsSavingToPrefs, TrackPanel::Get(), SpectrogramBounds::Get(), SpectrogramSettings::maxFreq, mDefaulted, SpectrogramSettings::minFreq, mProject, mTempSettings, mWc, SpectrogramSettings::Own(), PopulateOrExchange(), SpectrogramSettings::Reset(), S, SpectrogramBounds::SetBounds(), settings(), and Validate().

Here is the call graph for this function:

Rollback()

void SpectrumPrefs::Rollback

(

)

Definition at line 395 of file SpectrumPrefs.cpp.

{
   if (mWc) {
      if (mOrigDefaulted) {
         SpectrogramSettings::Reset(*mWc);
         SpectrogramBounds::Get(*mWc).SetBounds(-1, -1);
      }
      else {
         auto &settings = SpectrogramSettings::Own(*mWc);
         SpectrogramBounds::Get(*mWc).SetBounds(mOrigMin, mOrigMax);
         settings = mOrigSettings;
      }
   }
 
   if (!mWc || mOrigDefaulted) {
      SpectrogramSettings *const pSettings = &SpectrogramSettings::defaults();
      *pSettings = mOrigSettings;
   }
 
   const bool isOpenPage = this->IsShown();
   if (mWc && isOpenPage) {
      WaveChannelView::Get(*mWc).RestorePlacements(mOrigPlacements);
   }
 
   if (isOpenPage) {
      if ( mProject ) {
         auto &tp = TrackPanel::Get ( *mProject );
         tp.UpdateVRulers();
         tp.Refresh(false);
      }
   }
}

References SpectrogramSettings::defaults(), TrackPanel::Get(), WaveChannelView::Get(), SpectrogramBounds::Get(), mOrigDefaulted, mOrigMax, mOrigMin, mOrigPlacements, mOrigSettings, mProject, mWc, SpectrogramSettings::Own(), SpectrogramSettings::Reset(), WaveChannelView::RestorePlacements(), SpectrogramBounds::SetBounds(), and settings().

Referenced by ~SpectrumPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowsPreviewButton()

bool SpectrumPrefs::ShowsPreviewButton ( )

overridevirtual

Reimplemented from PrefsPanel.

Definition at line 497 of file SpectrumPrefs.cpp.

{
   return mProject != nullptr;
}

References mProject.

Validate()

bool SpectrumPrefs::Validate ( )

override

Definition at line 330 of file SpectrumPrefs.cpp.

{
   // Do checking for whole numbers
 
   // ToDo: use wxIntegerValidator<unsigned> when available
 
   long maxFreq;
   if (!mMaxFreq->GetValue().ToLong(&maxFreq)) {
      AudacityMessageBox( XO("The maximum frequency must be an integer") );
      return false;
   }
 
   long minFreq;
   if (!mMinFreq->GetValue().ToLong(&minFreq)) {
      AudacityMessageBox( XO("The minimum frequency must be an integer") );
      return false;
   }
 
   long gain;
   if (!mGain->GetValue().ToLong(&gain)) {
      AudacityMessageBox( XO("The gain must be an integer") );
      return false;
   }
 
   long range;
   if (!mRange->GetValue().ToLong(&range)) {
      AudacityMessageBox( XO("The range must be a positive integer") );
      return false;
   }
 
   long frequencygain;
   if (!mFrequencyGain->GetValue().ToLong(&frequencygain)) {
      AudacityMessageBox( XO("The frequency gain must be an integer") );
      return false;
   }
 
#ifdef EXPERIMENTAL_FIND_NOTES
   long findNotesMinA;
   if (!mFindNotesMinA->GetValue().ToLong(&findNotesMinA)) {
      AudacityMessageBox( XO("The minimum amplitude (dB) must be an integer") );
      return false;
   }
 
   long findNotesN;
   if (!mFindNotesN->GetValue().ToLong(&findNotesN)) {
      AudacityMessageBox( XO("The maximum number of notes must be an integer") );
      return false;
   }
   if (findNotesN < 1 || findNotesN > 128) {
      AudacityMessageBox( XO(
"The maximum number of notes must be in the range 1..128") );
      return false;
   }
#endif //EXPERIMENTAL_FIND_NOTES
 
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   // Delegate range checking to SpectrogramSettings class
   mTempSettings.ConvertToActualWindowSizes();
   const bool result = mTempSettings.Validate(false);
   mTempSettings.ConvertToEnumeratedWindowSizes();
   return result;
}

References AudacityMessageBox(), SpectrogramSettings::ConvertToActualWindowSizes(), SpectrogramSettings::ConvertToEnumeratedWindowSizes(), eIsSavingToPrefs, mFrequencyGain, mGain, mMaxFreq, mMinFreq, mRange, mTempSettings, PopulateOrExchange(), S, SpectrogramSettings::Validate(), and XO().

Referenced by Commit(), and Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mAlgorithmChoice

wxChoice* SpectrumPrefs::mAlgorithmChoice

private

Definition at line 90 of file SpectrumPrefs.h.

Referenced by EnableDisableSTFTOnlyControls(), and PopulateOrExchange().

mCommitted

bool SpectrumPrefs::mCommitted {}

private

Definition at line 106 of file SpectrumPrefs.h.

Referenced by Commit(), and ~SpectrumPrefs().

mDefaulted

bool SpectrumPrefs::mDefaulted

private

Definition at line 73 of file SpectrumPrefs.h.

Referenced by Commit(), OnControl(), OnDefaults(), PopulateOrExchange(), Preview(), and SpectrumPrefs().

mDefaultsCheckbox

wxCheckBox* SpectrumPrefs::mDefaultsCheckbox

private

Definition at line 98 of file SpectrumPrefs.h.

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

mFrequencyGain

wxTextCtrl* SpectrumPrefs::mFrequencyGain

private

Definition at line 79 of file SpectrumPrefs.h.

Referenced by EnableDisableSTFTOnlyControls(), PopulateOrExchange(), and Validate().

mGain

wxTextCtrl* SpectrumPrefs::mGain

private

Definition at line 77 of file SpectrumPrefs.h.

Referenced by EnableDisableSTFTOnlyControls(), PopulateOrExchange(), and Validate().

mMaxFreq

wxTextCtrl* SpectrumPrefs::mMaxFreq

private

Definition at line 76 of file SpectrumPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mMinFreq

wxTextCtrl* SpectrumPrefs::mMinFreq

private

Definition at line 75 of file SpectrumPrefs.h.

Referenced by PopulateOrExchange(), and Validate().

mOrigDefaulted

bool SpectrumPrefs::mOrigDefaulted

private

Definition at line 73 of file SpectrumPrefs.h.

Referenced by Rollback(), and SpectrumPrefs().

mOrigMax

float SpectrumPrefs::mOrigMax

private

Definition at line 103 of file SpectrumPrefs.h.

Referenced by Rollback(), and SpectrumPrefs().

mOrigMin

float SpectrumPrefs::mOrigMin

private

Definition at line 103 of file SpectrumPrefs.h.

Referenced by Rollback(), and SpectrumPrefs().

mOrigPlacements

std::vector<WaveChannelSubViewPlacement> SpectrumPrefs::mOrigPlacements

private

Definition at line 102 of file SpectrumPrefs.h.

Referenced by Rollback(), and SpectrumPrefs().

mOrigSettings

SpectrogramSettings SpectrumPrefs::mOrigSettings

private

Definition at line 100 of file SpectrumPrefs.h.

Referenced by Rollback(), and SpectrumPrefs().

mPopulating

bool SpectrumPrefs::mPopulating

private

Definition at line 105 of file SpectrumPrefs.h.

Referenced by OnControl(), and PopulateOrExchange().

mProject

AudacityProject* SpectrumPrefs::mProject {}

private

Definition at line 70 of file SpectrumPrefs.h.

Referenced by Preview(), Rollback(), and ShowsPreviewButton().

mRange

wxTextCtrl* SpectrumPrefs::mRange

private

Definition at line 78 of file SpectrumPrefs.h.

Referenced by EnableDisableSTFTOnlyControls(), PopulateOrExchange(), and Validate().

mTempSettings

SpectrogramSettings SpectrumPrefs::mTempSettings

private

Definition at line 100 of file SpectrumPrefs.h.

Referenced by OnDefaults(), PopulateOrExchange(), Preview(), SpectrumPrefs(), and Validate().

mTypeChoices

TranslatableStrings SpectrumPrefs::mTypeChoices

private

Definition at line 88 of file SpectrumPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mWc

WaveChannel* const SpectrumPrefs::mWc

private

Definition at line 72 of file SpectrumPrefs.h.

Referenced by Commit(), HelpPageName(), PopulateOrExchange(), Preview(), Rollback(), and SpectrumPrefs().

mZeroPaddingChoice

int SpectrumPrefs::mZeroPaddingChoice

private

Definition at line 84 of file SpectrumPrefs.h.

Referenced by PopulatePaddingChoices().

mZeroPaddingChoiceCtrl

wxChoice* SpectrumPrefs::mZeroPaddingChoiceCtrl

private

Definition at line 85 of file SpectrumPrefs.h.

Referenced by EnableDisableSTFTOnlyControls(), and PopulateOrExchange().

mZeroPaddingChoices

TranslatableStrings SpectrumPrefs::mZeroPaddingChoices

private

Definition at line 86 of file SpectrumPrefs.h.

Referenced by PopulateOrExchange(), and PopulatePaddingChoices().

---

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

• SpectrumPrefs.h
• SpectrumPrefs.cpp