MeterToolBar Class Reference

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

#include <MeterToolBar.h>

Inheritance 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	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
Public Member Functions inherited from ToolBar
	ToolBar (int type, const wxString &label, const wxString &section, bool resizable=false)
virtual	~ToolBar ()
bool	AcceptsFocus () const override
int	GetType ()
wxString	GetTitle ()
wxString	GetLabel ()
wxString	GetSection ()
ToolDock *	GetDock ()
void	SetLabel (const wxString &label) override
bool	IsResizable () const
bool	IsVisible () const
bool	IsDocked () const
bool	IsPositioned ()
void	SetVisible (bool bVisible)
void	SetPositioned ()
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 wxString &name=_("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const wxString &name=_("Panel"))
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&...args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	RegenerateTooltips () override

Private Attributes
AudacityProject *	mProject
int	mWhichMeters
wxGridBagSizer *	mSizer
MeterPanel *	mPlayMeter
MeterPanel *	mRecordMeter

Additional Inherited Members
Public Types inherited from ToolBar
using	Holder = Destroy_ptr< ToolBar >
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 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 (AButton &button, const TranslatedInternalString commands[], size_t nCommands)
Protected Member Functions inherited from ToolBar
void	SetButton (bool down, AButton *button)
void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)
void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)
void	MakeButtonBackgroundsLarge ()
void	MakeButtonBackgroundsSmall ()
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	Repaint (wxDC *dc)=0
void	OnErase (wxEraseEvent &event)
void	OnPaint (wxPaintEvent &event)
void	OnMouseEvents (wxMouseEvent &event)
Protected Attributes inherited from ToolBar
wxString	mLabel
wxString	mSection
int	mType

Detailed Description

A ToolBar that holds the VU Meter.

Definition at line 32 of file MeterToolBar.h.

Constructor & Destructor Documentation

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

Methods for MeterToolBar.

Definition at line 50 of file MeterToolBar.cpp.

References _(), kWithPlayMeter, kWithRecordMeter, PlayMeterBarID, and RecordMeterBarID.

: ToolBar(type, _("Combined Meter"), wxT("CombinedMeter"), true)
{
   mProject = project;

   if( mType == RecordMeterBarID ){
      mWhichMeters = kWithRecordMeter;
      mLabel = _("Recording Meter");
      mSection = wxT("RecordMeter");
   } else if( mType == PlayMeterBarID ){
      mWhichMeters = kWithPlayMeter;
      mLabel = _("Playback Meter");
      mSection = wxT("PlayMeter");
   } else {
      mWhichMeters = kWithPlayMeter | kWithRecordMeter;
   }
   mSizer = NULL;
   mPlayMeter = NULL;
   mRecordMeter = NULL;
}

MeterToolBar::~MeterToolBar ( )

virtual

Definition at line 71 of file MeterToolBar.cpp.

{
}

Member Function Documentation

void MeterToolBar::Create ( wxWindow *  parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 75 of file MeterToolBar.cpp.

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

{
   ToolBar::Create(parent);

   // Simulate a size event to set initial meter placement/size
   wxSizeEvent dummy;
   OnSize(dummy);
}

void MeterToolBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 44 of file MeterToolBar.h.

{};

bool MeterToolBar::Expose ( bool  show )

overridevirtual

Reimplemented from ToolBar.

Definition at line 240 of file MeterToolBar.cpp.

References ToolBar::Expose(), AudacityProject::GetCaptureMeter(), AudacityProject::GetPlaybackMeter(), mPlayMeter, mProject, mRecordMeter, AudacityProject::SetCaptureMeter(), and AudacityProject::SetPlaybackMeter().

{
   if( show ) {
      if( mPlayMeter ) {
         mProject->SetPlaybackMeter( mPlayMeter );
      }

      if( mRecordMeter ) {
         mProject->SetCaptureMeter( mRecordMeter );
      }
   } else {
      if( mPlayMeter && mProject->GetPlaybackMeter() == mPlayMeter ) {
         mProject->SetPlaybackMeter( NULL );
      }

      if( mRecordMeter && mProject->GetCaptureMeter() == mRecordMeter ) {
         mProject->SetCaptureMeter( NULL );
      }
   }

   return ToolBar::Expose( show );
}

wxSize MeterToolBar::GetDockedSize ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 263 of file MeterToolBar.cpp.

References toolbarGap, and toolbarSingle.

{
   const int tbs = toolbarSingle + toolbarGap;
   wxSize sz = GetSize();
   wxSize sz2 = GetMinSize();
   sz.x = wxMax( sz.x, sz2.x );
   sz.y = wxMax( sz.y, sz2.y );
   // 50 is the size where we switch from expanded to compact.
   if( sz.y < 50 )
      sz.y = tbs-1;
   else 
      sz.y = 2 * tbs -1;
   return sz;
}

int MeterToolBar::GetInitialWidth ( )

inlineoverridevirtual

Resizable toolbars should implement these.

Reimplemented from ToolBar.

Definition at line 50 of file MeterToolBar.h.

References kWithPlayMeter, kWithRecordMeter, and mWhichMeters.

                                  {return (mWhichMeters ==
      (kWithRecordMeter + kWithPlayMeter)) ? 338 : 460;} // Separate bars used to be smaller.

int MeterToolBar::GetMinToolbarWidth ( )

inlineoverridevirtual

Reimplemented from ToolBar.

Definition at line 52 of file MeterToolBar.h.

{ return 150; }

void MeterToolBar::OnSize

(

wxSizeEvent &

event

)

Definition at line 190 of file MeterToolBar.cpp.

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

Referenced by Create().

{
   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();
}

void MeterToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 112 of file MeterToolBar.cpp.

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

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   wxASSERT(mProject); // to justify safenew
   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( _("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( _("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( _("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( _("Meter-Play"));
      mSizer->Add( mPlayMeter, wxGBPosition( (mWhichMeters & kWithRecordMeter)?1:0, 0 ), wxDefaultSpan, wxEXPAND );
   }

   RegenerateTooltips();
}

void MeterToolBar::ReCreateButtons ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 84 of file MeterToolBar.cpp.

References AudacityProject::GetCaptureMeter(), AudacityProject::GetPlaybackMeter(), mPlayMeter, mProject, mRecordMeter, ToolBar::ReCreateButtons(), MeterPanel::RestoreState(), MeterPanel::SaveState(), AudacityProject::SetCaptureMeter(), and AudacityProject::SetPlaybackMeter().

{
   MeterPanel::State playState{ false }, recordState{ false };

   if (mPlayMeter && mProject->GetPlaybackMeter() == mPlayMeter)
   {
      playState = mPlayMeter->SaveState();
      mProject->SetPlaybackMeter( NULL );
   }

   if (mRecordMeter && mProject->GetCaptureMeter() == mRecordMeter)
   {
      recordState = mRecordMeter->SaveState();
      mProject->SetCaptureMeter( NULL );
   }

   ToolBar::ReCreateButtons();

   mPlayMeter->RestoreState(playState);
   if( playState.mSaved  ){
      mProject->SetPlaybackMeter( mPlayMeter );
   }
   mRecordMeter->RestoreState(recordState);
   if( recordState.mSaved ){
      mProject->SetCaptureMeter( mRecordMeter );
   }
}

void MeterToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 180 of file MeterToolBar.cpp.

References _(), mPlayMeter, and mRecordMeter.

Referenced by Populate(), and UpdatePrefs().

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

void MeterToolBar::Repaint ( wxDC *  WXUNUSEDdc )

inlineoverride

Definition at line 43 of file MeterToolBar.h.

{};

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

overridevirtual

Reimplemented from ToolBar.

Definition at line 281 of file MeterToolBar.cpp.

References ToolBar::SetDocked().

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

void MeterToolBar::UpdatePrefs ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 155 of file MeterToolBar.cpp.

References _(), mPlayMeter, mRecordMeter, RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), and MeterPanel::UpdatePrefs().

{
   if( mPlayMeter )
   {
      mPlayMeter->UpdatePrefs();
      mPlayMeter->Refresh();
   }

   if( mRecordMeter )
   {
      mRecordMeter->UpdatePrefs();
      mRecordMeter->Refresh();
   }

   RegenerateTooltips();

   // Set label to pull in language change
   SetLabel(_("Meter"));

   // Give base class a chance
   ToolBar::UpdatePrefs();


}

Member Data Documentation

MeterPanel* MeterToolBar::mPlayMeter

private

Definition at line 62 of file MeterToolBar.h.

Referenced by Expose(), OnSize(), Populate(), ReCreateButtons(), RegenerateTooltips(), and UpdatePrefs().

AudacityProject* MeterToolBar::mProject

private

Definition at line 59 of file MeterToolBar.h.

Referenced by Expose(), Populate(), and ReCreateButtons().

MeterPanel* MeterToolBar::mRecordMeter

private

Definition at line 63 of file MeterToolBar.h.

Referenced by Expose(), OnSize(), Populate(), ReCreateButtons(), RegenerateTooltips(), and UpdatePrefs().

wxGridBagSizer* MeterToolBar::mSizer

private

Definition at line 61 of file MeterToolBar.h.

Referenced by OnSize(), and Populate().

int MeterToolBar::mWhichMeters

private

Definition at line 60 of file MeterToolBar.h.

Referenced by GetInitialWidth(), and Populate().

---

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

• MeterToolBar.h
• MeterToolBar.cpp