#include <ScrubbingToolBar.h>

Inheritance diagram for ScrubbingToolBar:

Public Member Functions
	ScrubbingToolBar ()

virtual	~ScrubbingToolBar ()

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 (int type, const wxString &label, const wxString &section, bool resizable=false)

virtual	~ToolBar ()

bool	AcceptsFocus () const override

virtual void	ReCreateButtons ()

int	GetType ()

wxString	GetTitle ()

wxString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const wxString &label) override

void	SetDocked (ToolDock *dock, bool pushed)

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

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

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

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	MakeButtons ()

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

Private Attributes
AButton *	mButtons [STBNumButtons]

wxImage *	upImage

wxImage *	downImage

wxImage *	hiliteImage

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

Definition at line 39 of file ScrubbingToolBar.h.

Constructor & Destructor Documentation

ScrubbingToolBar::ScrubbingToolBar ( )

ScrubbingToolBar::~ScrubbingToolBar ( )

virtual

Definition at line 67 of file ScrubbingToolBar.cpp.

68 {

69 }

Member Function Documentation

AButton * ScrubbingToolBar::AddButton	(	ScrubbingToolBar *	pBar,
		teBmps	eEnabledUp,
		teBmps	eEnabledDown,
		teBmps	eDisabled,
		int	id,
		const wxChar *	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 80 of file ScrubbingToolBar.cpp.

References ToolBar::Add(), ThemeBase::ImageSize(), ToolBar::MakeButton(), mButtons, and theTheme.

Referenced by Populate().

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

void ScrubbingToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 71 of file ScrubbingToolBar.cpp.

References ToolBar::Create().

 {
    ToolBar::Create(parent);
 }

void ScrubbingToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 210 of file ScrubbingToolBar.cpp.

References Scrubber::CanScrub(), AButton::Enable(), GetActiveProject(), AudacityProject::GetRulerPanel(), AudacityProject::GetScrubber(), mButtons, RegenerateTooltips(), AButton::SetEnabled(), AdornedRulerPanel::ShowingScrubRuler(), STBRulerID, STBScrubID, and STBSeekID.

Referenced by OnButton(), and Scrubber::OnScrubOrSeek().

 {
    const auto scrubButton = mButtons[STBScrubID];
    scrubButton->SetEnabled(true);
    const auto seekButton = mButtons[STBSeekID];
    seekButton->SetEnabled(true);
 
    AudacityProject *p = GetActiveProject();
    if (!p) return;
 
    auto &scrubber = p->GetScrubber();
    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 (p->GetRulerPanel()->ShowingScrubRuler())
       barButton->PushDown();
    else
       barButton->PopUp();
    RegenerateTooltips();
    scrubber.CheckMenuItems();
 }

void ScrubbingToolBar::MakeButtons ( )

private

void ScrubbingToolBar::OnButton ( wxCommandEvent & event )

Definition at line 185 of file ScrubbingToolBar.cpp.

References EnableDisableButtons(), GetActiveProject(), AudacityProject::GetScrubber(), STBRulerID, STBScrubID, and STBSeekID.

 {
    AudacityProject *p = GetActiveProject();
    if (!p) return;
    auto &scrubber = p->GetScrubber();
 
    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();
 }

void ScrubbingToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 106 of file ScrubbingToolBar.cpp.

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

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

void ScrubbingToolBar::RegenerateTooltips ( )

overridevirtual

Implements ToolBar.

Definition at line 135 of file ScrubbingToolBar.cpp.

References _(), GetActiveProject(), label, mButtons, ToolBar::SetButtonToolTip(), STBRulerID, STBScrubID, and STBSeekID.

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

 {
 #if wxUSE_TOOLTIPS
    auto fn = [&]
    (AButton &button, const wxString &label, const wxString &cmd)
    {
       TranslatedInternalString command{ cmd, label };
       ToolBar::SetButtonToolTip( button, &command, 1u );
    };
 
    auto project = GetActiveProject();
    if (project) {
       auto &scrubber = project->GetScrubber();
 
       const auto scrubButton = mButtons[STBScrubID];
       const auto seekButton = mButtons[STBSeekID];
 
       wxString label;
       label = (
                scrubber.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
                 */
                ? _("Stop Scrubbing")
                : _("Start Scrubbing")
                );
       fn(*scrubButton, label, wxT("Scrub"));
 
       label = (
                scrubber.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
                 */
                ? _("Stop Seeking")
                : _("Start Seeking")
                );
       fn(*seekButton, label, wxT("Seek"));
 
       label = (
                project->GetRulerPanel()->ShowingScrubRuler()
                ? _("Hide Scrub Ruler")
                : _("Show Scrub Ruler")
                );
       fn(*mButtons[STBRulerID], label, wxT("ToggleScrubRuler"));
    }
 #endif
 }

void ScrubbingToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 51 of file ScrubbingToolBar.h.

51 {};

void ScrubbingToolBar::UpdatePrefs ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 124 of file ScrubbingToolBar.cpp.

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

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

Member Data Documentation

wxImage* ScrubbingToolBar::downImage

private

Definition at line 69 of file ScrubbingToolBar.h.

wxImage* ScrubbingToolBar::hiliteImage

private

Definition at line 70 of file ScrubbingToolBar.h.

AButton* ScrubbingToolBar::mButtons[STBNumButtons]

private

Definition at line 66 of file ScrubbingToolBar.h.

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

wxImage* ScrubbingToolBar::upImage

private

Definition at line 68 of file ScrubbingToolBar.h.

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation