#include <HighlitClipButtonHandle.h>

Inheritance diagram for HighlitClipButtonHandle:

Collaboration diagram for HighlitClipButtonHandle:

Public Member Functions
	HighlitClipButtonHandle (ClipButtonId id, std::shared_ptr< WaveTrack > track, std::shared_ptr< WaveTrack::Interval > clip)

void	Enter (bool forward, AudacityProject *pProject) override

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

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

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

Result	Cancel (AudacityProject *pProject) override

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

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

virtual void	DoDraw (const wxRect &args, wxDC &dc)=0

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	DoRelease (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent)=0

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

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

Protected Attributes
ClipButtonId	mButtonId

std::shared_ptr< WaveTrack >	mTrack

std::shared_ptr< WaveTrack::Interval >	mClip

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Static Private Member Functions
static void	Highlight (const wxRect &rect, wxDC &dc)

Private Attributes
std::weak_ptr< TrackPanelCell >	mwCell

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

using	Cell = TrackPanelCell

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)

Detailed Description

Definition at line 29 of file HighlitClipButtonHandle.h.

Constructor & Destructor Documentation

◆ HighlitClipButtonHandle()

HighlitClipButtonHandle::HighlitClipButtonHandle	(	ClipButtonId	id,
		std::shared_ptr< WaveTrack >	track,
		std::shared_ptr< WaveTrack::Interval >	clip
	)

Audacity: A Digital Audio Editor

HighlitClipButtonHandle.cpp

Matthieu Hodgkinson

Definition at line 30 of file HighlitClipButtonHandle.cpp.

    : mButtonId { id }
    , mTrack { std::move(track) }
    , mClip { std::move(clip) }
{
}

Member Function Documentation

◆ Cancel()

UIHandle::Result HighlitClipButtonHandle::Cancel ( AudacityProject * pProject )

overridevirtual

Implements UIHandle.

Definition at line 92 of file HighlitClipButtonHandle.cpp.

{
   return 0;
}

◆ Click()

UIHandle::Result HighlitClipButtonHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overridevirtual

Implements UIHandle.

Definition at line 55 of file HighlitClipButtonHandle.cpp.

{
   mwCell = event.pCell;
   return 0;
}

References mwCell.

◆ DoDraw()

virtual void HighlitClipButtonHandle::DoDraw	(	const wxRect &	args,
		wxDC &	dc
	)

pure virtual

Implemented in ClipOverflowButtonHandle, and ClipPitchAndSpeedButtonHandle.

Referenced by Draw().

Here is the caller graph for this function:

◆ DoRelease()

virtual Result HighlitClipButtonHandle::DoRelease	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

protectedpure virtual

Implemented in ClipOverflowButtonHandle, and ClipPitchAndSpeedButtonHandle.

Referenced by Release().

Here is the caller graph for this function:

◆ Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 62 of file HighlitClipButtonHandle.cpp.

{
   const auto cancelCode = RefreshCode::RefreshCell | RefreshCode::Cancelled;
   if (event.pCell != mwCell.lock())
      return cancelCode;
 
   // It's the right cell; check that the mouse is still over the button.
   const auto buttonRect = LowlitClipButton::Detail::GetButtonRectangle(
      mButtonId, { *mClip, ViewInfo::Get(*pProject), event.rect });
   if (!buttonRect.has_value())
      return cancelCode;
 
   const auto mousePos = event.event.GetPosition();
   if (!buttonRect->Contains(mousePos))
      return cancelCode;
 
   return 0;
}

References RefreshCode::Cancelled, ViewInfo::Get(), LowlitClipButton::Detail::GetButtonRectangle(), mButtonId, mClip, mwCell, TrackPanelMouseEvent::pCell, and RefreshCode::RefreshCell.

Here is the call graph for this function:

◆ Draw()

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

overridevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 39 of file HighlitClipButtonHandle.cpp.

{
   if (iPass != TrackArtist::PassSnapping)
      return;
   const auto artist = TrackArtist::Get(context);
   const auto& zoomInfo = *artist->pZoomInfo;
   const auto rect = LowlitClipButton::Detail::GetButtonInnerRectangle(
      mButtonId, { *mClip, zoomInfo, affordanceRect });
   if (!rect)
      return;
   Highlight(*rect, context.dc);
   DoDraw(*rect, context.dc);
}

References TrackPanelDrawingContext::dc, DoDraw(), TrackArtist::Get(), LowlitClipButton::Detail::GetButtonInnerRectangle(), Highlight(), mButtonId, mClip, and TrackArtist::PassSnapping.

Here is the call graph for this function:

◆ Enter()

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

overridevirtual

Reimplemented from UIHandle.

Definition at line 125 of file HighlitClipButtonHandle.cpp.

{
   mChangeHighlight = RefreshCode::RefreshCell;
}

References UIHandle::mChangeHighlight, and RefreshCode::RefreshCell.

◆ FindTrack()

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

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 120 of file HighlitClipButtonHandle.cpp.

{
   return mTrack;
}

References mTrack.

◆ Highlight()

void HighlitClipButtonHandle::Highlight	(	const wxRect &	rect,
		wxDC &	dc
	)

staticprivate

Definition at line 130 of file HighlitClipButtonHandle.cpp.

{
   constexpr auto penWidth = 0;
   const auto col = theTheme.Colour(clrClipAffordanceButton);
   wxDCBrushChanger brush { dc, col };
   wxDCPenChanger pen { dc, { wxPenInfo { col, penWidth } } };
   constexpr auto radius = 3;
   dc.DrawRoundedRectangle(rect, radius);
}

References ThemeBase::Colour(), and theTheme.

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Release()

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

overridevirtual

Implements UIHandle.

Definition at line 82 of file HighlitClipButtonHandle.cpp.

{
   mChangeHighlight = RefreshCode::RefreshNone;
   // Select before calling `DoRelease`.
   const auto result = UpdateTrackSelection(event, pProject);
   return result | DoRelease(event, pProject, pParent);
}

References DoRelease(), UIHandle::mChangeHighlight, RefreshCode::RefreshNone, and UpdateTrackSelection().

Here is the call graph for this function:

◆ SelectAt()

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

protected

◆ UpdateTrackSelection()

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

protected

Definition at line 97 of file HighlitClipButtonHandle.cpp.

{
   auto& trackList = TrackList::Get(*pProject);
 
   if (const auto track = trackList.Lock<Track>(mTrack))
   {
      auto& selectionState = SelectionState::Get(*pProject);
      selectionState.SelectNone(trackList);
      selectionState.SelectTrack(*track, true, true);
 
      auto& viewInfo = ViewInfo::Get(*pProject);
      viewInfo.selectedRegion.setTimes(
         mClip->GetPlayStartTime(), mClip->GetPlayEndTime());
 
      ProjectHistory::Get(*pProject).ModifyState(false);
 
      return RefreshCode::RefreshAll | RefreshCode::Cancelled;
   }
 
   return RefreshCode::RefreshNone;
}

References RefreshCode::Cancelled, ProjectHistory::Get(), ViewInfo::Get(), SelectionState::Get(), TrackList::Get(), mClip, ProjectHistory::ModifyState(), mTrack, RefreshCode::RefreshAll, and RefreshCode::RefreshNone.

Referenced by Release().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mButtonId

ClipButtonId HighlitClipButtonHandle::mButtonId

protected

Definition at line 69 of file HighlitClipButtonHandle.h.

Referenced by Drag(), and Draw().

◆ mClip

std::shared_ptr<WaveTrack::Interval> HighlitClipButtonHandle::mClip

protected

Definition at line 71 of file HighlitClipButtonHandle.h.

Referenced by ClipOverflowButtonHandle::DoDraw(), ClipPitchAndSpeedButtonHandle::DoDraw(), ClipOverflowButtonHandle::DoRelease(), ClipPitchAndSpeedButtonHandle::DoRelease(), Drag(), Draw(), and UpdateTrackSelection().

◆ mTrack

std::shared_ptr<WaveTrack> HighlitClipButtonHandle::mTrack

protected

Definition at line 70 of file HighlitClipButtonHandle.h.

Referenced by ClipPitchAndSpeedButtonHandle::DoRelease(), FindTrack(), and UpdateTrackSelection().

◆ mwCell

std::weak_ptr<TrackPanelCell> HighlitClipButtonHandle::mwCell

private

Definition at line 75 of file HighlitClipButtonHandle.h.

Referenced by Click(), and Drag().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HighlitClipButtonHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ DoDraw()

◆ DoRelease()

◆ Drag()

◆ Draw()

◆ Enter()

◆ FindTrack()

◆ Highlight()

◆ Release()

◆ SelectAt()

◆ UpdateTrackSelection()

Member Data Documentation

◆ mButtonId

◆ mClip

◆ mTrack

◆ mwCell