(not quite a Toolbar) at foot of screen for setting and viewing the frequency selection range. More...

#include <SpectralSelectionBar.h>

Inheritance diagram for SpectralSelectionBar:

Collaboration diagram for SpectralSelectionBar:

Public Member Functions
	SpectralSelectionBar (AudacityProject &project)

virtual	~SpectralSelectionBar ()

bool	ShownByDefault () const override
	Whether the toolbar should be shown by default. Default implementation returns true. More...

DockID	DefaultDockID () const override
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

void	Create (wxWindow *parent) override

void	Populate () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	UpdatePrefs () override

void	SetFrequencies (double bottom, double top)

void	SetFrequencySelectionFormatName (const NumericFormatID &formatName)

void	SetBandwidthSelectionFormatName (const NumericFormatID &formatName)

void	RegenerateTooltips () override

Public Member Functions inherited from ToolBar
	ToolBar (AudacityProject &project, const TranslatableString &label, const Identifier &section, bool resizable=false)

virtual	~ToolBar ()

virtual bool	ShownByDefault () const
	Whether the toolbar should be shown by default. Default implementation returns true. More...

virtual bool	HideAfterReset () const
	Default implementation returns false. More...

virtual DockID	DefaultDockID () const
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

virtual void	SetToDefaultSize ()

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

virtual void	RegenerateTooltips ()=0

int	GetIndex () const
	Get a value used for computing cascading positions of undocked bars. More...

void	SetIndex (int index)
	Set a value used for computing cascading positions of undocked bars. More...

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

Identifier	GetSection ()

ToolDock *	GetDock ()

void	SetPreferredNeighbors (Identifier left, Identifier top={})

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

std::pair< Identifier, Identifier >	PreferredNeighbors () const noexcept
	Defaults to (NoBarID, NoBarId) More...

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

virtual int	GetInitialWidth ()
	Resizable toolbars should implement these. More...

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

wxSize	GetSmartDockedSize ()

virtual void	ResizingDone ()

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 Identifier	ID ()

static SpectralSelectionBar &	Get (AudacityProject &project)

static const SpectralSelectionBar &	Get (const AudacityProject &project)

Static Public Member Functions inherited from ToolBar
static AButton *	MakeButton (wxWindow *parent, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxWindowID id, wxPoint placement, bool processdownevents, wxSize size)

static AButton *	MakeButton (ToolBar *parent, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, bool processdownevents, const TranslatableString &label)

static void	MakeAlternateImages (AButton &button, int idx, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxSize size)

static void	SetButtonToolTip (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)

static void	MakeButtonBackgroundsSmall ()

static void	MakeButtonBackgroundsLarge ()

Private Member Functions
void	ValuesToControls ()

void	SetBounds ()

void	OnFormatsChanged (ProjectNumericFormatsEvent)

void	OnUpdate (wxCommandEvent &evt)

void	OnCtrl (wxCommandEvent &evt)

void	OnChoice (wxCommandEvent &evt)

void	OnIdle (wxIdleEvent &evt)

void	OnSize (wxSizeEvent &evt)

void	ModifySpectralSelection (bool done=false)

Private Attributes
Observer::Subscription	mFormatsSubscription

bool	mbCenterAndWidth

double	mCenter

double	mWidth

double	mLow

double	mHigh

NumericTextCtrl *	mCenterCtrl

NumericTextCtrl *	mWidthCtrl

NumericTextCtrl *	mLowCtrl

NumericTextCtrl *	mHighCtrl

wxChoice *	mChoice

int	mHeight

Additional Inherited Members
Public Types inherited from ToolBar
enum	DockID { TopDockID = 1 , BotDockID = 2 }
	Identifies one of the docking areas for toolbars. More...

using	Holder = wxWindowPtr< ToolBar >

Protected Member Functions inherited from ToolBar
void	SetButton (bool down, AButton *button)

wxBoxSizer *	GetSizer ()

void	Add (wxWindow window, int proportion=0, int flag=wxALIGN_TOP, int border=0, wxObject userData=NULL)

void	Add (wxSizer sizer, int proportion=0, int flag=0, int border=0, wxObject userData=NULL)

void	Add (int width, int height, int proportion=0, int flag=0, int border=0, wxObject *userData=NULL)

void	AddSpacer (int size=14)

void	AddStretchSpacer (int prop=1)

void	Detach (wxWindow *window)

void	Detach (wxSizer *sizer)

void	Updated ()

int	GetResizeGrabberWidth ()
	Returns the width in pixels of the resizer element. More...

virtual void	Populate ()=0

virtual void	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

Static Protected Member Functions inherited from ToolBar
static void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeMacRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

Static Protected Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Protected Attributes inherited from ToolBar
AudacityProject &	mProject

TranslatableString	mLabel

Identifier	mSection

int	mIndex {0}

Detailed Description

(not quite a Toolbar) at foot of screen for setting and viewing the frequency selection range.

Definition at line 29 of file SpectralSelectionBar.h.

Constructor & Destructor Documentation

◆ SpectralSelectionBar()

SpectralSelectionBar::SpectralSelectionBar ( AudacityProject & project )

Definition at line 93 of file SpectralSelectionBar.cpp.

: ToolBar( project, XO("Spectral Selection"), ID() )
, mbCenterAndWidth(true)
, mCenter(0.0), mWidth(0.0), mLow(0.0), mHigh(0.0)
, mCenterCtrl(NULL), mWidthCtrl(NULL), mLowCtrl(NULL), mHighCtrl(NULL)
, mChoice(NULL)
{
   mFormatsSubscription = ProjectNumericFormats::Get(project)
      .Subscribe(*this, &SpectralSelectionBar::OnFormatsChanged);
}

References ProjectNumericFormats::Get(), mFormatsSubscription, OnFormatsChanged(), project, and Observer::Publisher< Message, NotifyAll >::Subscribe().

Here is the call graph for this function:

◆ ~SpectralSelectionBar()

SpectralSelectionBar::~SpectralSelectionBar ( )

virtual

Definition at line 104 of file SpectralSelectionBar.cpp.

{
   // Do nothing, sizer deletes the controls
}

Member Function Documentation

◆ Create()

void SpectralSelectionBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 130 of file SpectralSelectionBar.cpp.

{
   ToolBar::Create(parent);
   UpdatePrefs();
   mHeight = wxWindowBase::GetSizer()->GetSize().GetHeight();
}

References ToolBar::Create(), mHeight, and UpdatePrefs().

Here is the call graph for this function:

◆ DefaultDockID()

ToolBar::DockID SpectralSelectionBar::DefaultDockID ( ) const

overridevirtual

Which dock the toolbar defaults into. Default implementation chooses the top dock.

Reimplemented from ToolBar.

Definition at line 114 of file SpectralSelectionBar.cpp.

{
   return BotDockID;
}

References ToolBar::BotDockID.

◆ EnableDisableButtons()

void SpectralSelectionBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 48 of file SpectralSelectionBar.h.

48{};

◆ Get() [1/2]

SpectralSelectionBar & SpectralSelectionBar::Get ( AudacityProject & project )

static

Definition at line 119 of file SpectralSelectionBar.cpp.

{
   auto &toolManager = ToolManager::Get( project );
   return *static_cast<SpectralSelectionBar*>(toolManager.GetToolBar(ID()));
}

References ToolManager::Get(), ID(), and project.

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

const SpectralSelectionBar & SpectralSelectionBar::Get ( const AudacityProject & project )

static

Definition at line 125 of file SpectralSelectionBar.cpp.

{
   return Get( const_cast<AudacityProject&>( project )) ;
}

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier SpectralSelectionBar::ID ( )

static

Definition at line 88 of file SpectralSelectionBar.cpp.

{
   return wxT("SpectralSelection");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ModifySpectralSelection()

void SpectralSelectionBar::ModifySpectralSelection ( bool done = false )

private

Definition at line 268 of file SpectralSelectionBar.cpp.

{
   auto &manager = ProjectSelectionManager::Get(mProject);
   auto &tracks = TrackList::Get(mProject);
   const auto nyq = WaveTrack::ProjectNyquistFrequency(mProject);
 
   double bottom, top;
   if (mbCenterAndWidth) {
      mCenter = mCenterCtrl->GetValue();
      mWidth = mWidthCtrl->GetValue();
      if ((mCenter < 0 || mWidth < 0) &&
          (mLow >= 0 || mHigh >= 0))
         // Transition from defined spectral selection to undefined
         bottom = top = SelectedRegion::UndefinedFrequency;
      else if (mCenter < 0 && mWidth < 0)
         bottom = top = SelectedRegion::UndefinedFrequency;
      else {
         if (mCenter < 0) {
            mWidth = log(std::min(nyq, exp(mWidth)));
            // Choose arbitrary center for the width
            mCenter = sqrt(nyq);
         }
         else if (mWidth < 0) {
            mCenter = std::max(1.0, std::min(nyq, mCenter));
            // Choose arbitrary width for the center
            const double ratio = std::min(mCenter, nyq / mCenter);
            mWidth = log(ratio * ratio);
         }
         else {
            mCenter = std::max(1.0, std::min(nyq, mCenter));
            double ratio = std::min(mCenter, nyq / mCenter);
            mWidth = std::min(2 * log(ratio), mWidth);
         }
 
         const double ratio = exp(mWidth / 2);
         bottom = mCenter / ratio, top = mCenter * ratio;
      }
   }
   else {
      bottom = mLowCtrl->GetValue();
      top = mHighCtrl->GetValue();
 
      if (bottom >= 0)
         bottom = std::min(nyq, bottom);
      else
         bottom = SelectedRegion::UndefinedFrequency;
 
      if (top >= 0)
         top = std::min(nyq, top);
      else
         top = SelectedRegion::UndefinedFrequency;
      // These have to be in the right order.
      if( bottom > top ){
         // Oops.  We must fix the order.
         if( mLowCtrl->HasFocus() )
            top = bottom;
         else
            bottom = top;
      }
   }
 
 
   mLow = bottom;
   mHigh = top;
   //SetBounds();
 
   // Notify project and track panel, which may change
   // the values again, and call back to us in SetFrequencies()
   manager.ModifySpectralSelection(nyq, bottom, top, done);
}

References ProjectSelectionManager::Get(), TrackList::Get(), NumericConverter::GetValue(), manager, mbCenterAndWidth, mCenter, mCenterCtrl, mHigh, mHighCtrl, min(), mLow, mLowCtrl, ToolBar::mProject, mWidth, mWidthCtrl, WaveTrack::ProjectNyquistFrequency(), staffpad::audio::simd::sqrt(), tracks, and SelectedRegion::UndefinedFrequency.

Referenced by OnCtrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnChoice()

void SpectralSelectionBar::OnChoice ( wxCommandEvent & evt )

private

Definition at line 344 of file SpectralSelectionBar.cpp.

{
   mbCenterAndWidth = (0 == mChoice->GetSelection());
   gPrefs->Write(preferencePath, mbCenterAndWidth);
   gPrefs->Flush();
 
   mCenterCtrl->Show(mbCenterAndWidth);
   mWidthCtrl->Show(mbCenterAndWidth);
   mLowCtrl->Show(!mbCenterAndWidth);
   mHighCtrl->Show(!mbCenterAndWidth);
 
   ValuesToControls();
 
   wxSize sz = GetMinSize();
   sz.SetWidth(wxDefaultCoord);
   SetMinSize(sz);
   Layout();
   Fit();
   Updated();
}

References audacity::BasicSettings::Flush(), gPrefs, mbCenterAndWidth, mCenterCtrl, mChoice, mHighCtrl, mLowCtrl, mWidthCtrl, preferencePath(), ToolBar::Updated(), ValuesToControls(), and audacity::BasicSettings::Write().

Here is the call graph for this function:

◆ OnCtrl()

void SpectralSelectionBar::OnCtrl ( wxCommandEvent & evt )

private

Definition at line 339 of file SpectralSelectionBar.cpp.

{
   ModifySpectralSelection(event.GetInt() != 0);
}

References ModifySpectralSelection().

Here is the call graph for this function:

◆ OnFormatsChanged()

void SpectralSelectionBar::OnFormatsChanged ( ProjectNumericFormatsEvent evt )

private

Definition at line 373 of file SpectralSelectionBar.cpp.

{
   auto &formats = ProjectNumericFormats::Get(mProject);
   switch (evt.type) {
   case ProjectNumericFormatsEvent::ChangedFrequencyFormat:
      return SetFrequencySelectionFormatName(
         formats.GetFrequencySelectionFormatName());
   case ProjectNumericFormatsEvent::ChangedBandwidthFormat:
      return SetBandwidthSelectionFormatName(
         formats.GetBandwidthSelectionFormatName());
   default:
      break;
   }
}

References ProjectNumericFormatsEvent::ChangedBandwidthFormat, ProjectNumericFormatsEvent::ChangedFrequencyFormat, ProjectNumericFormats::Get(), ToolBar::mProject, SetBandwidthSelectionFormatName(), SetFrequencySelectionFormatName(), and ProjectNumericFormatsEvent::type.

Referenced by SpectralSelectionBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnIdle()

void SpectralSelectionBar::OnIdle ( wxIdleEvent & evt )

private

Definition at line 365 of file SpectralSelectionBar.cpp.

{
   evt.Skip();
   auto &project = mProject;
   const auto &selectedRegion = ViewInfo::Get( project ).selectedRegion;
   SetFrequencies( selectedRegion.f0(), selectedRegion.f1() );
}

References ViewInfo::Get(), ToolBar::mProject, project, ViewInfo::selectedRegion, and SetFrequencies().

Here is the call graph for this function:

◆ OnSize()

void SpectralSelectionBar::OnSize ( wxSizeEvent & evt )

private

Definition at line 261 of file SpectralSelectionBar.cpp.

{
   Refresh(true);
 
   evt.Skip();
}

◆ OnUpdate()

void SpectralSelectionBar::OnUpdate ( wxCommandEvent & evt )

private

Definition at line 388 of file SpectralSelectionBar.cpp.

{
   auto &formats = ProjectNumericFormats::Get(mProject);
   wxWindow *w = FindFocus();
   bool centerFocus = (w && w == mCenterCtrl);
   bool widthFocus = (w && w == mWidthCtrl);
   bool lowFocus = (w && w == mLowCtrl);
   bool highFocus = (w && w == mHighCtrl);
 
   evt.Skip(false);
 
   // Save formats before recreating the controls so they resize properly
   wxEventType type = evt.GetEventType();
   if (type == EVT_FREQUENCYTEXTCTRL_UPDATED) {
      formats.SetFrequencySelectionFormatName(evt.GetString());
      // Then my subscription is called
   }
   else if (mbCenterAndWidth &&
            type == EVT_BANDWIDTHTEXTCTRL_UPDATED) {
      formats.SetBandwidthSelectionFormatName(evt.GetString());
      // Then my subscription is called
   }
 
   // ReCreateButtons() will get rid of our sizers and controls
   // so reset pointers first.
   mCenterCtrl = mWidthCtrl = NULL;
   mLowCtrl = mHighCtrl = NULL;
 
   ReCreateButtons();
   ValuesToControls();
 
 
   if (centerFocus) {
      mCenterCtrl->SetFocus();
   }
   else if (widthFocus) {
      mWidthCtrl->SetFocus();
   }
   else if (lowFocus) {
      mLowCtrl->SetFocus();
   }
   else if (highFocus) {
      mHighCtrl->SetFocus();
   }
 
   Updated();
}

References BasicUI::FindFocus(), ProjectNumericFormats::Get(), mbCenterAndWidth, mCenterCtrl, mHighCtrl, mLowCtrl, ToolBar::mProject, mWidthCtrl, ToolBar::ReCreateButtons(), ToolBar::Updated(), and ValuesToControls().

Referenced by SetBandwidthSelectionFormatName(), SetFrequencySelectionFormatName(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void SpectralSelectionBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 137 of file SpectralSelectionBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   gPrefs->Read(preferencePath, &mbCenterAndWidth, true);
 
   auto &formats = ProjectNumericFormats::Get(mProject);
   auto frequencyFormatName = formats.GetFrequencySelectionFormatName();
   auto bandwidthFormatName = formats.GetBandwidthSelectionFormatName();
   wxFlexGridSizer *mainSizer = safenew wxFlexGridSizer(1, 1, 1);
   Add(mainSizer, 0, wxALIGN_CENTER_VERTICAL | wxLEFT, 5);
 
   //
   // Top row, choice box
   //
 
   const wxString choices[2] = {
      _("Center frequency and Width"),
      _("Low and High Frequencies"),
   };
   mChoice = safenew wxChoice
      (this, OnChoiceID, wxDefaultPosition, wxDefaultSize, 2, choices,
       0, wxDefaultValidator, _("Show"));
   mChoice->SetSelection(mbCenterAndWidth ? 0 : 1);
#if wxUSE_ACCESSIBILITY
   // so that name can be set on a standard control
   mChoice->SetAccessible(safenew WindowAccessible(mChoice));
#endif
   mChoice->SetMinSize(wxSize(mChoice->GetBestSize().x, toolbarSingle));
   
   mainSizer->Add(mChoice, 0, wxEXPAND | wxALIGN_TOP | wxRIGHT, 6);
 
   //
   // Bottom row, split into two columns, each with one control
   //
 
   {
      auto subSizer = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
 
      mCenterCtrl = safenew NumericTextCtrl(FormatterContext::ProjectContext(mProject),
         this, OnCenterID,
         NumericConverterType_FREQUENCY(), frequencyFormatName, 0.0,
         NumericTextCtrl::Options{}
            .InvalidValue( true, SelectedRegion::UndefinedFrequency )
      );
      mCenterCtrl->SetName( XO("Center Frequency") );
      subSizer->Add(mCenterCtrl, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, 5);
 
      mWidthCtrl = safenew NumericTextCtrl(
         FormatterContext::ProjectContext(mProject),
         this, OnWidthID,
         NumericConverterType_BANDWIDTH(), bandwidthFormatName, 0.0,
         NumericTextCtrl::Options{}
            .InvalidValue( true, -1.0 )
      );
      mWidthCtrl->SetName( XO("Bandwidth") );
      subSizer->Add(mWidthCtrl, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, 5);
 
      mLowCtrl = safenew NumericTextCtrl(
         FormatterContext::ProjectContext(mProject),
         this, OnLowID,
         NumericConverterType_FREQUENCY(), frequencyFormatName, 0.0,
         NumericTextCtrl::Options{}
            .InvalidValue( true, SelectedRegion::UndefinedFrequency )
      );
      mLowCtrl->SetName( XO("Low Frequency") );
      subSizer->Add(mLowCtrl, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, 5);
 
      mHighCtrl = safenew NumericTextCtrl(
         FormatterContext::ProjectContext(mProject),
         this, OnHighID,
         NumericConverterType_FREQUENCY(), frequencyFormatName, 0.0,
         NumericTextCtrl::Options{}
            .InvalidValue( true, SelectedRegion::UndefinedFrequency )
      );
      mHighCtrl->SetName( XO("High Frequency") );
      subSizer->Add(mHighCtrl, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, 5);
 
      mCenterCtrl->Show(mbCenterAndWidth);
      mWidthCtrl->Show(mbCenterAndWidth);
      mLowCtrl->Show(!mbCenterAndWidth);
      mHighCtrl->Show(!mbCenterAndWidth);
 
      mainSizer->Add(subSizer.release(), 0, wxALIGN_TOP, 0);
   }
 
   mainSizer->Layout();
 
   Layout();
 
   CallAfter([this]{
      auto &formats = ProjectNumericFormats::Get(mProject);
      SetFrequencySelectionFormatName(
         formats.GetFrequencySelectionFormatName());
      SetBandwidthSelectionFormatName(
         formats.GetBandwidthSelectionFormatName());
   });
}

References _, ToolBar::Add(), BasicUI::CallAfter(), ThemeBase::Colour(), ProjectNumericFormats::Get(), gPrefs, NumericTextCtrl::Options::InvalidValue(), NumericTextCtrl::Layout(), mbCenterAndWidth, mCenterCtrl, mChoice, mHighCtrl, mLowCtrl, ToolBar::mProject, mWidthCtrl, NumericConverterType_BANDWIDTH(), NumericConverterType_FREQUENCY(), OnCenterID, OnChoiceID, OnHighID, OnLowID, OnWidthID, preferencePath(), FormatterContext::ProjectContext(), audacity::BasicSettings::Read(), safenew, SetBandwidthSelectionFormatName(), SetFrequencySelectionFormatName(), NumericTextCtrl::SetName(), theTheme, toolbarSingle, SelectedRegion::UndefinedFrequency, and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void SpectralSelectionBar::RegenerateTooltips ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 55 of file SpectralSelectionBar.h.

55{};

Referenced by UpdatePrefs().

Here is the caller graph for this function:

◆ Repaint()

void SpectralSelectionBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 47 of file SpectralSelectionBar.h.

47{};

◆ SetBandwidthSelectionFormatName()

void SpectralSelectionBar::SetBandwidthSelectionFormatName ( const NumericFormatID & formatName )

Definition at line 497 of file SpectralSelectionBar.cpp.

{
   if (mbCenterAndWidth) {
      bool changed =
         mWidthCtrl->SetFormatName(formatName);
      // Test first whether changed, to avoid infinite recursion from OnUpdate
      if (changed) {
         wxCommandEvent e(EVT_BANDWIDTHTEXTCTRL_UPDATED);
         e.SetString(mWidthCtrl->GetFormatName().GET());
         OnUpdate(e);
      }
   }
}

References Identifier::GET(), NumericConverter::GetFormatName(), mbCenterAndWidth, mWidthCtrl, OnUpdate(), and NumericTextCtrl::SetFormatName().

Referenced by OnFormatsChanged(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBounds()

void SpectralSelectionBar::SetBounds ( )

private

Definition at line 455 of file SpectralSelectionBar.cpp.

{
   if (mHigh >= 0)
      mLowCtrl->SetMaxValue(mHigh);
   else
      mLowCtrl->ResetMaxValue();
 
   if (mLow >= 0)
      mHighCtrl->SetMinValue(mLow);
   else
      mHighCtrl->ResetMinValue();
}

References mHigh, mHighCtrl, mLow, mLowCtrl, NumericConverter::ResetMaxValue(), NumericConverter::ResetMinValue(), NumericConverter::SetMaxValue(), and NumericConverter::SetMinValue().

Here is the call graph for this function:

◆ SetFrequencies()

void SpectralSelectionBar::SetFrequencies	(	double	bottom,
		double	top
	)

Definition at line 468 of file SpectralSelectionBar.cpp.

{
   if ( mLow != bottom || mHigh != top ) {
      mLow = bottom;
      mHigh = top;
 
      if (bottom > 0 && top >= bottom)
         mWidth = log(top / bottom), mCenter = sqrt(top * bottom);
      else
         mWidth = mCenter = -1.0;
 
      ValuesToControls();
   }
}

References mCenter, mHigh, mLow, mWidth, staffpad::audio::simd::sqrt(), and ValuesToControls().

Referenced by OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFrequencySelectionFormatName()

void SpectralSelectionBar::SetFrequencySelectionFormatName ( const NumericFormatID & formatName )

Definition at line 483 of file SpectralSelectionBar.cpp.

{
   NumericTextCtrl *frequencyCtrl = (mbCenterAndWidth ? mCenterCtrl : mLowCtrl);
   bool changed =
      frequencyCtrl->SetFormatName(formatName);
   // Test first whether changed, to avoid infinite recursion from OnUpdate
   if (changed) {
      wxCommandEvent e(EVT_FREQUENCYTEXTCTRL_UPDATED);
      e.SetString(frequencyCtrl->GetFormatName().GET());
      OnUpdate(e);
   }
}

References Identifier::GET(), NumericConverter::GetFormatName(), mbCenterAndWidth, mCenterCtrl, mLowCtrl, OnUpdate(), and NumericTextCtrl::SetFormatName().

Referenced by OnFormatsChanged(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShownByDefault()

bool SpectralSelectionBar::ShownByDefault ( ) const

overridevirtual

Whether the toolbar should be shown by default. Default implementation returns true.

Reimplemented from ToolBar.

Definition at line 109 of file SpectralSelectionBar.cpp.

{
   return false;
}

◆ UpdatePrefs()

void SpectralSelectionBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 235 of file SpectralSelectionBar.cpp.

{
   {
      wxCommandEvent e(EVT_FREQUENCYTEXTCTRL_UPDATED);
      e.SetString(
         (mbCenterAndWidth ? mCenterCtrl : mLowCtrl)
            ->GetFormatName().GET());
      OnUpdate(e);
   }
 
   if (mbCenterAndWidth)
   {
      wxCommandEvent e(EVT_BANDWIDTHTEXTCTRL_UPDATED);
      e.SetString(mWidthCtrl->GetFormatName().GET());
      OnUpdate(e);
   }
 
   // Set label to pull in language change
   SetLabel(XO("Spectral Selection"));
 
   RegenerateTooltips();
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References Identifier::GET(), NumericConverter::GetFormatName(), mbCenterAndWidth, mCenterCtrl, mLowCtrl, mWidthCtrl, OnUpdate(), RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), and XO().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ValuesToControls()

void SpectralSelectionBar::ValuesToControls ( )

private

Definition at line 436 of file SpectralSelectionBar.cpp.

{
   if (mbCenterAndWidth) {
      mCenterCtrl->SetValue(mCenter);
      mWidthCtrl->SetValue(mWidth);
   }
   else {
      //Bug 1633
      //The controls may not be able to show mHigh, e.g.
      //if set to Hz, and in that case we should either show invalid
      //or 'do the best we can' and truncate.
      //If we set bounds we instead clip to the mHigh to mLow,
      //So no SetBounds, for now.
      //SetBounds();
      mLowCtrl->SetValue(mLow);
      mHighCtrl->SetValue(mHigh);
   }
}

References mbCenterAndWidth, mCenter, mCenterCtrl, mHigh, mHighCtrl, mLow, mLowCtrl, mWidth, mWidthCtrl, and NumericTextCtrl::SetValue().

Referenced by OnChoice(), OnUpdate(), and SetFrequencies().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mbCenterAndWidth

bool SpectralSelectionBar::mbCenterAndWidth

private

Definition at line 73 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), OnChoice(), OnUpdate(), Populate(), SetBandwidthSelectionFormatName(), SetFrequencySelectionFormatName(), UpdatePrefs(), and ValuesToControls().

◆ mCenter

double SpectralSelectionBar::mCenter

private

Definition at line 75 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), SetFrequencies(), and ValuesToControls().

◆ mCenterCtrl

NumericTextCtrl* SpectralSelectionBar::mCenterCtrl

private

Definition at line 80 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), OnChoice(), OnUpdate(), Populate(), SetFrequencySelectionFormatName(), UpdatePrefs(), and ValuesToControls().

◆ mChoice

wxChoice* SpectralSelectionBar::mChoice

private

Definition at line 81 of file SpectralSelectionBar.h.

Referenced by OnChoice(), and Populate().

◆ mFormatsSubscription

Observer::Subscription SpectralSelectionBar::mFormatsSubscription

private

Definition at line 71 of file SpectralSelectionBar.h.

Referenced by SpectralSelectionBar().

◆ mHeight

int SpectralSelectionBar::mHeight

private

Definition at line 83 of file SpectralSelectionBar.h.

Referenced by Create().

◆ mHigh

double SpectralSelectionBar::mHigh

private

Definition at line 78 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), SetBounds(), SetFrequencies(), and ValuesToControls().

◆ mHighCtrl

NumericTextCtrl * SpectralSelectionBar::mHighCtrl

private

Definition at line 80 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), OnChoice(), OnUpdate(), Populate(), SetBounds(), and ValuesToControls().

◆ mLow

double SpectralSelectionBar::mLow

private

Definition at line 77 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), SetBounds(), SetFrequencies(), and ValuesToControls().

◆ mLowCtrl

NumericTextCtrl * SpectralSelectionBar::mLowCtrl

private

Definition at line 80 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), OnChoice(), OnUpdate(), Populate(), SetBounds(), SetFrequencySelectionFormatName(), UpdatePrefs(), and ValuesToControls().

◆ mWidth

double SpectralSelectionBar::mWidth

private

Definition at line 76 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), SetFrequencies(), and ValuesToControls().

◆ mWidthCtrl

NumericTextCtrl * SpectralSelectionBar::mWidthCtrl

private

Definition at line 80 of file SpectralSelectionBar.h.

Referenced by ModifySpectralSelection(), OnChoice(), OnUpdate(), Populate(), SetBandwidthSelectionFormatName(), UpdatePrefs(), and ValuesToControls().

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

◆ SpectralSelectionBar()

◆ ~SpectralSelectionBar()

Member Function Documentation

◆ Create()

◆ DefaultDockID()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ ModifySpectralSelection()

◆ OnChoice()

◆ OnCtrl()

◆ OnFormatsChanged()

◆ OnIdle()

◆ OnSize()

◆ OnUpdate()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ SetBandwidthSelectionFormatName()

◆ SetBounds()

◆ SetFrequencies()

◆ SetFrequencySelectionFormatName()

◆ ShownByDefault()

◆ UpdatePrefs()

◆ ValuesToControls()

Member Data Documentation

◆ mbCenterAndWidth

◆ mCenter

◆ mCenterCtrl

◆ mChoice

◆ mFormatsSubscription

◆ mHeight

◆ mHigh

◆ mHighCtrl

◆ mLow

◆ mLowCtrl

◆ mWidth

◆ mWidthCtrl