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, unsigned whichMeters, const TranslatableString &label, Identifier ID)

virtual	~MeterToolBar ()

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

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

void	ShowOutputGainDialog ()

void	ShowInputGainDialog ()

void	AdjustOutputGain (int adj)

void	AdjustInputGain (int adj)

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 ()
	Methods for MeterToolBar. More...

static Identifier	PlayID ()

static Identifier	RecordID ()

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

void	RebuildLayout (bool force)

Private Attributes
unsigned	mWhichMeters

wxBoxSizer *	mRootSizer {nullptr}

AButton *	mPlaySetupButton {nullptr}

MeterPanel *	mPlayMeter {nullptr}

AButton *	mRecordSetupButton {nullptr}

MeterPanel *	mRecordMeter {nullptr}

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

A ToolBar that holds the VU Meter.

Definition at line 38 of file MeterToolBar.h.

Constructor & Destructor Documentation

◆ MeterToolBar()

MeterToolBar::MeterToolBar	(	AudacityProject &	project,
		unsigned	whichMeters,
		const TranslatableString &	label,
		Identifier	ID
	)

Definition at line 148 of file MeterToolBar.cpp.

: ToolBar(project, label, ID, true)
, mWhichMeters{ whichMeters }
{
}

◆ ~MeterToolBar()

MeterToolBar::~MeterToolBar ( )

virtual

Definition at line 156 of file MeterToolBar.cpp.

157{

158}

Member Function Documentation

◆ AdjustInputGain()

void MeterToolBar::AdjustInputGain ( int adj )

Definition at line 496 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 484 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 194 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 64 of file MeterToolBar.h.

64{};

◆ Expose()

bool MeterToolBar::Expose ( bool show )

overridevirtual

Reimplemented from ToolBar.

Definition at line 440 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 176 of file MeterToolBar.cpp.

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

References ToolManager::Get(), PlayID(), project, and RecordID().

Referenced by Get(), GetToolBars(), anonymous_namespace{MeterToolBar.cpp}::OnInputGain(), anonymous_namespace{MeterToolBar.cpp}::OnInputGainDec(), anonymous_namespace{MeterToolBar.cpp}::OnInputGainInc(), anonymous_namespace{MeterToolBar.cpp}::OnOutputGain(), anonymous_namespace{MeterToolBar.cpp}::OnOutputGainDec(), and anonymous_namespace{MeterToolBar.cpp}::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 183 of file MeterToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ GetDockedSize()

wxSize MeterToolBar::GetDockedSize ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 73 of file MeterToolBar.h.

                                   {
      return GetSmartDockedSize();
   };

References ToolBar::GetSmartDockedSize().

Here is the call graph for this function:

◆ GetInitialWidth()

int MeterToolBar::GetInitialWidth ( )

overridevirtual

Resizable toolbars should implement these.

Reimplemented from ToolBar.

Definition at line 466 of file MeterToolBar.cpp.

{
   return (mWhichMeters ==
      (kWithRecordMeter + kWithPlayMeter)) ? 338 : 290;
}

References kWithPlayMeter, kWithRecordMeter, and mWhichMeters.

◆ GetMinToolbarWidth()

int MeterToolBar::GetMinToolbarWidth ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 72 of file MeterToolBar.h.

72{ return 150; }

◆ GetToolBars() [1/2]

MeterToolBars MeterToolBar::GetToolBars ( AudacityProject & project )

static

Definition at line 160 of file MeterToolBar.cpp.

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

References Get(), and project.

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 168 of file MeterToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier MeterToolBar::ID ( )

static

Methods for MeterToolBar.

Definition at line 132 of file MeterToolBar.cpp.

{
   return wxT("CombinedMeter");
}

References wxT().

Here is the call graph for this function:

◆ OnSize()

void MeterToolBar::OnSize ( wxSizeEvent & event )

Definition at line 431 of file MeterToolBar.cpp.

{
   event.Skip();
 
   if(mRootSizer == nullptr)
      return;// We can be resized before populating...protect against it
   RebuildLayout(false);
}

References mRootSizer, and RebuildLayout().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PlayID()

Identifier MeterToolBar::PlayID ( )

static

Definition at line 137 of file MeterToolBar.cpp.

{
   return wxT("PlayMeter");
}

References wxT().

Referenced by Get().

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 236 of file MeterToolBar.cpp.

{
   MakeButtonBackgroundsSmall();
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
 
   if( mWhichMeters & kWithRecordMeter ){
      //JKC: Record on left, playback on right.  Left to right flow
      //(maybe we should do it differently for Arabic language :-)  )
      mRecordSetupButton = safenew AButton(this);
      mRecordSetupButton->SetButtonType(AButton::FrameButton);
      mRecordSetupButton->SetFrameMid(3);
      mRecordSetupButton->SetLabel({});
      mRecordSetupButton->SetName(_("Record Meter"));
      mRecordSetupButton->SetToolTip(XO("Record Meter"));
      mRecordSetupButton->SetImages(
         theTheme.Image(bmpRecoloredUpSmall),
         theTheme.Image(bmpRecoloredUpHiliteSmall),
         theTheme.Image(bmpRecoloredDownSmall),
         theTheme.Image(bmpRecoloredHiliteSmall),
         theTheme.Image(bmpRecoloredUpSmall));
      mRecordSetupButton->SetIcon(theTheme.Image(bmpMic));
      mRecordSetupButton->SetButtonType(AButton::Type::FrameButton);
      mRecordSetupButton->SetMinSize({25, 25});
      mRecordSetupButton->SetMaxSize({25, 25});
 
      mRecordMeter = safenew MeterPanel( &mProject,
                                this,
                                wxID_ANY,
                                true,
                                wxDefaultPosition,
                                wxSize( 260, 25) );
      /* i18n-hint: (noun) The meter that shows the loudness of the audio being recorded.*/
      mRecordMeter->SetName( XO("Recording Level"));
      /* 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") );
 
#if wxUSE_ACCESSIBILITY
      auto meterButtonAcc = safenew MeterButtonAx(*mRecordSetupButton, *mRecordMeter);
#endif
      mRecordSetupButton->Bind(wxEVT_BUTTON, [=](wxCommandEvent&)
      {
#if wxUSE_ACCESSIBILITY
         meterButtonAcc->SetSilent(true);
#endif
         mRecordMeter->ShowMenu(
            mRecordMeter->ScreenToClient(
               ClientToScreen(mRecordSetupButton->GetClientRect().GetBottomLeft())
            )
         );
#if wxUSE_ACCESSIBILITY
         /* if stop/start monitoring was chosen in the menu, then by this point
         OnMonitoring has been called and variables which affect the accessibility
         name have been updated so it's now ok for screen readers to read the name of
         the button */
         meterButtonAcc->SetSilent(false);
#endif
      });
   }
 
   if( mWhichMeters & kWithPlayMeter ){
      mPlaySetupButton = safenew AButton(this);
      mPlaySetupButton->SetButtonType(AButton::FrameButton);
      mPlaySetupButton->SetFrameMid(3);
      mPlaySetupButton->SetLabel({});
      mPlaySetupButton->SetName(_("Playback Meter"));
      mPlaySetupButton->SetToolTip(XO("Playback Meter"));
      mPlaySetupButton->SetImages(
         theTheme.Image(bmpRecoloredUpSmall),
         theTheme.Image(bmpRecoloredUpHiliteSmall),
         theTheme.Image(bmpRecoloredDownSmall),
         theTheme.Image(bmpRecoloredHiliteSmall),
         theTheme.Image(bmpRecoloredUpSmall));
      mPlaySetupButton->SetIcon(theTheme.Image(bmpSpeaker));
      mPlaySetupButton->SetButtonType(AButton::Type::FrameButton);
      mPlaySetupButton->SetMinSize({25, 25});
      mPlaySetupButton->SetMaxSize({25, 25});
 
 
      mPlayMeter = safenew MeterPanel( &mProject,
                              this,
                              wxID_ANY,
                              false,
                              wxDefaultPosition,
                              wxSize( 260, 25 ) );
      /* i18n-hint: (noun) The meter that shows the loudness of the audio playing.*/
      mPlayMeter->SetName( XO("Playback Level"));
      /* 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"));
 
#if wxUSE_ACCESSIBILITY
      auto meterButtonAcc = safenew MeterButtonAx(*mPlaySetupButton, *mPlayMeter);
#endif
      mPlaySetupButton->Bind(wxEVT_BUTTON, [=](wxCommandEvent&)
      {
#if wxUSE_ACCESSIBILITY
         meterButtonAcc->SetSilent(true);
#endif
         mPlayMeter->ShowMenu(
            mPlayMeter->ScreenToClient(
               ClientToScreen(mPlaySetupButton->GetClientRect().GetBottomLeft())
            )
         );
#if wxUSE_ACCESSIBILITY
         meterButtonAcc->SetSilent(false);
#endif
      });
   }
 
   RebuildLayout(true);
 
   RegenerateTooltips();
 
   Layout();
}

References _, ThemeBase::Colour(), AButton::FrameButton, ThemeBase::Image(), kWithPlayMeter, kWithRecordMeter, ToolBar::MakeButtonBackgroundsSmall(), mPlayMeter, mPlaySetupButton, ToolBar::mProject, mRecordMeter, mRecordSetupButton, mWhichMeters, RebuildLayout(), RegenerateTooltips(), safenew, AButton::SetButtonType(), AButton::SetFrameMid(), AButton::SetIcon(), AButton::SetImages(), wxPanelWrapper::SetLabel(), AButton::SetLabel(), MeterPanel::SetName(), AButton::SetToolTip(), MeterPanel::ShowMenu(), theTheme, and XO().

Here is the call graph for this function:

◆ RebuildLayout()

void MeterToolBar::RebuildLayout ( bool force )

private

Definition at line 382 of file MeterToolBar.cpp.

{
   const auto size = GetSize();
   const auto isHorizontal = size.x > size.y;
 
   if(!force)
   {
      const auto sizerOrientation = mWhichMeters == kCombinedMeter
         ? (isHorizontal ? wxVERTICAL : wxHORIZONTAL)
         : (isHorizontal ? wxHORIZONTAL : wxVERTICAL);
      
      if(mRootSizer->GetOrientation() == sizerOrientation)
      {
         Layout();
         return;
      }
   }
 
   if(mRootSizer != nullptr)
      GetSizer()->Remove(mRootSizer);
 
   std::unique_ptr<wxBoxSizer> playBarSizer;
   std::unique_ptr<wxBoxSizer> recordBarSizer;
   if(mWhichMeters & kWithPlayMeter)
   {
      playBarSizer = std::make_unique<wxBoxSizer>(isHorizontal ? wxHORIZONTAL : wxVERTICAL);
      playBarSizer->Add(mPlaySetupButton, 0, wxEXPAND | wxRIGHT, 2);
      playBarSizer->Add(mPlayMeter, 1, wxEXPAND);
   }
   if(mWhichMeters & kWithRecordMeter)
   {
      recordBarSizer = std::make_unique<wxBoxSizer>(isHorizontal ? wxHORIZONTAL : wxVERTICAL);
      recordBarSizer->Add(mRecordSetupButton, 0, wxEXPAND | wxRIGHT, 2);
      recordBarSizer->Add(mRecordMeter, 1, wxEXPAND);
   }
 
   if(playBarSizer && recordBarSizer)
   {
      Add(mRootSizer = safenew wxBoxSizer(isHorizontal ? wxVERTICAL : wxHORIZONTAL), 1, wxEXPAND | wxALL, 2);
      mRootSizer->Add(playBarSizer.release());
      mRootSizer->Add(recordBarSizer.release());
   }
   else if(playBarSizer)
      Add(mRootSizer = playBarSizer.release(), 1, wxEXPAND | wxALL, 2);
   else if(recordBarSizer)
      Add(mRootSizer = recordBarSizer.release(), 1, wxEXPAND | wxALL, 2);
}

References ToolBar::Add(), ToolBar::GetSizer(), kCombinedMeter, kWithPlayMeter, kWithRecordMeter, mPlayMeter, mPlaySetupButton, mRecordMeter, mRecordSetupButton, mRootSizer, mWhichMeters, safenew, and size.

Referenced by OnSize(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RecordID()

Identifier MeterToolBar::RecordID ( )

static

Definition at line 142 of file MeterToolBar.cpp.

{
   return wxT("RecordMeter");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReCreateButtons()

void MeterToolBar::ReCreateButtons ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 205 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 ( )

inlineoverrideprivatevirtual

Implements ToolBar.

Definition at line 84 of file MeterToolBar.h.

84{}

Referenced by Populate(), and UpdatePrefs().

Here is the caller graph for this function:

◆ Repaint()

void MeterToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 63 of file MeterToolBar.h.

63{};

◆ ShowInputGainDialog()

void MeterToolBar::ShowInputGainDialog ( )

Definition at line 478 of file MeterToolBar.cpp.

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

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

Here is the call graph for this function:

◆ ShownByDefault()

bool MeterToolBar::ShownByDefault ( ) const

overridevirtual

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

Reimplemented from ToolBar.

Definition at line 188 of file MeterToolBar.cpp.

{
   // The combined meter hides by default
   return mWhichMeters != (kWithPlayMeter|kWithRecordMeter);
}

References kWithPlayMeter, kWithRecordMeter, and mWhichMeters.

◆ ShowOutputGainDialog()

void MeterToolBar::ShowOutputGainDialog ( )

Definition at line 472 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 373 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 355 of file MeterToolBar.cpp.

{
   RegenerateTooltips();
 
   // Since the same widget is provides both the Recording Meter as
   // well as the Playback Meter, we choose an appropriate label
   // based on which it is
   auto label = (mWhichMeters & kWithRecordMeter)
      ? XO("Recording Meter")
      : XO("Playback Meter");
 
   // Set label to pull in language change
   SetLabel(label);
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References kWithRecordMeter, label, mWhichMeters, 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 {nullptr}

private

Definition at line 90 of file MeterToolBar.h.

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

◆ mPlaySetupButton

AButton* MeterToolBar::mPlaySetupButton {nullptr}

private

Definition at line 89 of file MeterToolBar.h.

Referenced by Populate(), and RebuildLayout().

◆ mRecordMeter

MeterPanel* MeterToolBar::mRecordMeter {nullptr}

private

Definition at line 92 of file MeterToolBar.h.

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

◆ mRecordSetupButton

AButton* MeterToolBar::mRecordSetupButton {nullptr}

private

Definition at line 91 of file MeterToolBar.h.

Referenced by Populate(), and RebuildLayout().

◆ mRootSizer

wxBoxSizer* MeterToolBar::mRootSizer {nullptr}

private

Definition at line 88 of file MeterToolBar.h.

Referenced by OnSize(), and RebuildLayout().

◆ mWhichMeters

unsigned MeterToolBar::mWhichMeters

private

Definition at line 87 of file MeterToolBar.h.

Referenced by GetInitialWidth(), Populate(), RebuildLayout(), ShownByDefault(), and UpdatePrefs().

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]

◆ ID()

◆ OnSize()

◆ PlayID()

◆ Populate()

◆ RebuildLayout()

◆ RecordID()

◆ ReCreateButtons()

◆ RegenerateTooltips()

◆ Repaint()

◆ ShowInputGainDialog()

◆ ShownByDefault()

◆ ShowOutputGainDialog()

◆ UpdateControls()

◆ UpdatePrefs()

Member Data Documentation

◆ mPlayMeter

◆ mPlaySetupButton

◆ mRecordMeter

◆ mRecordSetupButton

◆ mRootSizer

◆ mWhichMeters