#include <ScrubbingToolBar.h>

Inheritance diagram for ScrubbingToolBar:

Collaboration diagram for ScrubbingToolBar:

Public Member Functions
	ScrubbingToolBar (AudacityProject &project)

virtual	~ScrubbingToolBar ()

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

void	Create (wxWindow *parent) override

void	OnButton (wxCommandEvent &event)

void	Populate () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	UpdatePrefs () override

void	RegenerateTooltips () override

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

virtual	~ToolBar ()

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

virtual bool	HideAfterReset () const
	Default implementation returns false. More...

virtual DockID	DefaultDockID () const
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

virtual void	SetToDefaultSize ()

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

virtual void	RegenerateTooltips ()=0

int	GetIndex () const
	Get a value used for computing cascading positions of undocked bars. More...

void	SetIndex (int index)
	Set a value used for computing cascading positions of undocked bars. More...

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

Identifier	GetSection ()

ToolDock *	GetDock ()

void	SetPreferredNeighbors (Identifier left, Identifier top={})

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

std::pair< Identifier, Identifier >	PreferredNeighbors () const noexcept
	Defaults to (NoBarID, NoBarId) More...

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

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

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

wxSize	GetSmartDockedSize ()

virtual void	ResizingDone ()

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Static Public Member Functions
static Identifier	ID ()

static ScrubbingToolBar &	Get (AudacityProject &project)

static const ScrubbingToolBar &	Get (const AudacityProject &project)

Static Public Member Functions inherited from ToolBar
static AButton *	MakeButton (wxWindow *parent, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxWindowID id, wxPoint placement, bool processdownevents, wxSize size)

static AButton *	MakeButton (ToolBar *parent, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, bool processdownevents, const TranslatableString &label)

static void	MakeAlternateImages (AButton &button, int idx, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxSize size)

static void	SetButtonToolTip (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)

static void	MakeButtonBackgroundsSmall ()

static void	MakeButtonBackgroundsLarge ()

Private Member Functions
void	MakeButtons ()

void	OnIdle (wxIdleEvent &evt)

void	DoRegenerateTooltips (bool force)

Static Private Member Functions
static AButton *	AddButton (ScrubbingToolBar *pBar, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, const TranslatableString &label, bool toggle=false)

Private Attributes
AButton *	mButtons [STBNumButtons]

wxImage *	upImage

wxImage *	downImage

wxImage *	hiliteImage

bool	mLastScrub { false }

bool	mLastSeek { false }

bool	mLastRuler { false }

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

Definition at line 39 of file ScrubbingToolBar.h.

Constructor & Destructor Documentation

◆ ScrubbingToolBar()

ScrubbingToolBar::ScrubbingToolBar ( AudacityProject & project )

Definition at line 57 of file ScrubbingToolBar.cpp.

: ToolBar(project, XO("Scrub"), ID())
{
}

◆ ~ScrubbingToolBar()

ScrubbingToolBar::~ScrubbingToolBar ( )

virtual

Definition at line 62 of file ScrubbingToolBar.cpp.

63{

64}

Member Function Documentation

◆ AddButton()

AButton * ScrubbingToolBar::AddButton	(	ScrubbingToolBar *	pBar,
		teBmps	eEnabledUp,
		teBmps	eEnabledDown,
		teBmps	eDisabled,
		int	id,
		const TranslatableString &	label,
		bool	toggle = `false`
	)

staticprivate

This is a convenience function that allows for button creation in MakeButtons() with fewer arguments Very similar to code in ControlToolBar...

Definition at line 91 of file ScrubbingToolBar.cpp.

{
   AButton *&r = pBar->mButtons[id];
 
   r = ToolBar::MakeButton
   (pBar,
    bmpRecoloredUpSmall, bmpRecoloredDownSmall, bmpRecoloredUpHiliteSmall, bmpRecoloredHiliteSmall,
    eEnabledUp, eEnabledDown, eDisabled,
    wxWindowID(id),
    wxDefaultPosition,
    toggle,
    theTheme.ImageSize( bmpRecoloredUpSmall ));
 
   r->SetLabel(label);
   // JKC: Unlike ControlToolBar, does not have a focus rect.  Shouldn't it?
   // r->SetFocusRect( r->GetRect().Deflate( 4, 4 ) );
 
   pBar->Add( r, 0, wxALIGN_CENTER );
 
   return r;
}

References ToolBar::Add(), id, ThemeBase::ImageSize(), label, ToolBar::MakeButton(), mButtons, AButton::SetLabel(), and theTheme.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Create()

void ScrubbingToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 82 of file ScrubbingToolBar.cpp.

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

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

Here is the call graph for this function:

◆ DoRegenerateTooltips()

void ScrubbingToolBar::DoRegenerateTooltips ( bool force )

private

Definition at line 152 of file ScrubbingToolBar.cpp.

{
#if wxUSE_TOOLTIPS
   auto fn = [&](
      AButton &button, const TranslatableString &label, const CommandID &cmd)
   {
      ComponentInterfaceSymbol command{ cmd, label };
      ToolBar::SetButtonToolTip( mProject, button, &command, 1u );
   };
 
   auto project = &mProject;
   if (project) {
      auto &scrubber = Scrubber::Get( *project );
 
      const auto scrubButton = mButtons[STBScrubID];
      const auto seekButton = mButtons[STBSeekID];
 
      TranslatableString label;
      bool scrubs = scrubber.Scrubs();
      if (force || mLastScrub != scrubs) {
         label = (
                  scrubs
                  /* i18n-hint: These commands assist the user in finding a sound by ear. ...
                   "Scrubbing" is variable-speed playback, ...
                   "Seeking" is normal speed playback but with skips
                   */
                  ? XO("Stop Scrubbing")
                  /* i18n-hint: These commands assist the user in finding a sound by ear. ...
                   "Scrubbing" is variable-speed playback, ...
                   "Seeking" is normal speed playback but with skips
                   */
                  : XO("Start Scrubbing")
                  );
         fn(*scrubButton, label, wxT("Scrub"));
      }
      mLastScrub = scrubs;
 
      bool seeks = scrubber.Seeks();
      if (force || mLastSeek != seeks) {
         label = (
                  seeks
                  /* i18n-hint: These commands assist the user in finding a sound by ear. ...
                   "Scrubbing" is variable-speed playback, ...
                   "Seeking" is normal speed playback but with skips
                   */
                  ? XO("Stop Seeking")
                  /* i18n-hint: These commands assist the user in finding a sound by ear. ...
                   "Scrubbing" is variable-speed playback, ...
                   "Seeking" is normal speed playback but with skips
                   */
                  : XO("Start Seeking")
                  );
         fn(*seekButton, label, wxT("Seek"));
      }
      mLastSeek = seeks;
 
      bool showingRuler = AdornedRulerPanel::Get( *project ).ShowingScrubRuler();
      if (force || mLastRuler != showingRuler) {
         label = (
                  showingRuler
                  ? XO("Hide Scrub Ruler")
                  : XO("Show Scrub Ruler")
                  );
         fn(*mButtons[STBRulerID], label, wxT("ToggleScrubRuler"));
      }
      mLastRuler = showingRuler;
   }
#endif
}

References fn, AdornedRulerPanel::Get(), Scrubber::Get(), label, mButtons, mLastRuler, mLastScrub, mLastSeek, ToolBar::mProject, project, ToolBar::SetButtonToolTip(), AdornedRulerPanel::ShowingScrubRuler(), STBRulerID, STBScrubID, STBSeekID, wxT(), and XO().

Referenced by EnableDisableButtons(), and RegenerateTooltips().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableDisableButtons()

void ScrubbingToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 247 of file ScrubbingToolBar.cpp.

{
   const auto scrubButton = mButtons[STBScrubID];
   const auto seekButton = mButtons[STBSeekID];
 
   AudacityProject *p = &mProject;
 
   auto &scrubber = Scrubber::Get( *p );
   const auto canScrub = scrubber.CanScrub();
 
   if (scrubber.Scrubs()) {
      scrubButton->PushDown();
      scrubButton->Enable();
   }
   else {
      scrubButton->PopUp();
      if (canScrub)
         scrubButton->Enable();
      else
         scrubButton->Disable();
   }
 
   if (scrubber.Seeks()) {
      seekButton->PushDown();
      seekButton->Enable();
   }
   else {
      seekButton->PopUp();
      if (canScrub)
         seekButton->Enable();
      else
         seekButton->Disable();
   }
 
   const auto barButton = mButtons[STBRulerID];
   barButton->Enable();
   if (AdornedRulerPanel::Get( *p ).ShowingScrubRuler())
      barButton->PushDown();
   else
      barButton->PopUp();
   DoRegenerateTooltips( false );
   scrubber.CheckMenuItems();
}

References DoRegenerateTooltips(), AButton::Enable(), AdornedRulerPanel::Get(), Scrubber::Get(), mButtons, ToolBar::mProject, AdornedRulerPanel::ShowingScrubRuler(), STBRulerID, STBScrubID, and STBSeekID.

Referenced by OnButton(), and OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

ScrubbingToolBar & ScrubbingToolBar::Get ( AudacityProject & project )

static

Definition at line 71 of file ScrubbingToolBar.cpp.

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

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

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 77 of file ScrubbingToolBar.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ ID()

static Identifier ScrubbingToolBar::ID ( )

static

Referenced by Get().

Here is the caller graph for this function:

◆ MakeButtons()

void ScrubbingToolBar::MakeButtons ( )

private

◆ OnButton()

void ScrubbingToolBar::OnButton ( wxCommandEvent & event )

Definition at line 222 of file ScrubbingToolBar.cpp.

{
   AudacityProject *p = &mProject;
   if (!p) return;
   auto &scrubber = Scrubber::Get( *p );
 
   int id = event.GetId();
 
   switch (id) {
      case STBScrubID:
         scrubber.OnScrub(*p);
         break;
      case STBSeekID:
         scrubber.OnSeek(*p);
         break;
      case STBRulerID:
         scrubber.OnToggleScrubRuler(*p);
         break;
      default:
         wxASSERT(false);
   }
 
   EnableDisableButtons();
}

References EnableDisableButtons(), Scrubber::Get(), ToolBar::mProject, STBRulerID, STBScrubID, and STBSeekID.

Here is the call graph for this function:

◆ OnIdle()

void ScrubbingToolBar::OnIdle ( wxIdleEvent & evt )

private

Definition at line 291 of file ScrubbingToolBar.cpp.

{
   evt.Skip();
   EnableDisableButtons();
}

References EnableDisableButtons().

Here is the call graph for this function:

◆ Populate()

void ScrubbingToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 118 of file ScrubbingToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   MakeButtonBackgroundsSmall();
 
   /* Buttons */
   AddButton(this, bmpScrub, bmpScrub, bmpScrubDisabled, STBScrubID,
             XO("Scrub"), true);
   AddButton(this, bmpSeek, bmpSeek, bmpSeekDisabled, STBSeekID,
             XO("Seek"), true);
   AddButton(this, bmpToggleScrubRuler, bmpToggleScrubRuler, bmpToggleScrubRuler,
             STBRulerID,
             XO("Scrub Ruler"), true);
 
 
   RegenerateTooltips();
}

References AddButton(), ThemeBase::Colour(), ToolBar::MakeButtonBackgroundsSmall(), RegenerateTooltips(), STBRulerID, STBScrubID, STBSeekID, theTheme, and XO().

Here is the call graph for this function:

◆ RegenerateTooltips()

void ScrubbingToolBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 147 of file ScrubbingToolBar.cpp.

{
   DoRegenerateTooltips( true );
}

References DoRegenerateTooltips().

Referenced by Populate(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void ScrubbingToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 58 of file ScrubbingToolBar.h.

58{};

◆ ShownByDefault()

bool ScrubbingToolBar::ShownByDefault ( ) const

overridevirtual

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

Reimplemented from ToolBar.

Definition at line 66 of file ScrubbingToolBar.cpp.

{
   return false;
}

◆ UpdatePrefs()

void ScrubbingToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 136 of file ScrubbingToolBar.cpp.

{
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Scrubbing"));
 
   // 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

◆ downImage

wxImage* ScrubbingToolBar::downImage

private

Definition at line 76 of file ScrubbingToolBar.h.

◆ hiliteImage

wxImage* ScrubbingToolBar::hiliteImage

private

Definition at line 77 of file ScrubbingToolBar.h.

◆ mButtons

AButton* ScrubbingToolBar::mButtons[STBNumButtons]

private

Definition at line 73 of file ScrubbingToolBar.h.

Referenced by AddButton(), DoRegenerateTooltips(), and EnableDisableButtons().

◆ mLastRuler

bool ScrubbingToolBar::mLastRuler { false }

private

Definition at line 91 of file ScrubbingToolBar.h.

Referenced by DoRegenerateTooltips().

◆ mLastScrub

bool ScrubbingToolBar::mLastScrub { false }

private

Definition at line 89 of file ScrubbingToolBar.h.

Referenced by DoRegenerateTooltips().

◆ mLastSeek

bool ScrubbingToolBar::mLastSeek { false }

private

Definition at line 90 of file ScrubbingToolBar.h.

Referenced by DoRegenerateTooltips().

◆ upImage

wxImage* ScrubbingToolBar::upImage

private

Definition at line 75 of file ScrubbingToolBar.h.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScrubbingToolBar()

◆ ~ScrubbingToolBar()

Member Function Documentation

◆ AddButton()

◆ Create()

◆ DoRegenerateTooltips()

◆ EnableDisableButtons()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ID()

◆ MakeButtons()

◆ OnButton()

◆ OnIdle()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ ShownByDefault()

◆ UpdatePrefs()

Member Data Documentation

◆ downImage

◆ hiliteImage

◆ mButtons

◆ mLastRuler

◆ mLastScrub

◆ mLastSeek

◆ upImage