#include <PlayableTrackButtonHandles.h>

Inheritance diagram for SoloButtonHandle:

Collaboration diagram for SoloButtonHandle:

Public Member Functions
	SoloButtonHandle (const std::shared_ptr< Track > &pTrack, const wxRect &rect)

SoloButtonHandle &	operator= (const SoloButtonHandle &)=default

virtual	~SoloButtonHandle ()

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

bool	IsClicked () 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)

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)

Static Public Member Functions
static UIHandlePtr	HitTest (std::weak_ptr< SoloButtonHandle > &holder, const wxMouseState &state, const wxRect &rect, const AudacityProject *pProject, const std::shared_ptr< Track > &pTrack)

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

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 Member Functions
Result	CommitChanges (const wxMouseEvent &event, AudacityProject pProject, wxWindow pParent) override

TranslatableString	Tip (const wxMouseState &state, AudacityProject &) const override

bool	StopsOnKeystroke () override

Protected Member Functions inherited from ButtonHandle
	ButtonHandle (const std::shared_ptr< Track > &pTrack, const wxRect &rect)

ButtonHandle &	operator= (const ButtonHandle &)=default

virtual	~ButtonHandle ()

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

Private Member Functions
	SoloButtonHandle (const SoloButtonHandle &)=delete

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

using	Cell = TrackPanelCell

Protected Attributes inherited from ButtonHandle
std::weak_ptr< Track >	mpTrack

wxRect	mRect

bool	mWasIn { true }

bool	mIsClicked {}

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 48 of file PlayableTrackButtonHandles.h.

Constructor & Destructor Documentation

◆ SoloButtonHandle() [1/2]

SoloButtonHandle::SoloButtonHandle ( const SoloButtonHandle & )

privatedelete

◆ SoloButtonHandle() [2/2]

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

explicit

Definition at line 84 of file PlayableTrackButtonHandles.cpp.

86 : ButtonHandle{ pTrack, rect }

87{}

ButtonHandle

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

Definition: ButtonHandle.h:26

◆ ~SoloButtonHandle()

SoloButtonHandle::~SoloButtonHandle ( )

virtual

Definition at line 89 of file PlayableTrackButtonHandles.cpp.

90{

91}

Member Function Documentation

◆ CommitChanges()

UIHandle::Result SoloButtonHandle::CommitChanges	(	const wxMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 93 of file PlayableTrackButtonHandles.cpp.

{
   auto pTrack = mpTrack.lock();
   if ( dynamic_cast< PlayableTrack* >( pTrack.get() ) )
      TrackUtilities::DoTrackSolo(*pProject, pTrack.get(), event.ShiftDown());
 
   return RefreshCode::RefreshNone;
}

References TrackUtilities::DoTrackSolo(), ButtonHandle::mpTrack, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ HitTest()

UIHandlePtr SoloButtonHandle::HitTest	(	std::weak_ptr< SoloButtonHandle > &	holder,
		const wxMouseState &	state,
		const wxRect &	rect,
		const AudacityProject *	pProject,
		const std::shared_ptr< Track > &	pTrack
	)

static

Definition at line 117 of file PlayableTrackButtonHandles.cpp.

{
   wxRect buttonRect;
   if ( pTrack )
      PlayableTrackControls::GetMuteSoloRect(rect, buttonRect, true,
         !ProjectSettings::Get( *pProject ).IsSoloNone(), pTrack.get());
 
   if ( TrackInfo::HideTopItem( rect, buttonRect ) )
      return {};
 
   if ( pTrack && buttonRect.Contains(state.m_x, state.m_y) ) {
      auto result = std::make_shared<SoloButtonHandle>( pTrack, buttonRect );
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
   else
      return {};
}

References AssignUIHandlePtr(), ProjectSettings::Get(), PlayableTrackControls::GetMuteSoloRect(), TrackInfo::HideTopItem(), and ProjectSettings::IsSoloNone().

Referenced by NoteTrackControls::HitTest(), and WaveTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

SoloButtonHandle & SoloButtonHandle::operator= ( const SoloButtonHandle & )

default

◆ StopsOnKeystroke()

bool SoloButtonHandle::StopsOnKeystroke ( )

inlineoverrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 68 of file PlayableTrackButtonHandles.h.

68{ return true; }

◆ Tip()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 103 of file PlayableTrackButtonHandles.cpp.

{
   auto name = XO("Solo");
   auto focused =
      TrackFocus::Get( project ).Get() == GetTrack().get();
   if (!focused)
      return name;
 
   auto &commandManager = CommandManager::Get( project );
   ComponentInterfaceSymbol command{ wxT("TrackSolo"), name };
   return commandManager.DescribeCommandsAndShortcuts( &command, 1u );
}

References TrackFocus::Get(), CommandManager::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), ButtonHandle::GetTrack(), name, wxT(), and XO().

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoloButtonHandle() [1/2]

◆ SoloButtonHandle() [2/2]

◆ ~SoloButtonHandle()

Member Function Documentation

◆ CommitChanges()

◆ HitTest()

◆ operator=()

◆ StopsOnKeystroke()

◆ Tip()