A ToolBar that holds the VU Meter. More...

#include <MeterToolBar.h>

Inheritance diagram for MeterToolBar:

Collaboration diagram for MeterToolBar:

Public Member Functions
	MeterToolBar (AudacityProject &project, int type)
	Methods for MeterToolBar. More...

virtual	~MeterToolBar ()

void	Create (wxWindow *parent) override

void	Populate () override

void	ReCreateButtons () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	UpdatePrefs () override

void	UpdateControls ()

void	OnSize (wxSizeEvent &event)

bool	Expose (bool show) override

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

int	GetMinToolbarWidth () override

wxSize	GetDockedSize () override

virtual void	SetDocked (ToolDock *dock, bool pushed) override

void	ShowOutputGainDialog ()

void	ShowInputGainDialog ()

void	AdjustOutputGain (int adj)

void	AdjustInputGain (int adj)

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

virtual	~ToolBar ()

bool	AcceptsFocus () 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	GetType ()

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

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 MeterToolBars	GetToolBars (AudacityProject &project)

static ConstMeterToolBars	GetToolBars (const AudacityProject &project)

static MeterToolBar &	Get (AudacityProject &project, bool forPlayMeterToolBar)

static const MeterToolBar &	Get (const AudacityProject &project, bool forPlayMeterToolBar)

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

Private Attributes
int	mWhichMeters

wxGridBagSizer *	mSizer

MeterPanel *	mPlayMeter

MeterPanel *	mRecordMeter

Additional Inherited Members
Public Types inherited from ToolBar
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

wxString	mSection

int	mType

Detailed Description

A ToolBar that holds the VU Meter.

Definition at line 37 of file MeterToolBar.h.

Constructor & Destructor Documentation

◆ MeterToolBar()

MeterToolBar::MeterToolBar	(	AudacityProject &	project,
		int	type
	)

Methods for MeterToolBar.

Definition at line 52 of file MeterToolBar.cpp.

: ToolBar(project, type, XO("Combined Meter"), wxT("CombinedMeter"), true)
{
   if( mType == RecordMeterBarID ){
      mWhichMeters = kWithRecordMeter;
      mLabel = XO("Recording Meter");
      mSection = wxT("RecordMeter");
   } else if( mType == PlayMeterBarID ){
      mWhichMeters = kWithPlayMeter;
      mLabel = XO("Playback Meter");
      mSection = wxT("PlayMeter");
   } else {
      mWhichMeters = kWithPlayMeter | kWithRecordMeter;
   }
   mSizer = NULL;
   mPlayMeter = NULL;
   mRecordMeter = NULL;
}

References kWithPlayMeter, kWithRecordMeter, PlayMeterBarID, RecordMeterBarID, and XO.

◆ ~MeterToolBar()

MeterToolBar::~MeterToolBar ( )

virtual

Definition at line 71 of file MeterToolBar.cpp.

72{

73}

Member Function Documentation

◆ AdjustInputGain()

void MeterToolBar::AdjustInputGain ( int adj )

Definition at line 326 of file MeterToolBar.cpp.

{
   if (adj < 0) {
      mRecordMeter->Decrease(-adj);
   }
   else {
      mRecordMeter->Increase(adj);
   }
 
   mRecordMeter->UpdateSliderControl();
}

References MeterPanel::Decrease(), MeterPanel::Increase(), mRecordMeter, and MeterPanel::UpdateSliderControl().

Here is the call graph for this function:

◆ AdjustOutputGain()

void MeterToolBar::AdjustOutputGain ( int adj )

Definition at line 314 of file MeterToolBar.cpp.

{
   if (adj < 0) {
      mPlayMeter->Decrease(-adj);
   }
   else {
      mPlayMeter->Increase(adj);
   }
 
   mPlayMeter->UpdateSliderControl();
}

References MeterPanel::Decrease(), MeterPanel::Increase(), mPlayMeter, and MeterPanel::UpdateSliderControl().

Here is the call graph for this function:

◆ Create()

void MeterToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 104 of file MeterToolBar.cpp.

{
   ToolBar::Create(parent);
 
   UpdatePrefs();
 
   // Simulate a size event to set initial meter placement/size
   wxSizeEvent dummy;
   OnSize(dummy);
}

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

Here is the call graph for this function:

◆ EnableDisableButtons()

void MeterToolBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 55 of file MeterToolBar.h.

55{};

◆ Expose()

bool MeterToolBar::Expose ( bool show )

overridevirtual

Reimplemented from ToolBar.

Definition at line 268 of file MeterToolBar.cpp.

{
   auto &projectAudioIO = ProjectAudioIO::Get( mProject );
   if( show ) {
      if( mPlayMeter ) {
         projectAudioIO.SetPlaybackMeter( mPlayMeter->GetMeter() );
      }
 
      if( mRecordMeter ) {
         projectAudioIO.SetCaptureMeter( mRecordMeter->GetMeter() );
      }
   } else {
      if( mPlayMeter &&
         projectAudioIO.GetPlaybackMeter() == mPlayMeter->GetMeter() ) {
         projectAudioIO.SetPlaybackMeter( nullptr );
      }
 
      if( mRecordMeter &&
         projectAudioIO.GetCaptureMeter() == mRecordMeter->GetMeter() ) {
         projectAudioIO.SetCaptureMeter( nullptr );
      }
   }
 
   return ToolBar::Expose( show );
}

References ToolBar::Expose(), ProjectAudioIO::Get(), MeterPanelBase::GetMeter(), mPlayMeter, ToolBar::mProject, and mRecordMeter.

Here is the call graph for this function:

◆ Get() [1/2]

MeterToolBar & MeterToolBar::Get	(	AudacityProject &	project,
		bool	forPlayMeterToolBar
	)

static

Definition at line 91 of file MeterToolBar.cpp.

{
   auto& toolManager = ToolManager::Get(project);
   auto  toolBarID = forPlayMeterToolBar ? PlayMeterBarID : RecordMeterBarID;
 
   return *static_cast<MeterToolBar*>(toolManager.GetToolBar(toolBarID));
}

References ToolManager::Get(), PlayMeterBarID, and RecordMeterBarID.

Referenced by Get(), GetToolBars(), ExtraActions::Handler::OnInputGain(), ExtraActions::Handler::OnInputGainDec(), ExtraActions::Handler::OnInputGainInc(), ExtraActions::Handler::OnOutputGain(), ExtraActions::Handler::OnOutputGainDec(), and ExtraActions::Handler::OnOutputGainInc().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

const MeterToolBar & MeterToolBar::Get	(	const AudacityProject &	project,
		bool	forPlayMeterToolBar
	)

static

Definition at line 99 of file MeterToolBar.cpp.

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

References Get().

Here is the call graph for this function:

◆ GetDockedSize()

wxSize MeterToolBar::GetDockedSize ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 65 of file MeterToolBar.h.

                                   {
      return GetSmartDockedSize();
   };

References ToolBar::GetSmartDockedSize().

Here is the call graph for this function:

◆ GetInitialWidth()

int MeterToolBar::GetInitialWidth ( )

inlineoverridevirtual

Resizable toolbars should implement these.

Reimplemented from ToolBar.

Definition at line 62 of file MeterToolBar.h.

62 {return (mWhichMeters ==

63 (kWithRecordMeter + kWithPlayMeter)) ? 338 : 460;} // Separate bars used to be smaller.

References kWithPlayMeter, kWithRecordMeter, and mWhichMeters.

◆ GetMinToolbarWidth()

int MeterToolBar::GetMinToolbarWidth ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 64 of file MeterToolBar.h.

64{ return 150; }

◆ GetToolBars() [1/2]

MeterToolBars MeterToolBar::GetToolBars ( AudacityProject & project )

static

Definition at line 75 of file MeterToolBar.cpp.

{
   return MeterToolBars{
      Get(project, true),
      Get(project, false)
   };
}

References Get().

Referenced by ProjectManager::OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetToolBars() [2/2]

ConstMeterToolBars MeterToolBar::GetToolBars ( const AudacityProject & project )

static

Definition at line 83 of file MeterToolBar.cpp.

{
   return ConstMeterToolBars{
      Get(project, true),
      Get(project, false)
   };
}

References Get().

Here is the call graph for this function:

◆ OnSize()

void MeterToolBar::OnSize ( wxSizeEvent & event )

Definition at line 218 of file MeterToolBar.cpp.

{
   event.Skip();
   int width, height;
 
   // We can be resized before populating...protect against it
   if( !mSizer ) {
      return;
   }
 
   // Update the layout
   Layout();
 
   // Get the usable area
   wxSize sz = GetSizer()->GetSize();
   width = sz.x; height = sz.y;
 
   int nMeters = 
      ((mRecordMeter ==NULL) ? 0:1) +
      ((mPlayMeter ==NULL) ? 0:1);
 
   bool bHorizontal = ( width > height );
   bool bEndToEnd   = ( nMeters > 1 ) && wxMin( width, height ) < (60 * nMeters);
 
   // Default location for second meter
   wxGBPosition pos( 0, 0 );
   // If 2 meters, share the height or width.
   if( nMeters > 1 ){
      if( bHorizontal ^ bEndToEnd ){
         height /= nMeters;
         pos = wxGBPosition( 1, 0 );
      } else {
         width /= nMeters;
         pos = wxGBPosition( 0, 1 );
      }
   }
 
   if( mRecordMeter ) {
      mRecordMeter->SetMinSize( wxSize( width, height ));
   }
   if( mPlayMeter ) {
      mPlayMeter->SetMinSize( wxSize( width, height));
      mSizer->SetItemPosition( mPlayMeter, pos );
   }
 
   // And make it happen
   Layout();
   Fit();
}

References ToolBar::GetSizer(), mPlayMeter, mRecordMeter, and mSizer.

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void MeterToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 146 of file MeterToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   Add((mSizer = safenew wxGridBagSizer()), 1, wxEXPAND);
 
   if( mWhichMeters & kWithRecordMeter ){
      //JKC: Record on left, playback on right.  Left to right flow
      //(maybe we should do it differently for Arabic language :-)  )
      mRecordMeter = safenew MeterPanel( &mProject,
                                this,
                                wxID_ANY,
                                true,
                                wxDefaultPosition,
                                wxSize( 260, 28 ) );
      /* i18n-hint: (noun) The meter that shows the loudness of the audio being recorded.*/
      mRecordMeter->SetName( XO("Record Meter"));
      /* i18n-hint: (noun) The meter that shows the loudness of the audio being recorded.
       This is the name used in screen reader software, where having 'Meter' first
       apparently is helpful to partially sighted people.  */
      mRecordMeter->SetLabel( XO("Meter-Record") );
      mSizer->Add( mRecordMeter, wxGBPosition( 0, 0 ), wxDefaultSpan, wxEXPAND );
   }
 
   if( mWhichMeters & kWithPlayMeter ){
      mPlayMeter = safenew MeterPanel( &mProject,
                              this,
                              wxID_ANY,
                              false,
                              wxDefaultPosition,
                              wxSize( 260, 28 ) );
      /* i18n-hint: (noun) The meter that shows the loudness of the audio playing.*/
      mPlayMeter->SetName( XO("Play Meter"));
      /* i18n-hint: (noun) The meter that shows the loudness of the audio playing.
       This is the name used in screen reader software, where having 'Meter' first
       apparently is helpful to partially sighted people.  */
      mPlayMeter->SetLabel( XO("Meter-Play"));
      mSizer->Add( mPlayMeter, wxGBPosition( (mWhichMeters & kWithRecordMeter)?1:0, 0 ), wxDefaultSpan, wxEXPAND );
   }
 
   RegenerateTooltips();
}

References ToolBar::Add(), ThemeBase::Colour(), kWithPlayMeter, kWithRecordMeter, mPlayMeter, ToolBar::mProject, mRecordMeter, mSizer, mWhichMeters, RegenerateTooltips(), safenew, wxPanelWrapper::SetLabel(), wxPanelWrapper::SetName(), theTheme, and XO.

Here is the call graph for this function:

◆ ReCreateButtons()

void MeterToolBar::ReCreateButtons ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 115 of file MeterToolBar.cpp.

{
   MeterPanel::State playState{ false }, recordState{ false };
 
   auto &projectAudioIO = ProjectAudioIO::Get( mProject );
   if (mPlayMeter &&
      projectAudioIO.GetPlaybackMeter() == mPlayMeter->GetMeter())
   {
      playState = mPlayMeter->SaveState();
      projectAudioIO.SetPlaybackMeter( nullptr );
   }
 
   if (mRecordMeter &&
      projectAudioIO.GetCaptureMeter() == mRecordMeter->GetMeter())
   {
      recordState = mRecordMeter->SaveState();
      projectAudioIO.SetCaptureMeter( nullptr );
   }
 
   ToolBar::ReCreateButtons();
 
   mPlayMeter->RestoreState(playState);
   if( playState.mSaved  ){
      projectAudioIO.SetPlaybackMeter( mPlayMeter->GetMeter() );
   }
   mRecordMeter->RestoreState(recordState);
   if( recordState.mSaved ){
      projectAudioIO.SetCaptureMeter( mRecordMeter->GetMeter() );
   }
}

References ProjectAudioIO::Get(), MeterPanelBase::GetMeter(), mPlayMeter, ToolBar::mProject, mRecordMeter, ToolBar::ReCreateButtons(), MeterPanel::RestoreState(), and MeterPanel::SaveState().

Here is the call graph for this function:

◆ RegenerateTooltips()

void MeterToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 208 of file MeterToolBar.cpp.

{
#if wxUSE_TOOLTIPS
   if( mPlayMeter )
      mPlayMeter->SetToolTip( XO("Playback Level") );
   if( mRecordMeter )
      mRecordMeter->SetToolTip( XO("Recording Level") );
#endif
}

References mPlayMeter, mRecordMeter, wxPanelWrapper::SetToolTip(), and XO.

Referenced by Populate(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void MeterToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 54 of file MeterToolBar.h.

54{};

◆ SetDocked()

void MeterToolBar::SetDocked	(	ToolDock *	dock,
		bool	pushed
	)

overridevirtual

Reimplemented from ToolBar.

Definition at line 297 of file MeterToolBar.cpp.

                                                        {
   ToolBar::SetDocked(dock, pushed);
   Fit();
}

References ToolBar::SetDocked().

Here is the call graph for this function:

◆ ShowInputGainDialog()

void MeterToolBar::ShowInputGainDialog ( )

Definition at line 308 of file MeterToolBar.cpp.

{
   mRecordMeter->ShowDialog();
   mRecordMeter->UpdateSliderControl();
}

References mRecordMeter, MeterPanel::ShowDialog(), and MeterPanel::UpdateSliderControl().

Here is the call graph for this function:

◆ ShowOutputGainDialog()

void MeterToolBar::ShowOutputGainDialog ( )

Definition at line 302 of file MeterToolBar.cpp.

{
   mPlayMeter->ShowDialog();
   mPlayMeter->UpdateSliderControl();
}

References mPlayMeter, MeterPanel::ShowDialog(), and MeterPanel::UpdateSliderControl().

Here is the call graph for this function:

◆ UpdateControls()

void MeterToolBar::UpdateControls ( )

Definition at line 199 of file MeterToolBar.cpp.

{
   if ( mPlayMeter )
      mPlayMeter->UpdateSliderControl();
 
   if ( mRecordMeter )
      mRecordMeter->UpdateSliderControl();
}

References mPlayMeter, mRecordMeter, and MeterPanel::UpdateSliderControl().

Here is the call graph for this function:

◆ UpdatePrefs()

void MeterToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 188 of file MeterToolBar.cpp.

{
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Meter"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References 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:

Member Data Documentation

◆ mPlayMeter

MeterPanel* MeterToolBar::mPlayMeter

private

Definition at line 81 of file MeterToolBar.h.

Referenced by AdjustOutputGain(), Expose(), OnSize(), Populate(), ReCreateButtons(), RegenerateTooltips(), ShowOutputGainDialog(), and UpdateControls().

◆ mRecordMeter

MeterPanel* MeterToolBar::mRecordMeter

private

Definition at line 82 of file MeterToolBar.h.

Referenced by AdjustInputGain(), Expose(), OnSize(), Populate(), ReCreateButtons(), RegenerateTooltips(), ShowInputGainDialog(), and UpdateControls().

◆ mSizer

wxGridBagSizer* MeterToolBar::mSizer

private

Definition at line 80 of file MeterToolBar.h.

Referenced by OnSize(), and Populate().

◆ mWhichMeters

int MeterToolBar::mWhichMeters

private

Definition at line 79 of file MeterToolBar.h.

Referenced by GetInitialWidth(), and Populate().

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

◆ MeterToolBar()

◆ ~MeterToolBar()

Member Function Documentation

◆ AdjustInputGain()

◆ AdjustOutputGain()

◆ Create()

◆ EnableDisableButtons()

◆ Expose()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetDockedSize()

◆ GetInitialWidth()

◆ GetMinToolbarWidth()

◆ GetToolBars() [1/2]

◆ GetToolBars() [2/2]

◆ OnSize()

◆ Populate()

◆ ReCreateButtons()

◆ RegenerateTooltips()

◆ Repaint()

◆ SetDocked()

◆ ShowInputGainDialog()

◆ ShowOutputGainDialog()

◆ UpdateControls()

◆ UpdatePrefs()

Member Data Documentation

◆ mPlayMeter

◆ mRecordMeter

◆ mSizer

◆ mWhichMeters