Implements some features which are specific to Wave Clips. More...

#include <WaveTrackAffordanceHandle.h>

Inheritance diagram for WaveTrackAffordanceHandle:

Collaboration diagram for WaveTrackAffordanceHandle:

Public Member Functions
	WaveTrackAffordanceHandle (const std::shared_ptr< Track > &track, const std::shared_ptr< ClipTimes > &target)

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

UIHandle::Result	SelectAt (const TrackPanelMouseEvent &event, AudacityProject *project) override

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

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

Public Member Functions inherited from AffordanceHandle
void	Enter (bool forward, AudacityProject *pProject) override

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

	AffordanceHandle (const std::shared_ptr< Track > &track)

Result	Click (const TrackPanelMouseEvent &evt, AudacityProject *pProject) override

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

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

Public Member Functions inherited from TimeShiftHandle
	TimeShiftHandle (std::shared_ptr< Track > pTrack, bool gripHit)

TimeShiftHandle &	operator= (TimeShiftHandle &&)=default

bool	IsGripHit () const

virtual	~TimeShiftHandle ()

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

void	Enter (bool forward, AudacityProject *) override

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

bool	StopsOnKeystroke () override

bool	Clicked () const

std::shared_ptr< Track >	GetTrack () 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 Attributes
std::shared_ptr< ClipTimes >	mTarget

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

using	Cell = TrackPanelCell

Static Public Member Functions inherited from TimeShiftHandle
static UIHandlePtr	HitAnywhere (std::weak_ptr< TimeShiftHandle > &holder, const std::shared_ptr< Track > &pTrack, bool gripHit)

static UIHandlePtr	HitTest (std::weak_ptr< TimeShiftHandle > &holder, const wxMouseState &state, const wxRect &rect, const std::shared_ptr< Track > &pTrack)

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)

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

Protected Member Functions inherited from TimeShiftHandle
bool	WasMoved () const

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Implements some features which are specific to Wave Clips.

Definition at line 18 of file WaveTrackAffordanceHandle.h.

Constructor & Destructor Documentation

◆ WaveTrackAffordanceHandle()

WaveTrackAffordanceHandle::WaveTrackAffordanceHandle	(	const std::shared_ptr< Track > &	track,
		const std::shared_ptr< ClipTimes > &	target
	)

Definition at line 24 of file WaveTrackAffordanceHandle.cpp.

25 : AffordanceHandle(track), mTarget(target)

26{ }

AffordanceHandle::AffordanceHandle

AffordanceHandle(const std::shared_ptr< Track > &track)

Definition: AffordanceHandle.cpp:58

WaveTrackAffordanceHandle::mTarget

std::shared_ptr< ClipTimes > mTarget

Definition: WaveTrackAffordanceHandle.h:20

Member Function Documentation

◆ Click()

UIHandle::Result WaveTrackAffordanceHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	project
	)

overridevirtual

Implements UIHandle.

Definition at line 28 of file WaveTrackAffordanceHandle.cpp.

{
   // We only care about left clicks here,
   // however we need to intercept Release events for right clicks later
   if (event.event.GetButton() != wxMOUSE_BTN_LEFT)
      return RefreshCode::RefreshNone;
 
   Result result = RefreshCode::RefreshNone;
 
   if (WaveChannelView::ClipDetailsVisible(*mTarget, ViewInfo::Get(*project), event.rect))
   {
      auto affordanceControl = std::dynamic_pointer_cast<WaveTrackAffordanceControls>(event.pCell);
 
      if (affordanceControl)
      {
         result |= affordanceControl->OnAffordanceClick(event, project);
         if (!event.event.GetSkipped())//event is "consumed"
            return result | RefreshCode::Cancelled;
         event.event.Skip(false);
      }
   }
   return result | AffordanceHandle::Click(event, project);
}

References RefreshCode::Cancelled, AffordanceHandle::Click(), WaveChannelView::ClipDetailsVisible(), TrackPanelMouseEvent::event, ViewInfo::Get(), mTarget, TrackPanelMouseEvent::pCell, project, TrackPanelMouseEvent::rect, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ HandlesRightClick()

bool WaveTrackAffordanceHandle::HandlesRightClick ( )

overridevirtual

Whether the handle has any special right-button handling.

If not, then Click() will not be called for right click. Default is always false

Reimplemented from UIHandle.

Definition at line 62 of file WaveTrackAffordanceHandle.cpp.

{
   return true;
}

◆ Release()

UIHandle::Result WaveTrackAffordanceHandle::Release	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

overridevirtual

Implements UIHandle.

Definition at line 67 of file WaveTrackAffordanceHandle.cpp.

{
    auto result = AffordanceHandle::Release(event, pProject, pParent);
    PitchAndSpeedDialog::Get(*pProject).TryRetarget(event);
 
    if (event.event.RightUp())
        result |= event.pCell->DoContextMenu(event.rect, pParent, nullptr, pProject);
 
    return result;
}

References TrackPanelMouseEvent::event, PitchAndSpeedDialog::Get(), TrackPanelMouseEvent::rect, AffordanceHandle::Release(), and PitchAndSpeedDialog::TryRetarget().

Here is the call graph for this function:

◆ SelectAt()

UIHandle::Result WaveTrackAffordanceHandle::SelectAt	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	project
	)

overridevirtual

Implements AffordanceHandle.

Definition at line 52 of file WaveTrackAffordanceHandle.cpp.

{
   auto& viewInfo = ViewInfo::Get(*project);
   viewInfo.selectedRegion.setTimes(mTarget->GetPlayStartTime(), mTarget->GetPlayEndTime());
 
   ProjectHistory::Get(*project).ModifyState(false);
 
   return RefreshCode::RefreshAll | RefreshCode::Cancelled;
}

References RefreshCode::Cancelled, ProjectHistory::Get(), ViewInfo::Get(), ProjectHistory::ModifyState(), mTarget, project, and RefreshCode::RefreshAll.

Here is the call graph for this function:

Member Data Documentation

◆ mTarget

std::shared_ptr<ClipTimes> WaveTrackAffordanceHandle::mTarget

private

Definition at line 20 of file WaveTrackAffordanceHandle.h.

Referenced by Click(), and SelectAt().

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaveTrackAffordanceHandle()

Member Function Documentation

◆ Click()

◆ HandlesRightClick()

◆ Release()

◆ SelectAt()

Member Data Documentation

◆ mTarget