(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 NumericFormatSymbol &formatName)

void	SetBandwidthSelectionFormatName (const NumericFormatSymbol &formatName)

void	SetListener (SpectralSelectionBarListener *l)

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	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
SpectralSelectionBarListener *	mListener

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 28 of file SpectralSelectionBar.h.

Constructor & Destructor Documentation

◆ SpectralSelectionBar()

SpectralSelectionBar::SpectralSelectionBar ( AudacityProject & project )

◆ ~SpectralSelectionBar()

virtual SpectralSelectionBar::~SpectralSelectionBar ( )

virtual

Member Function Documentation

◆ Create()

void SpectralSelectionBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

◆ DefaultDockID()

DockID SpectralSelectionBar::DefaultDockID ( ) const

overridevirtual

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

Reimplemented from ToolBar.

◆ EnableDisableButtons()

void SpectralSelectionBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 47 of file SpectralSelectionBar.h.

47{};

◆ Get() [1/2]

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

static

Referenced by ProjectManager::New(), ProjectSelectionManager::SSBL_SetBandwidthSelectionFormatName(), and ProjectSelectionManager::SSBL_SetFrequencySelectionFormatName().

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

◆ ID()

static Identifier SpectralSelectionBar::ID ( )

static

◆ ModifySpectralSelection()

void SpectralSelectionBar::ModifySpectralSelection ( bool done = false )

private

◆ OnChoice()

void SpectralSelectionBar::OnChoice ( wxCommandEvent & evt )

private

◆ OnCtrl()

void SpectralSelectionBar::OnCtrl ( wxCommandEvent & evt )

private

◆ OnIdle()

void SpectralSelectionBar::OnIdle ( wxIdleEvent & evt )

private

◆ OnSize()

void SpectralSelectionBar::OnSize ( wxSizeEvent & evt )

private

◆ OnUpdate()

void SpectralSelectionBar::OnUpdate ( wxCommandEvent & evt )

private

◆ Populate()

void SpectralSelectionBar::Populate ( )

overridevirtual

Implements ToolBar.

◆ RegenerateTooltips()

void SpectralSelectionBar::RegenerateTooltips ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 55 of file SpectralSelectionBar.h.

55{};

◆ Repaint()

void SpectralSelectionBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 46 of file SpectralSelectionBar.h.

46{};

◆ SetBandwidthSelectionFormatName()

void SpectralSelectionBar::SetBandwidthSelectionFormatName ( const NumericFormatSymbol & formatName )

Referenced by ProjectSelectionManager::SSBL_SetBandwidthSelectionFormatName().

Here is the caller graph for this function:

◆ SetBounds()

void SpectralSelectionBar::SetBounds ( )

private

◆ SetFrequencies()

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

◆ SetFrequencySelectionFormatName()

void SpectralSelectionBar::SetFrequencySelectionFormatName ( const NumericFormatSymbol & formatName )

Referenced by ProjectSelectionManager::SSBL_SetFrequencySelectionFormatName().

Here is the caller graph for this function:

◆ SetListener()

void SpectralSelectionBar::SetListener ( SpectralSelectionBarListener * l )

Referenced by ProjectManager::New().

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.

◆ UpdatePrefs()

void SpectralSelectionBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

◆ ValuesToControls()

void SpectralSelectionBar::ValuesToControls ( )

private

Member Data Documentation

◆ mbCenterAndWidth

bool SpectralSelectionBar::mbCenterAndWidth

private

Definition at line 72 of file SpectralSelectionBar.h.

◆ mCenter

double SpectralSelectionBar::mCenter

private

Definition at line 74 of file SpectralSelectionBar.h.

◆ mCenterCtrl

NumericTextCtrl* SpectralSelectionBar::mCenterCtrl

private

Definition at line 79 of file SpectralSelectionBar.h.

◆ mChoice

wxChoice* SpectralSelectionBar::mChoice

private

Definition at line 80 of file SpectralSelectionBar.h.

◆ mHeight

int SpectralSelectionBar::mHeight

private

Definition at line 82 of file SpectralSelectionBar.h.

◆ mHigh

double SpectralSelectionBar::mHigh

private

Definition at line 77 of file SpectralSelectionBar.h.

◆ mHighCtrl

NumericTextCtrl * SpectralSelectionBar::mHighCtrl

private

Definition at line 79 of file SpectralSelectionBar.h.

◆ mListener

SpectralSelectionBarListener* SpectralSelectionBar::mListener

private

Definition at line 70 of file SpectralSelectionBar.h.

◆ mLow

double SpectralSelectionBar::mLow

private

Definition at line 76 of file SpectralSelectionBar.h.

◆ mLowCtrl

NumericTextCtrl * SpectralSelectionBar::mLowCtrl

private

Definition at line 79 of file SpectralSelectionBar.h.

◆ mWidth

double SpectralSelectionBar::mWidth

private

Definition at line 75 of file SpectralSelectionBar.h.

◆ mWidthCtrl

NumericTextCtrl * SpectralSelectionBar::mWidthCtrl

private

Definition at line 79 of file SpectralSelectionBar.h.

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

SpectralSelectionBar.h

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

◆ OnIdle()

◆ OnSize()

◆ OnUpdate()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ SetBandwidthSelectionFormatName()

◆ SetBounds()

◆ SetFrequencies()

◆ SetFrequencySelectionFormatName()

◆ SetListener()

◆ ShownByDefault()

◆ UpdatePrefs()

◆ ValuesToControls()

Member Data Documentation

◆ mbCenterAndWidth

◆ mCenter

◆ mCenterCtrl

◆ mChoice

◆ mHeight

◆ mHigh

◆ mHighCtrl

◆ mListener

◆ mLow

◆ mLowCtrl

◆ mWidth

◆ mWidthCtrl