A UIHandle for a TrackPanel button, such as the Mute and Solo buttons. More...

#include <ButtonHandle.h>

Inheritance diagram for ButtonHandle:

Collaboration diagram for ButtonHandle:

Public Member Functions
std::shared_ptr< Track >	GetTrack () const

bool	IsDragging () const override

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
	ButtonHandle (const std::shared_ptr< Track > &pTrack, const wxRect &rect)

ButtonHandle &	operator= (const ButtonHandle &)=default

virtual	~ButtonHandle ()

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

virtual Result	CommitChanges (const wxMouseEvent &event, AudacityProject pProject, wxWindow pParent)=0

virtual TranslatableString	Tip (const wxMouseState &state, AudacityProject &project) const =0

void	Enter (bool forward, AudacityProject *) final override

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

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

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

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

Result	Cancel (AudacityProject *pProject) final override

Protected Attributes
std::weak_ptr< Track >	mpTrack

wxRect	mRect

bool	mWasIn { true }

bool	mIsDragging {}

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Private Member Functions
	ButtonHandle (const ButtonHandle &)=delete

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

A UIHandle for a TrackPanel button, such as the Mute and Solo buttons.

Definition at line 25 of file ButtonHandle.h.

Constructor & Destructor Documentation

◆ ButtonHandle() [1/2]

ButtonHandle::ButtonHandle ( const ButtonHandle & )

privatedelete

◆ ButtonHandle() [2/2]

ButtonHandle::ButtonHandle	(	const std::shared_ptr< Track > &	pTrack,
		const wxRect &	rect
	)

explicitprotected

Definition at line 21 of file ButtonHandle.cpp.

   : mpTrack{ pTrack }
   , mRect{ rect }
{
}

◆ ~ButtonHandle()

ButtonHandle::~ButtonHandle ( )

protectedvirtual

Definition at line 28 of file ButtonHandle.cpp.

29{

30}

Member Function Documentation

◆ Cancel()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 111 of file ButtonHandle.cpp.

{
   using namespace RefreshCode;
   return RefreshCell; // perhaps unnecessarily if pointer is out of the box
}

References RefreshCode::RefreshCell.

◆ Click()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 47 of file ButtonHandle.cpp.

{
   using namespace RefreshCode;
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   if ( !pTrack )
      return Cancelled;
 
   const wxMouseEvent &event = evt.event;
   if (!event.Button(wxMOUSE_BTN_LEFT))
      return Cancelled;
 
   // Come here for left click or double click
   if (mRect.Contains(event.m_x, event.m_y)) {
      mWasIn = true;
      mIsDragging = true;
      // Toggle visible button state
      return RefreshCell;
   }
   else
      return Cancelled;
}

References Cancelled, TrackPanelMouseEvent::event, TrackList::Get(), TrackList::Lock(), mIsDragging, mpTrack, mRect, mWasIn, and RefreshCode::RefreshCell.

Here is the call graph for this function:

◆ CommitChanges()

virtual Result ButtonHandle::CommitChanges	(	const wxMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

protectedpure virtual

Implemented in MuteButtonHandle, SoloButtonHandle, EffectsButtonHandle, SubViewCloseHandle, MinimizeButtonHandle, CloseButtonHandle, and MenuButtonHandle.

Referenced by Release().

Here is the caller graph for this function:

◆ Drag()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 70 of file ButtonHandle.cpp.

{
   const wxMouseEvent &event = evt.event;
   using namespace RefreshCode;
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   if (!pTrack)
      return Cancelled;
 
   auto isIn = mRect.Contains(event.m_x, event.m_y);
   auto result = (isIn == mWasIn) ? RefreshNone : RefreshCell;
   mWasIn = isIn;
   return result;
}

References Cancelled, TrackPanelMouseEvent::event, TrackList::Get(), TrackList::Lock(), mpTrack, mRect, mWasIn, RefreshCode::RefreshCell, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ Enter()

void ButtonHandle::Enter	(	bool	forward,
		AudacityProject *
	)

finaloverrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 42 of file ButtonHandle.cpp.

{
   mChangeHighlight = RefreshCode::RefreshCell;
}

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

◆ FindTrack()

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

overrideprotectedvirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 32 of file ButtonHandle.cpp.

{
   return mpTrack.lock();
}

References mpTrack.

Referenced by MenuButtonHandle::CommitChanges(), CloseButtonHandle::HitTest(), MenuButtonHandle::HitTest(), and MinimizeButtonHandle::HitTest().

Here is the caller graph for this function:

◆ GetTrack()

std::shared_ptr< Track > ButtonHandle::GetTrack ( ) const

inline

Definition at line 30 of file ButtonHandle.h.

30{ return mpTrack.lock(); }

Referenced by anonymous_namespace{PlayableTrackControls.cpp}::EffectsDrawFunction(), anonymous_namespace{PlayableTrackControls.cpp}::MuteAndSoloDrawFunction(), MuteButtonHandle::Tip(), SoloButtonHandle::Tip(), EffectsButtonHandle::Tip(), MinimizeButtonHandle::Tip(), MenuButtonHandle::Tip(), CloseButtonHandle::Tip(), anonymous_namespace{PlayableTrackControls.cpp}::WideMuteDrawFunction(), and anonymous_namespace{PlayableTrackControls.cpp}::WideSoloDrawFunction().

Here is the caller graph for this function:

◆ IsDragging()

bool ButtonHandle::IsDragging ( ) const

overridevirtual

Whether the handle is dragging, affecting other panel painting; default returns false

Reimplemented from UIHandle.

Definition at line 37 of file ButtonHandle.cpp.

{
   return mIsDragging;
}

References mIsDragging.

◆ operator=()

ButtonHandle & ButtonHandle::operator= ( const ButtonHandle & )

protecteddefault

◆ Preview()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 85 of file ButtonHandle.cpp.

{
   // No special cursor
   TranslatableString message;
   if (project)
      message = Tip(st.state, *project);
   return { message, {}, message };
}

References project, TrackPanelMouseState::state, and Tip().

Here is the call graph for this function:

◆ Release()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 95 of file ButtonHandle.cpp.

{
   using namespace RefreshCode;
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   if (!pTrack)
      return Cancelled;
 
   Result result = RefreshNone;
   const wxMouseEvent &event = evt.event;
   if (pTrack && mRect.Contains(event.m_x, event.m_y))
      result |= RefreshCell | CommitChanges(event, pProject, pParent);
   return result;
}

References Cancelled, CommitChanges(), TrackPanelMouseEvent::event, TrackList::Get(), TrackList::Lock(), mpTrack, mRect, RefreshCode::RefreshCell, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ Tip()

virtual TranslatableString ButtonHandle::Tip	(	const wxMouseState &	state,
		AudacityProject &	project
	)		const

protectedpure virtual

Implemented in MuteButtonHandle, SoloButtonHandle, EffectsButtonHandle, MinimizeButtonHandle, MenuButtonHandle, SubViewCloseHandle, and CloseButtonHandle.

Referenced by Preview().

Here is the caller graph for this function:

Member Data Documentation

◆ mIsDragging

bool ButtonHandle::mIsDragging {}

protected

Definition at line 77 of file ButtonHandle.h.

Referenced by Click(), and IsDragging().

◆ mpTrack

std::weak_ptr<Track> ButtonHandle::mpTrack

protected

Definition at line 74 of file ButtonHandle.h.

Referenced by Click(), MuteButtonHandle::CommitChanges(), SoloButtonHandle::CommitChanges(), EffectsButtonHandle::CommitChanges(), MinimizeButtonHandle::CommitChanges(), CloseButtonHandle::CommitChanges(), Drag(), FindTrack(), and Release().

◆ mRect

wxRect ButtonHandle::mRect

protected

Definition at line 75 of file ButtonHandle.h.

Referenced by Click(), Drag(), and Release().

◆ mWasIn

bool ButtonHandle::mWasIn { true }

protected

Definition at line 76 of file ButtonHandle.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

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ButtonHandle() [1/2]

◆ ButtonHandle() [2/2]

◆ ~ButtonHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ CommitChanges()

◆ Drag()

◆ Enter()

◆ FindTrack()

◆ GetTrack()

◆ IsDragging()

◆ operator=()

◆ Preview()

◆ Release()

◆ Tip()

Member Data Documentation

◆ mIsDragging

◆ mpTrack

◆ mRect

◆ mWasIn