#include <AffordanceHandle.h>

Inheritance diagram for AffordanceHandle:

Collaboration diagram for AffordanceHandle:

Public Member Functions
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)

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

Protected Member Functions inherited from TimeShiftHandle
bool	WasMoved () const

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

Static Private Member Functions
static HitTestPreview	HitPreview (const AudacityProject *, bool unsafe, bool moving)

Private Attributes
bool	mMoving { false }

wxPoint	mClickPosition { }

Static Private Attributes
static constexpr double	MoveThreshold { 5.0 }

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)

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Audacity: A Digital Audio Editor

AffordanceHandle.h

Vitaly Sverchinsky

Definition at line 15 of file AffordanceHandle.h.

Constructor & Destructor Documentation

◆ AffordanceHandle()

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

Definition at line 58 of file AffordanceHandle.cpp.

    : TimeShiftHandle(track, false)
{
}

Member Function Documentation

◆ Click()

UIHandle::Result AffordanceHandle::Click	(	const TrackPanelMouseEvent &	evt,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 63 of file AffordanceHandle.cpp.

{
    auto result = TimeShiftHandle::Click(evt, pProject);
    mClickPosition = evt.event.GetPosition();
    return result | RefreshCode::RefreshCell;
}

References TimeShiftHandle::Click(), TrackPanelMouseEvent::event, mClickPosition, and RefreshCode::RefreshCell.

Referenced by WaveTrackAffordanceHandle::Click().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Drag()

UIHandle::Result AffordanceHandle::Drag	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 70 of file AffordanceHandle.cpp.

{
    if(!mMoving)
    {
        if(std::abs(mClickPosition.x - event.event.m_x) >= MoveThreshold ||
           std::abs(mClickPosition.y - event.event.m_y) >= MoveThreshold)
        {
            mMoving = true;
        }
        else
            return RefreshCode::RefreshNone;
    }
    return TimeShiftHandle::Drag(event, pProject);
}

References TimeShiftHandle::Drag(), TrackPanelMouseEvent::event, mClickPosition, mMoving, MoveThreshold, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ Enter()

void AffordanceHandle::Enter	(	bool	forward,
		AudacityProject *	pProject
	)

overridevirtual

Reimplemented from UIHandle.

Definition at line 46 of file AffordanceHandle.cpp.

{
    SetChangeHighlight(RefreshCode::RefreshCell | RefreshCode::RefreshLatestCell);
    TimeShiftHandle::Enter(forward, pProject);
}

References TimeShiftHandle::Enter(), forward, RefreshCode::RefreshCell, RefreshCode::RefreshLatestCell, and UIHandle::SetChangeHighlight().

Here is the call graph for this function:

◆ HitPreview()

HitTestPreview AffordanceHandle::HitPreview	(	const AudacityProject *	,
		bool	unsafe,
		bool	moving
	)

staticprivate

Audacity: A Digital Audio Editor

AffordanceHandle.cpp

Vitaly Sverchinsky

Definition at line 25 of file AffordanceHandle.cpp.

{
    static wxCursor arrowCursor{ wxCURSOR_ARROW };
    static auto handOpenCursor =
        MakeCursor(wxCURSOR_HAND, RearrangeCursorXpm, 16, 16);
    static auto handClosedCursor =
        MakeCursor(wxCURSOR_HAND, RearrangingCursorXpm, 16, 16);
    // i18n-hint Appears on hovering mouse over clip affordance
    auto message = XO("Drag clips to reposition them."\
        " Hold Shift and drag to move all clips on the same track.");
 
    if (unsafe)
        return { message, &arrowCursor };
    return {
        message,
        (moving
        ? &*handClosedCursor
        : &*handOpenCursor)
    };
}

References handOpenCursor, MakeCursor(), and XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 52 of file AffordanceHandle.cpp.

{
    const bool unsafe = ProjectAudioIO::Get(*pProject).IsAudioActive();
    return HitPreview(pProject, unsafe, Clicked());
}

References TimeShiftHandle::Clicked(), ProjectAudioIO::Get(), HitPreview(), and ProjectAudioIO::IsAudioActive().

Here is the call graph for this function:

◆ Release()

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

overridevirtual

Implements UIHandle.

Definition at line 85 of file AffordanceHandle.cpp.

{
    auto result = TimeShiftHandle::Release(event, pProject, pParent);
    if (!WasMoved())
        result |= UpdateTrackSelection(event, pProject);
    return result;
}

References TimeShiftHandle::Release(), UpdateTrackSelection(), and TimeShiftHandle::WasMoved().

Referenced by WaveTrackAffordanceHandle::Release().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SelectAt()

virtual Result AffordanceHandle::SelectAt	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

protectedpure virtual

Implemented in NoteTrackAffordanceHandle, and WaveTrackAffordanceHandle.

Referenced by UpdateTrackSelection().

Here is the caller graph for this function:

◆ UpdateTrackSelection()

UIHandle::Result AffordanceHandle::UpdateTrackSelection	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

private

Definition at line 93 of file AffordanceHandle.cpp.

{
    auto& trackList = TrackList::Get(*pProject);
 
    if(const auto track = trackList.Lock<Track>(GetTrack()))
    {
        auto& selectionState = SelectionState::Get(*pProject);
        selectionState.SelectNone(trackList);
        selectionState.SelectTrack(*track, true, true);
 
        return SelectAt(event, pProject);
    }
 
    return RefreshCode::RefreshNone;
}

References SelectionState::Get(), TrackList::Get(), TimeShiftHandle::GetTrack(), RefreshCode::RefreshNone, and SelectAt().

Referenced by Release().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mClickPosition

wxPoint AffordanceHandle::mClickPosition { }

private

Definition at line 22 of file AffordanceHandle.h.

Referenced by Click(), and Drag().

◆ mMoving

bool AffordanceHandle::mMoving { false }

private

Definition at line 21 of file AffordanceHandle.h.

Referenced by Drag().

◆ MoveThreshold

constexpr double AffordanceHandle::MoveThreshold { 5.0 }

staticconstexprprivate

Definition at line 17 of file AffordanceHandle.h.

Referenced by Drag().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AffordanceHandle()

Member Function Documentation

◆ Click()

◆ Drag()

◆ Enter()

◆ HitPreview()

◆ Preview()

◆ Release()

◆ SelectAt()

◆ UpdateTrackSelection()

Member Data Documentation

◆ mClickPosition

◆ mMoving

◆ MoveThreshold