Inheritance diagram for AdornedRulerPanel::ScrubbingHandle:

Collaboration diagram for AdornedRulerPanel::ScrubbingHandle:

Public Member Functions
	ScrubbingHandle (AdornedRulerPanel *pParent, wxCoord xx)

Public Member Functions inherited from AdornedRulerPanel::CommonRulerHandle
	CommonRulerHandle (AdornedRulerPanel *pParent, wxCoord xx, MenuChoice menuChoice)

std::shared_ptr< const Track >	FindTrack () const override

bool	Clicked () const

Public Member Functions inherited from UIHandle
virtual	~UIHandle ()=0

virtual void	Enter (bool forward, AudacityProject *pProject)

virtual bool	HasRotation () const

virtual bool	Rotate (bool forward)

virtual bool	HasEscape (AudacityProject *pProject) const

virtual bool	Escape (AudacityProject *pProject)

virtual bool	HandlesRightClick ()
	Whether the handle has any special right-button handling. More...

virtual Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0

virtual Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0

virtual HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject)=0

virtual Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent)=0

virtual Result	Cancel (AudacityProject *pProject)=0

virtual bool	StopsOnKeystroke ()

virtual void	OnProjectChange (AudacityProject *pProject)

virtual std::shared_ptr< const Track >	FindTrack () const =0

virtual bool	IsDragging () const

Result	GetChangeHighlight () const

void	SetChangeHighlight (Result val)

Public Member Functions inherited from TrackPanelDrawable
virtual	~TrackPanelDrawable ()=0

virtual void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)

virtual wxRect	DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)

Private Member Functions
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) override

Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent) override

Result	Cancel (AudacityProject *pProject) override

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned

using	Cell = TrackPanelCell

Static Public Member Functions inherited from AdornedRulerPanel::CommonRulerHandle
static UIHandle::Result	NeedChangeHighlight (const CommonRulerHandle &oldState, const CommonRulerHandle &newState)

Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)

static std::shared_ptr< const Track >	TrackFromChannel (const std::shared_ptr< const Channel > &pChannel)
	A frequent convenience in the definition of UIHandles. More...

Static Public Member Functions inherited from TrackPanelDrawable
static wxRect	MaximizeWidth (const wxRect &rect, const wxRect &panelRect)

static wxRect	MaximizeHeight (const wxRect &rect, const wxRect &panelRect)

Protected Types inherited from AdornedRulerPanel::CommonRulerHandle
enum class	Button { None , Left , Right }

Protected Member Functions inherited from AdornedRulerPanel::CommonRulerHandle
bool	HandlesRightClick () override
	Whether the handle has any special right-button handling. More...

Result	Click (const TrackPanelMouseEvent &event, AudacityProject *) override

Result	Drag (const TrackPanelMouseEvent &, AudacityProject *) override

Result	Release (const TrackPanelMouseEvent &event, AudacityProject , wxWindow ) override

double	Time (AudacityProject &project) const

void	StartPlay (AudacityProject &project, const wxMouseEvent &event)

Result	Cancel (AudacityProject *) override

void	Enter (bool, AudacityProject *) override

Protected Attributes inherited from AdornedRulerPanel::CommonRulerHandle
wxWeakRef< AdornedRulerPanel >	mParent

wxCoord	mX

wxCoord	mClickedX

MenuChoice	mChoice

Button	mClicked { Button::None }

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 1125 of file AdornedRulerPanel.cpp.

Constructor & Destructor Documentation

◆ ScrubbingHandle()

AdornedRulerPanel::ScrubbingHandle::ScrubbingHandle	(	AdornedRulerPanel *	pParent,
		wxCoord	xx
	)

inlineexplicit

Definition at line 1129 of file AdornedRulerPanel.cpp.

   : CommonRulerHandle( pParent, xx, MenuChoice::Scrub )
   {
   }

Member Function Documentation

◆ Cancel()

Result AdornedRulerPanel::ScrubbingHandle::Cancel ( AudacityProject * pProject )

inlineoverrideprivatevirtual

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 1187 of file AdornedRulerPanel.cpp.

   {
      auto result = CommonRulerHandle::Cancel(pProject);
 
      if (mClicked == Button::Left) {
         auto &scrubber = Scrubber::Get( *pProject );
         scrubber.Cancel();
 
         ProjectAudioManager::Get( *pProject ).Stop();
      }
 
      return result;
   }

References AdornedRulerPanel::CommonRulerHandle::Cancel(), ProjectAudioManager::Get(), Scrubber::Get(), AdornedRulerPanel::CommonRulerHandle::Left, AdornedRulerPanel::CommonRulerHandle::mClicked, and ProjectAudioManager::Stop().

Here is the call graph for this function:

◆ Click()

Result AdornedRulerPanel::ScrubbingHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

inlineoverrideprivatevirtual

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 1135 of file AdornedRulerPanel.cpp.

   {
      auto result = CommonRulerHandle::Click(event, pProject);
      if (!( result & RefreshCode::Cancelled )) {
         if (mClicked == Button::Left) {
            auto &scrubber = Scrubber::Get( *pProject );
            // only if scrubbing is allowed now
            bool canScrub =
               scrubber.CanScrub() &&
               mParent &&
               mParent->ShowingScrubRuler();
 
            if (!canScrub)
               return RefreshCode::Cancelled;
            if (!scrubber.HasMark()) {
               // Asynchronous scrub poller gets activated here
               scrubber.MarkScrubStart(
                  event.event.m_x, Scrubber::ShouldScrubPinned(), false);
            }
         }
      }
      return result;
   }

References RefreshCode::Cancelled, AdornedRulerPanel::CommonRulerHandle::Click(), TrackPanelMouseEvent::event, Scrubber::Get(), AdornedRulerPanel::CommonRulerHandle::Left, AdornedRulerPanel::CommonRulerHandle::mClicked, AdornedRulerPanel::CommonRulerHandle::mParent, and Scrubber::ShouldScrubPinned().

Here is the call graph for this function:

◆ Drag()

Result AdornedRulerPanel::ScrubbingHandle::Drag	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

inlineoverrideprivatevirtual

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 1160 of file AdornedRulerPanel.cpp.

   {
      auto result = CommonRulerHandle::Drag(event, pProject);
      if (!( result & RefreshCode::Cancelled )) {
         // Nothing needed here.  The scrubber works by polling mouse state
         // after the start has been marked.
      }
      return result;
   }

References RefreshCode::Cancelled, and AdornedRulerPanel::CommonRulerHandle::Drag().

Here is the call graph for this function:

◆ Preview()

auto AdornedRulerPanel::ScrubbingHandle::Preview	(	const TrackPanelMouseState &	state,
		AudacityProject *	pProject
	)

overrideprivatevirtual

Implements UIHandle.

Definition at line 1891 of file AdornedRulerPanel.cpp.

{
   auto &scrubber = Scrubber::Get( *pProject );
   auto message = ScrubbingMessage(scrubber, mClicked == Button::Left);
 
   mParent->SetNumGuides(1);
   return {
      message,
      {},
      // Tooltip is same as status message, or blank
      mParent ? message : TranslatableString{},
   };
}

References Scrubber::Get(), and anonymous_namespace{AdornedRulerPanel.cpp}::ScrubbingMessage().

Here is the call graph for this function:

◆ Release()

Result AdornedRulerPanel::ScrubbingHandle::Release	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

inlineoverrideprivatevirtual

Reimplemented from AdornedRulerPanel::CommonRulerHandle.

Definition at line 1175 of file AdornedRulerPanel.cpp.

                                  {
      auto result = CommonRulerHandle::Release(event, pProject, pParent);
      if (!( result & RefreshCode::Cancelled )) {
         // Nothing needed here either.  The scrub poller may have decided to
         // seek because a drag happened before button up, or it may decide
         // to start a scrub, as it watches mouse movement after the button up.
      }
      return result;
   }

References RefreshCode::Cancelled, and AdornedRulerPanel::CommonRulerHandle::Release().

Here is the call graph for this function:

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

AdornedRulerPanel.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScrubbingHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ Preview()

◆ Release()