A ToolBar that has the main Transport buttons. More...

#include <ControlToolBar.h>

Inheritance diagram for ControlToolBar:

Collaboration diagram for ControlToolBar:

Public Types
enum class	PlayAppearance { Straight , Looped , CutPreview , Scrub , Seek }

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

using	Holder = wxWindowPtr< ToolBar >

Public Member Functions
	ControlToolBar (AudacityProject &project)

virtual	~ControlToolBar ()

void	Create (wxWindow *parent) override

void	UpdatePrefs () override

void	OnKeyEvent (wxKeyEvent &event)

void	OnRewind (wxCommandEvent &evt)

void	OnPlay (wxCommandEvent &evt)

void	OnStop (wxCommandEvent &evt)

void	OnRecord (wxCommandEvent &evt)

void	OnFF (wxCommandEvent &evt)

void	OnPause (wxCommandEvent &evt)

void	OnLoop (wxCommandEvent &evt)

void	OnIdle (wxIdleEvent &event)

void	SetPlay (bool down, PlayAppearance appearance=PlayAppearance::Straight)

void	SetStop ()

void	PlayDefault ()

void	Populate () override

void	Repaint (wxDC *dc) override

void	EnableDisableButtons () override

void	ReCreateButtons () override

void	RegenerateTooltips () override

void	StartScrollingIfPreferred ()

void	StartScrolling ()

void	StopScrolling ()

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 ControlToolBar *	Find (AudacityProject &project)

static ControlToolBar &	Get (AudacityProject &project)

static const ControlToolBar &	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 Types
enum	{ ID_PAUSE_BUTTON = 11000 , ID_PLAY_BUTTON , ID_STOP_BUTTON , ID_FF_BUTTON , ID_REW_BUTTON , ID_RECORD_BUTTON , ID_LOOP_BUTTON , BUTTON_COUNT }

Private Member Functions
void	UpdateStatusBar ()

void	ArrangeButtons ()

TranslatableString	StateForStatusBar ()

Private Attributes
AButton *	mRewind

AButton *	mPlay

AButton *	mRecord

AButton *	mPause

AButton *	mStop

AButton *	mFF

AButton *	mLoop

wxString	mStrLocale

wxBoxSizer *	mSizer

Additional Inherited Members
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 has the main Transport buttons.

In the GUI, this is referred to as "Transport Toolbar", as it corresponds to commands in the Transport menu. "Control Toolbar" is historic. This class, which is a child of Toolbar, creates the window containing the Transport (rewind/play/stop/record/ff) buttons. The window can be embedded within a normal project window, or within a ToolBarFrame.

All of the controls in this window were custom-written for Audacity - they are not native controls on any platform - however, it is intended that the images could be easily replaced to allow "skinning" or just customization to match the look and feel of each platform.

Definition at line 32 of file ControlToolBar.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
ID_PAUSE_BUTTON
ID_PLAY_BUTTON
ID_STOP_BUTTON
ID_FF_BUTTON
ID_REW_BUTTON
ID_RECORD_BUTTON
ID_LOOP_BUTTON
BUTTON_COUNT

Definition at line 91 of file ControlToolBar.h.

   {
      ID_PAUSE_BUTTON = 11000,
      ID_PLAY_BUTTON,
      ID_STOP_BUTTON,
      ID_FF_BUTTON,
      ID_REW_BUTTON,
      ID_RECORD_BUTTON,
      ID_LOOP_BUTTON,
      BUTTON_COUNT,
   };

◆ PlayAppearance

enum class ControlToolBar::PlayAppearance

strong

Enumerator
Straight
Looped
CutPreview
Scrub
Seek

Definition at line 61 of file ControlToolBar.h.

                             {
      Straight, Looped, CutPreview, Scrub, Seek
   };

Constructor & Destructor Documentation

◆ ControlToolBar()

ControlToolBar::ControlToolBar ( AudacityProject & project )

Definition at line 139 of file ControlToolBar.cpp.

: ToolBar(project, XO("Transport"), ID())
{
   mStrLocale = gPrefs->Read(wxT("/Locale/Language"), wxT(""));
 
   mSizer = NULL;
}

References gPrefs, mSizer, mStrLocale, audacity::BasicSettings::Read(), and wxT().

Here is the call graph for this function:

◆ ~ControlToolBar()

ControlToolBar::~ControlToolBar ( )

virtual

Definition at line 147 of file ControlToolBar.cpp.

148{

149}

Member Function Documentation

◆ ArrangeButtons()

void ControlToolBar::ArrangeButtons ( )

private

Definition at line 388 of file ControlToolBar.cpp.

{
   // (Re)allocate the button sizer
   if( mSizer )
   {
      Detach( mSizer );
      std::unique_ptr < wxSizer > {mSizer}; // DELETE it
   }
 
   Add((mSizer = safenew wxBoxSizer(wxHORIZONTAL)), 1, wxEXPAND | wxALL, 5);
 
   // Establish correct tab key sequence with mLoop last
   mPause->MoveBeforeInTabOrder( mLoop );
   mPlay->MoveBeforeInTabOrder( mLoop );
   mStop->MoveBeforeInTabOrder( mLoop );
   mRewind->MoveBeforeInTabOrder( mLoop );
   mFF->MoveBeforeInTabOrder( mLoop );
   mRecord->MoveBeforeInTabOrder( mLoop );
 
   mSizer->Add( mPause,  0, wxRIGHT, 4 );
   mSizer->Add( mPlay,   0, wxRIGHT, 4 );
   mSizer->Add( mStop,   0, wxRIGHT, 4 );
   mSizer->Add( mRewind, 0, wxRIGHT, 4 );
   mSizer->Add( mFF,     0, wxRIGHT, 8 );
   mSizer->Add( mRecord, 0, wxRIGHT, 8 );
   mSizer->Add( mLoop );
 
   // Layout the sizer
   mSizer->Layout();
 
   // Layout the toolbar
   Layout();
 
   // (Re)Establish the minimum size
   SetMinSize( GetSizer()->GetMinSize() );
}

References ToolBar::Add(), ToolBar::Detach(), ToolBar::GetSizer(), mFF, mLoop, mPause, mPlay, mRecord, mRewind, mSizer, mStop, and safenew.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void ControlToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 171 of file ControlToolBar.cpp.

{
   ToolBar::Create(parent);
   UpdatePrefs();
}

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

Here is the call graph for this function:

◆ EnableDisableButtons()

void ControlToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 485 of file ControlToolBar.cpp.

{
   AudacityProject *p = &mProject;
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
   bool canStop = projectAudioManager.CanStopAudioStream();
 
   bool paused = mPause->IsDown();
   bool playing = mPlay->IsDown();
   bool recording = mRecord->IsDown();
   auto gAudioIO = AudioIO::Get();
   bool busy = gAudioIO->IsBusy();
 
   // Only interested in audio type tracks
   bool tracks = p && TrackList::Get(*p).Any<AudioTrack>(); // PRL:  PlayableTrack ?
 
   mPlay->SetEnabled( canStop && tracks && !recording );
   mRecord->SetEnabled(
      canStop &&
      !(busy && !recording && !paused) &&
      !(playing && !paused)
   );
   mStop->SetEnabled(canStop && (playing || recording));
   mRewind->SetEnabled(paused || (!playing && !recording));
   mFF->SetEnabled(tracks && (paused || (!playing && !recording)));
 
   mPause->SetEnabled(canStop);
 
   mLoop->SetEnabled( !recording );
}

References TrackList::Any(), AudioIO::Get(), TrackList::Get(), ProjectAudioManager::Get(), AButton::IsDown(), mFF, mLoop, mPause, mPlay, ToolBar::mProject, mRecord, mRewind, mStop, AButton::SetEnabled(), and tracks.

Referenced by OnIdle(), ReCreateButtons(), SetPlay(), and SetStop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Find()

ControlToolBar * ControlToolBar::Find ( AudacityProject & project )

static

Definition at line 152 of file ControlToolBar.cpp.

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

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

Here is the call graph for this function:

◆ Get() [1/2]

ControlToolBar & ControlToolBar::Get ( AudacityProject & project )

static

Definition at line 159 of file ControlToolBar.cpp.

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

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

Referenced by TransportUtilities::DoStopPlaying(), Get(), anonymous_namespace{TransportMenus.cpp}::MakeReadyToPlay(), SelectActions::Handler::OnSkipEnd(), and SelectActions::Handler::OnSkipStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 166 of file ControlToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

Identifier ControlToolBar::ID ( )

static

Definition at line 129 of file ControlToolBar.cpp.

{
   return wxT("Control");
}

References wxT().

Referenced by Find(), and Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnFF()

void ControlToolBar::OnFF ( wxCommandEvent & evt )

Definition at line 707 of file ControlToolBar.cpp.

{
   mFF->PushDown();
   mFF->PopUp();
 
   AudacityProject *p = &mProject;
 
   {
      ProjectAudioManager::Get( *p ).StopIfPaused();
      Viewport::Get(*p).ScrollToEnd(mFF->WasShiftDown());
   }
}

References Viewport::Get(), ProjectAudioManager::Get(), mFF, ToolBar::mProject, AButton::PopUp(), AButton::PushDown(), Viewport::ScrollToEnd(), ProjectAudioManager::StopIfPaused(), and AButton::WasShiftDown().

Here is the call graph for this function:

◆ OnIdle()

void ControlToolBar::OnIdle ( wxIdleEvent & event )

Definition at line 628 of file ControlToolBar.cpp.

{
   event.Skip();
 
   if (!wxTheApp->IsActive())
      return;
 
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
   if ( projectAudioManager.Paused() )
      mPause->PushDown();
   else
      mPause->PopUp();
 
   bool recording = projectAudioManager.Recording();
   if (!recording) {
      mRecord->PopUp();
      mRecord->SetAlternateIdx( wxGetKeyState(WXK_SHIFT) ? 1 : 0 );
   }
   else {
      mRecord->PushDown();
      mRecord->SetAlternateIdx( projectAudioManager.Appending() ? 0 : 1 );
   }
 
   bool playing = projectAudioManager.Playing();
   if ( !(playing || Scrubber::Get(mProject).HasMark()) ) {
      mPlay->PopUp();
      mPlay->SetAlternateIdx(
         wxGetKeyState(WXK_CONTROL)
         ? 2
         : wxGetKeyState(WXK_SHIFT)
            ? 1
            : 0
      );
   }
   else {
      mPlay->PushDown();
      // Choose among alternative appearances of the play button, although
      // options 0 and 1 became non-distinct in 3.1.0
      mPlay->SetAlternateIdx(
         projectAudioManager.Cutting()
         ? 2
         // : projectAudioManager.Looping()
            // ? 1
            : 0
      );
   }
 
   if ( recording || playing )
      StartScrollingIfPreferred();
   else
      StopScrolling();
 
   if ( projectAudioManager.Stopping() )
      mStop->PushDown();
   else
      // push-downs of the stop button are only momentary and always pop up now
      mStop->PopUp();
 
   if (ViewInfo::Get(mProject).playRegion.Active())
      mLoop->PushDown();
   else
      mLoop->PopUp();
   
   UpdateStatusBar();
   EnableDisableButtons();
}

References EnableDisableButtons(), ViewInfo::Get(), ProjectAudioManager::Get(), Scrubber::Get(), mLoop, mPause, mPlay, ToolBar::mProject, mRecord, mStop, AButton::PopUp(), AButton::PushDown(), AButton::SetAlternateIdx(), StartScrollingIfPreferred(), StopScrolling(), and UpdateStatusBar().

Here is the call graph for this function:

◆ OnKeyEvent()

void ControlToolBar::OnKeyEvent ( wxKeyEvent & event )

Definition at line 536 of file ControlToolBar.cpp.

{
   // PRL: is this handler really ever reached?  Is the ControlToolBar ever
   // focused?  Isn't there a global event filter that interprets the spacebar
   // key (or other key chosen in preferences) and dispatches to DoPlayStop,
   // according to CommandManager's table, before we come to this redundant
   // function?
 
   if (event.ControlDown() || event.AltDown()) {
      event.Skip();
      return;
   }
 
   auto gAudioIO = AudioIOBase::Get();
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
 
   // Does not appear to be needed on Linux. Perhaps on some other platform?
   // If so, "!CanStopAudioStream()" should probably apply.
   if (event.GetKeyCode() == WXK_SPACE) {
      if ( projectAudioManager.Playing() || projectAudioManager.Recording() ) {
         SetStop();
         projectAudioManager.Stop();
      }
      else if (!gAudioIO->IsBusy()) {
         projectAudioManager.PlayCurrentRegion();
      }
      return;
   }
   event.Skip();
}

References AudioIOBase::Get(), ProjectAudioManager::Get(), ToolBar::mProject, and SetStop().

Here is the call graph for this function:

◆ OnLoop()

void ControlToolBar::OnLoop ( wxCommandEvent & evt )

Definition at line 618 of file ControlToolBar.cpp.

{
   // Toggle the state of the play region lock
   auto &region = ViewInfo::Get(mProject).playRegion;
   if (region.Active())
      SelectUtilities::InactivatePlayRegion(mProject);
   else
      SelectUtilities::ActivatePlayRegion(mProject);
}

References SelectUtilities::ActivatePlayRegion(), ViewInfo::Get(), SelectUtilities::InactivatePlayRegion(), ToolBar::mProject, and ViewInfo::playRegion.

Here is the call graph for this function:

◆ OnPause()

void ControlToolBar::OnPause ( wxCommandEvent & evt )

Definition at line 613 of file ControlToolBar.cpp.

{
   ProjectAudioManager::Get( mProject ).OnPause();
}

References ProjectAudioManager::Get(), ToolBar::mProject, and ProjectAudioManager::OnPause().

Here is the call graph for this function:

◆ OnPlay()

void ControlToolBar::OnPlay ( wxCommandEvent & evt )

Definition at line 567 of file ControlToolBar.cpp.

{
   auto p = &mProject;
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
   bool canStop = projectAudioManager.CanStopAudioStream();
 
   if ( !canStop )
      return;
 
   projectAudioManager.Stop();
 
   PlayDefault();
}

References ProjectAudioManager::Get(), ToolBar::mProject, and PlayDefault().

Here is the call graph for this function:

◆ OnRecord()

void ControlToolBar::OnRecord ( wxCommandEvent & evt )

Exception safety guarantee:: Strong – For state of current project's tracks

Definition at line 602 of file ControlToolBar.cpp.

{
   // TODO: It would be neater if Menu items and Toolbar buttons used the same code for
   // enabling/disabling, and all fell into the same action routines.
   // Here instead we reduplicate some logic (from CommandHandler) because it isn't
   // normally used for buttons.
 
   bool altAppearance = mRecord->WasShiftDown();
   ProjectAudioManager::Get( mProject ).OnRecord( altAppearance );
}

References ProjectAudioManager::Get(), ToolBar::mProject, mRecord, ProjectAudioManager::OnRecord(), and AButton::WasShiftDown().

Here is the call graph for this function:

◆ OnRewind()

void ControlToolBar::OnRewind ( wxCommandEvent & evt )

Definition at line 695 of file ControlToolBar.cpp.

{
   mRewind->PushDown();
   mRewind->PopUp();
 
   AudacityProject *p = &mProject;
   {
      ProjectAudioManager::Get( *p ).StopIfPaused();
      Viewport::Get(*p).ScrollToStart(mRewind->WasShiftDown());
   }
}

References Viewport::Get(), ProjectAudioManager::Get(), ToolBar::mProject, mRewind, AButton::PopUp(), AButton::PushDown(), Viewport::ScrollToStart(), ProjectAudioManager::StopIfPaused(), and AButton::WasShiftDown().

Here is the call graph for this function:

◆ OnStop()

void ControlToolBar::OnStop ( wxCommandEvent & evt )

Definition at line 581 of file ControlToolBar.cpp.

{
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
   bool canStop = projectAudioManager.CanStopAudioStream();
 
   if ( canStop ) {
      projectAudioManager.Stop();
   }
}

References ProjectAudioManager::Get(), and ToolBar::mProject.

Here is the call graph for this function:

◆ PlayDefault()

void ControlToolBar::PlayDefault ( )

Definition at line 591 of file ControlToolBar.cpp.

{
   // Let control-down have precedence over shift state
   const bool cutPreview = mPlay->WasControlDown();
   const bool newDefault = !cutPreview &&
      !mPlay->WasShiftDown();
   ProjectAudioManager::Get( mProject )
      .PlayCurrentRegion(newDefault, cutPreview);
}

References ProjectAudioManager::Get(), mPlay, ToolBar::mProject, ProjectAudioManager::PlayCurrentRegion(), AButton::WasControlDown(), and AButton::WasShiftDown().

Referenced by OnPlay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Populate()

void ControlToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 177 of file ControlToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   MakeButtonBackgroundsLarge();
 
   mPause = MakeControlToolBarButton(
      this,
      ID_PAUSE_BUTTON,
      XO("Pause"),
      theTheme.Image(bmpPause),
      wxNullImage,
      theTheme.Image(bmpPauseDisabled));
   mPause->SetButtonToggles(true);
 
   mPlay = MakeControlToolBarButton(
      this,
      ID_PLAY_BUTTON,
      XO("Play"),
      theTheme.Image(bmpPlay),
      wxNullImage,
      theTheme.Image(bmpPlayDisabled));
   mPlay->SetButtonToggles(true);
   mPlay->FollowModifierKeys();
   // 3.1.0 abandoned distinct images for Shift
   mPlay->SetAlternateIcons(2,
      theTheme.Image(bmpCutPreview),
      wxNullImage,
      theTheme.Image(bmpCutPreviewDisabled));
   mPlay->SetAlternateIcons(3,
      theTheme.Image(bmpScrub),
      wxNullImage,
      theTheme.Image(bmpScrubDisabled));
   mPlay->SetAlternateIcons(4,
      theTheme.Image(bmpSeek),
      wxNullImage,
      theTheme.Image(bmpSeekDisabled));
 
 
   mStop = MakeControlToolBarButton(this,
      ID_STOP_BUTTON,
      XO("Stop"),
      theTheme.Image(bmpStop),
      wxNullImage,
      theTheme.Image(bmpStopDisabled));
 
   mRewind = MakeControlToolBarButton(this,
      ID_REW_BUTTON,
      XO("Skip to Start"),
      theTheme.Image(bmpRewind),
      wxNullImage,
      theTheme.Image(bmpRewindDisabled));
 
   mFF = MakeControlToolBarButton(this,
      ID_FF_BUTTON,
      XO("Skip to End"),
      theTheme.Image(bmpFFwd),
      wxNullImage,
      theTheme.Image(bmpFFwdDisabled));
 
   mRecord = MakeControlToolBarButton(this,
      ID_RECORD_BUTTON,
      XO("Record"),
      theTheme.Image(bmpRecord),
      wxNullImage,
      theTheme.Image(bmpRecordDisabled));
   mRecord->FollowModifierKeys();
 
   bool bPreferNewTrack;
   gPrefs->Read("/GUI/PreferNewTrackRecord",&bPreferNewTrack, false);
   if( !bPreferNewTrack )
   {
      mRecord->SetAlternateIcons(1,
         theTheme.Image(bmpRecordBelow),
         wxNullImage,
         theTheme.Image(bmpRecordBelowDisabled));
   }
   else
   {
      mRecord->SetAlternateIcons(1,
         theTheme.Image(bmpRecordBeside),
         wxNullImage,
         theTheme.Image(bmpRecordBesideDisabled));
   }
 
   mLoop = MakeControlToolBarButton(this,
      ID_LOOP_BUTTON,
      LoopToggleText.Stripped(),
      theTheme.Image(bmpLoop),
      wxNullImage,
      theTheme.Image(bmpLoopDisabled));
   mLoop->SetButtonToggles(true);// this makes it a toggle, like the pause button
 
#if wxUSE_TOOLTIPS
   RegenerateTooltips();
   wxToolTip::Enable(true);
   wxToolTip::SetDelay(1000);
#endif
 
   // Set default order and mode
   ArrangeButtons();
}

References ArrangeButtons(), ThemeBase::Colour(), AButton::FollowModifierKeys(), gPrefs, ID_FF_BUTTON, ID_LOOP_BUTTON, ID_PAUSE_BUTTON, ID_PLAY_BUTTON, ID_RECORD_BUTTON, ID_REW_BUTTON, ID_STOP_BUTTON, ThemeBase::Image(), LoopToggleText, ToolBar::MakeButtonBackgroundsLarge(), anonymous_namespace{ControlToolBar.cpp}::MakeControlToolBarButton(), mFF, mLoop, mPause, mPlay, mRecord, mRewind, mStop, audacity::BasicSettings::Read(), RegenerateTooltips(), AButton::SetAlternateIcons(), AButton::SetButtonToggles(), TranslatableString::Stripped(), theTheme, and XO().

Here is the call graph for this function:

◆ ReCreateButtons()

void ControlToolBar::ReCreateButtons ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 425 of file ControlToolBar.cpp.

{
   bool playDown = false;
   bool playShift = false;
   bool pauseDown = false;
   bool recordDown = false;
   bool recordShift = false;
   bool loopDown = false;
 
   // ToolBar::ReCreateButtons() will get rid of its sizer and
   // since we've attached our sizer to it, ours will get deleted too
   // so clean ours up first.
   if( mSizer )
   {
      playDown = mPlay->IsDown();
      playShift = mPlay->WasShiftDown();
      pauseDown = mPause->IsDown();
      recordDown = mRecord->IsDown();
      recordShift = mRecord->WasShiftDown();
      loopDown = mLoop->IsDown();
      Detach( mSizer );
 
      std::unique_ptr < wxSizer > {mSizer}; // DELETE it
      mSizer = NULL;
   }
 
   ToolBar::ReCreateButtons();
 
   if (playDown)
   {
      ControlToolBar::PlayAppearance appearance =
         playShift ? ControlToolBar::PlayAppearance::Looped
         : ControlToolBar::PlayAppearance::Straight;
      SetPlay(playDown, appearance);
   }
 
   if (pauseDown)
   {
      mPause->PushDown();
   }
 
   if (recordDown)
   {
      mRecord->SetAlternateIdx(recordShift ? 1 : 0);
      mRecord->PushDown();
   }
 
   if (loopDown)
      mLoop->PushDown();
 
   EnableDisableButtons();
 
   RegenerateTooltips();
}

References ToolBar::Detach(), EnableDisableButtons(), AButton::IsDown(), Looped, mLoop, mPause, mPlay, mRecord, mSizer, AButton::PushDown(), ToolBar::ReCreateButtons(), RegenerateTooltips(), AButton::SetAlternateIdx(), SetPlay(), Straight, and AButton::WasShiftDown().

Referenced by UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegenerateTooltips()

void ControlToolBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 279 of file ControlToolBar.cpp.

{
#if wxUSE_TOOLTIPS
   for (long iWinID = ID_PAUSE_BUTTON; iWinID < BUTTON_COUNT; iWinID++)
   {
      auto pCtrl = static_cast<AButton*>(this->FindWindow(iWinID));
      CommandID name;
      switch (iWinID)
      {
         case ID_PLAY_BUTTON:
            // Without shift
            name = wxT("DefaultPlayStop");
            break;
         case ID_RECORD_BUTTON:
            // Without shift
            //name = wxT("Record");
            name = wxT("Record1stChoice");
            break;
         case ID_PAUSE_BUTTON:
            name = wxT("Pause");
            break;
         case ID_STOP_BUTTON:
            name = wxT("Stop");
            break;
         case ID_FF_BUTTON:
            name = wxT("CursProjectEnd");
            break;
         case ID_REW_BUTTON:
            name = wxT("CursProjectStart");
            break;
         case ID_LOOP_BUTTON:
            name = wxT("TogglePlayRegion");
            break;
      }
      std::vector<ComponentInterfaceSymbol> commands(
         1u, { name, Verbatim( pCtrl->GetLabel() ) } );
 
      // Some have a second
      switch (iWinID)
      {
         case ID_PLAY_BUTTON:
            // With shift
            commands.push_back( { wxT("OncePlayStop"), XO("Play Once") } );
            break;
         case ID_RECORD_BUTTON:
            // With shift
            {  bool bPreferNewTrack;
               gPrefs->Read("/GUI/PreferNewTrackRecord",&bPreferNewTrack, false);
               // For the shortcut tooltip.
               commands.push_back( {
                  wxT("Record2ndChoice"),
                  !bPreferNewTrack
                     ? XO("Record New Track")
                     : XO("Append Record")
               } );
            }
            break;
         case ID_PAUSE_BUTTON:
            break;
         case ID_STOP_BUTTON:
            break;
         case ID_FF_BUTTON:
            // With shift
            commands.push_back( {
               wxT("SelEnd"), XO("Select to End") } );
            break;
         case ID_REW_BUTTON:
            // With shift
            commands.push_back( {
               wxT("SelStart"), XO("Select to Start") } );
            break;
      }
      ToolBar::SetButtonToolTip(
         mProject, *pCtrl, commands.data(), commands.size());
   }
#endif
}

References BUTTON_COUNT, gPrefs, ID_FF_BUTTON, ID_LOOP_BUTTON, ID_PAUSE_BUTTON, ID_PLAY_BUTTON, ID_RECORD_BUTTON, ID_REW_BUTTON, ID_STOP_BUTTON, ToolBar::mProject, name, audacity::BasicSettings::Read(), ToolBar::SetButtonToolTip(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), Verbatim(), wxT(), and XO().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void ControlToolBar::Repaint ( wxDC * dc )

overridevirtual

Implements ToolBar.

Definition at line 480 of file ControlToolBar.cpp.

{
   // this was used to draw a bevel and can be removed.
}

◆ SetPlay()

void ControlToolBar::SetPlay	(	bool	down,
		PlayAppearance	appearance = `PlayAppearance::Straight`
	)

Definition at line 515 of file ControlToolBar.cpp.

{
   if (down) {
      mPlay->SetShift(appearance == PlayAppearance::Looped);
      mPlay->SetControl(appearance == PlayAppearance::CutPreview);
      mPlay->SetAlternateIdx(static_cast<int>(appearance));
      mPlay->PushDown();
   }
   else {
      mPlay->PopUp();
      mPlay->SetAlternateIdx(0);
   }
   EnableDisableButtons();
}

References CutPreview, EnableDisableButtons(), Looped, mPlay, AButton::PopUp(), AButton::PushDown(), AButton::SetAlternateIdx(), AButton::SetControl(), and AButton::SetShift().

Referenced by ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetStop()

void ControlToolBar::SetStop ( )

Definition at line 530 of file ControlToolBar.cpp.

{
   mStop->PushDown();
   EnableDisableButtons();
}

References EnableDisableButtons(), mStop, and AButton::PushDown().

Referenced by OnKeyEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartScrolling()

void ControlToolBar::StartScrolling ( )

Definition at line 791 of file ControlToolBar.cpp.

{
   using Mode = ProjectWindow::PlaybackScroller::Mode;
   const auto project = &mProject;
   if (project) {
      auto mode = Mode::Pinned;
 
#if 0
      // Enable these lines to pin the playhead right instead of center,
      // when recording but not overdubbing.
      auto gAudioIO = AudioIO::Get();
      if (gAudioIO->GetNumCaptureChannels() > 0) {
         // recording
 
         // Display a fixed recording head while scrolling the waves continuously.
         // If you overdub, you may want to anticipate some context in existing tracks,
         // so center the head.  If not, put it rightmost to display as much wave as we can.
         bool duplex;
         gPrefs->Read(wxT("/AudioIO/Duplex"), &duplex, true);
         if (duplex) {
            // See if there is really anything being overdubbed
            if (gAudioIO->GetNumPlaybackChannels() == 0)
               // No.
               duplex = false;
         }
 
         if (!duplex)
            mode = Mode::Right;
      }
#endif
 
      ProjectWindow::Get( *project ).GetPlaybackScroller().Activate(mode);
   }
}

References ProjectWindow::PlaybackScroller::Activate(), AudioIO::Get(), ProjectWindow::Get(), ProjectWindow::GetPlaybackScroller(), gPrefs, ToolBar::mProject, project, audacity::BasicSettings::Read(), and wxT().

Referenced by StartScrollingIfPreferred().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartScrollingIfPreferred()

void ControlToolBar::StartScrollingIfPreferred ( )

Definition at line 773 of file ControlToolBar.cpp.

{
   if ( Scrubber::Get( mProject ).IsTransportingPinned() )
      StartScrolling();
#ifdef __WXMAC__
   else if (Scrubber::Get( mProject ).HasMark()) {
      // PRL:  cause many "unnecessary" refreshes.  For reasons I don't understand,
      // doing this causes wheel rotation events (mapped from the double finger vertical
      // swipe) to be delivered more uniformly to the application, so that speed control
      // works better.
      ProjectWindow::Get( mProject ).GetPlaybackScroller().Activate
         (ProjectWindow::PlaybackScroller::Mode::Refresh);
   }
#endif
   else
      StopScrolling();
}

References ProjectWindow::PlaybackScroller::Activate(), ProjectWindow::Get(), Scrubber::Get(), ProjectWindow::GetPlaybackScroller(), ToolBar::mProject, ProjectWindow::PlaybackScroller::Refresh, StartScrolling(), and StopScrolling().

Referenced by OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StateForStatusBar()

TranslatableString ControlToolBar::StateForStatusBar ( )

private

Definition at line 744 of file ControlToolBar.cpp.

{
   TranslatableString state;
   auto &projectAudioManager = ProjectAudioManager::Get( mProject );
 
   auto pProject = &mProject;
   auto scrubState = pProject
      ? Scrubber::Get( *pProject ).GetUntranslatedStateString()
      : TranslatableString{};
   if (!scrubState.empty())
      state = scrubState;
   else if (mPlay->IsDown())
      state = sStatePlay;
   else if (projectAudioManager.Recording())
      state = sStateRecord;
   else
      state = sStateStop;
 
   return ((mPause->IsDown()) ? XO("%s Paused.") : XO("%s."))
      .Format( state );
}

References TranslatableString::Format(), ProjectAudioManager::Get(), Scrubber::Get(), Scrubber::GetUntranslatedStateString(), AButton::IsDown(), mPause, mPlay, ToolBar::mProject, anonymous_namespace{ControlToolBar.cpp}::sStatePlay, anonymous_namespace{ControlToolBar.cpp}::sStateRecord, anonymous_namespace{ControlToolBar.cpp}::sStateStop, and XO().

Referenced by UpdateStatusBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopScrolling()

void ControlToolBar::StopScrolling ( )

Definition at line 826 of file ControlToolBar.cpp.

{
   const auto project = &mProject;
   if(project)
      ProjectWindow::Get( *project ).GetPlaybackScroller().Activate
         (ProjectWindow::PlaybackScroller::Mode::Off);
}

References ProjectWindow::PlaybackScroller::Activate(), ProjectWindow::Get(), ProjectWindow::GetPlaybackScroller(), ToolBar::mProject, ProjectWindow::PlaybackScroller::Off, and project.

Referenced by OnIdle(), and StartScrollingIfPreferred().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePrefs()

void ControlToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 357 of file ControlToolBar.cpp.

{
   bool updated = false;
   bool active;
 
   wxString strLocale = gPrefs->Read(wxT("/Locale/Language"), wxT(""));
   if (mStrLocale != strLocale)
   {
      mStrLocale = strLocale;
      updated = true;
   }
 
   if( updated )
   {
      ReCreateButtons(); // side effect: calls RegenerateTooltips()
      Updated();
   }
   else
      // The other reason to regenerate tooltips is if keyboard shortcuts for
      // transport buttons changed, but that's too much work to check for, so just
      // always do it. (Much cheaper than calling ReCreateButtons() in all cases.
      RegenerateTooltips();
 
 
   // Set label to pull in language change
   SetLabel(XO("Transport"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References gPrefs, mStrLocale, audacity::BasicSettings::Read(), ReCreateButtons(), RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::Updated(), ToolBar::UpdatePrefs(), wxT(), and XO().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateStatusBar()

void ControlToolBar::UpdateStatusBar ( )

private

Definition at line 766 of file ControlToolBar.cpp.

{
   ProjectStatus::Get( mProject ).Set(
      StateForStatusBar(), StateStatusBarField()
   );
}

References ProjectStatus::Get(), ToolBar::mProject, ProjectStatus::Set(), StateForStatusBar(), and StateStatusBarField().

Referenced by OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mFF

AButton* ControlToolBar::mFF

private

Definition at line 108 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnFF(), and Populate().

◆ mLoop

AButton* ControlToolBar::mLoop

private

Definition at line 109 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnIdle(), Populate(), and ReCreateButtons().

◆ mPause

AButton* ControlToolBar::mPause

private

Definition at line 106 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnIdle(), Populate(), ReCreateButtons(), and StateForStatusBar().

◆ mPlay

AButton* ControlToolBar::mPlay

private

Definition at line 104 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnIdle(), PlayDefault(), Populate(), ReCreateButtons(), SetPlay(), and StateForStatusBar().

◆ mRecord

AButton* ControlToolBar::mRecord

private

Definition at line 105 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnIdle(), OnRecord(), Populate(), and ReCreateButtons().

◆ mRewind

AButton* ControlToolBar::mRewind

private

Definition at line 103 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnRewind(), and Populate().

◆ mSizer

wxBoxSizer* ControlToolBar::mSizer

private

Definition at line 113 of file ControlToolBar.h.

Referenced by ArrangeButtons(), ControlToolBar(), and ReCreateButtons().

◆ mStop

AButton* ControlToolBar::mStop

private

Definition at line 107 of file ControlToolBar.h.

Referenced by ArrangeButtons(), EnableDisableButtons(), OnIdle(), Populate(), and SetStop().

◆ mStrLocale

wxString ControlToolBar::mStrLocale

private

Definition at line 111 of file ControlToolBar.h.

Referenced by ControlToolBar(), and UpdatePrefs().

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

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ PlayAppearance

Constructor & Destructor Documentation

◆ ControlToolBar()

◆ ~ControlToolBar()

Member Function Documentation

◆ ArrangeButtons()

◆ Create()

◆ EnableDisableButtons()

◆ Find()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ OnFF()

◆ OnIdle()

◆ OnKeyEvent()

◆ OnLoop()

◆ OnPause()

◆ OnPlay()

◆ OnRecord()

◆ OnRewind()

◆ OnStop()

◆ PlayDefault()

◆ Populate()

◆ ReCreateButtons()

◆ RegenerateTooltips()

◆ Repaint()

◆ SetPlay()

◆ SetStop()

◆ StartScrolling()

◆ StartScrollingIfPreferred()

◆ StateForStatusBar()

◆ StopScrolling()

◆ UpdatePrefs()

◆ UpdateStatusBar()

Member Data Documentation

◆ mFF

◆ mLoop

◆ mPause

◆ mPlay

◆ mRecord

◆ mRewind

◆ mSizer

◆ mStop

◆ mStrLocale