SelectButtonHandle Class Reference

#include <TrackButtonHandles.h>

Inheritance diagram for SelectButtonHandle:

Collaboration diagram for SelectButtonHandle:

Public Member Functions
	SelectButtonHandle (const std::shared_ptr< Track > &pTrack, const wxRect &rect)
SelectButtonHandle &	operator= (const SelectButtonHandle &)=default
virtual	~SelectButtonHandle ()
Public Member Functions inherited from ButtonHandle
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)

Static Public Member Functions
static UIHandlePtr	HitTest (std::weak_ptr< SelectButtonHandle > &holder, const wxMouseState &state, const wxRect &rect, TrackPanelCell *pCell)
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 Member Functions
Result	CommitChanges (const wxMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
TranslatableString	Tip (const wxMouseState &state, AudacityProject &) const override
Protected Member Functions inherited from ButtonHandle
	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

Private Member Functions
	SelectButtonHandle (const SelectButtonHandle &)=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	mIsDragging {}
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 44 of file TrackButtonHandles.h.

Constructor & Destructor Documentation

SelectButtonHandle() [1/2]

SelectButtonHandle::SelectButtonHandle ( const SelectButtonHandle &  )

privatedelete

SelectButtonHandle() [2/2]

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

explicit

Definition at line 85 of file TrackButtonHandles.cpp.

   : ButtonHandle{ pTrack, rect }
{}

~SelectButtonHandle()

SelectButtonHandle::~SelectButtonHandle ( )

virtual

Definition at line 90 of file TrackButtonHandles.cpp.

{
}

Member Function Documentation

CommitChanges()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 94 of file TrackButtonHandles.cpp.

{
   using namespace RefreshCode;
 
   auto pTrack = mpTrack.lock();
   if (pTrack)
   {
      const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
      SelectUtilities::DoListSelection(*pProject,
         *pTrack, event.ShiftDown(), event.ControlDown(), !unsafe);
//    return RefreshAll ;
   }
 
   return RefreshNone;
}

References SelectUtilities::DoListSelection(), ProjectAudioIO::Get(), ProjectAudioIO::IsAudioActive(), ButtonHandle::mpTrack, and RefreshCode::RefreshNone.

Here is the call graph for this function:

HitTest()

UIHandlePtr SelectButtonHandle::HitTest ( std::weak_ptr< SelectButtonHandle > &  holder, const wxMouseState &  state, const wxRect &  rect, TrackPanelCell *  pCell  )

static

Definition at line 122 of file TrackButtonHandles.cpp.

{
   wxRect buttonRect;
   CommonTrackInfo::GetSelectButtonRect(rect, buttonRect);
 
   if (buttonRect.Contains(state.m_x, state.m_y)) {
      auto pTrack = static_cast<CommonTrackPanelCell*>(pCell)->FindTrack();
      auto result = std::make_shared<SelectButtonHandle>( pTrack, buttonRect );
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
   else
      return {};
}

References AssignUIHandlePtr(), ButtonHandle::FindTrack(), and CommonTrackInfo::GetSelectButtonRect().

Referenced by CommonTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

SelectButtonHandle & SelectButtonHandle::operator= ( const SelectButtonHandle &  )

default

Tip()

TranslatableString SelectButtonHandle::Tip ( const wxMouseState &  state, AudacityProject &    ) const

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 111 of file TrackButtonHandles.cpp.

{
   auto pTrack = GetTrack();
#if defined(__WXMAC__)
   return pTrack->GetSelected() ? XO("Command+Click to deselect") : XO("Select track");
#else
   return pTrack->GetSelected() ? XO("Ctrl+Click to deselect") : XO("Select track");
#endif
}

References ButtonHandle::GetTrack(), and XO().

Here is the call graph for this function:

---

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

• TrackButtonHandles.h
• TrackButtonHandles.cpp