CloseButtonHandle Class Reference

#include <TrackButtonHandles.h>

Inheritance diagram for CloseButtonHandle:

Collaboration diagram for CloseButtonHandle:

Public Member Functions
	CloseButtonHandle (const std::shared_ptr< Track > &pTrack, const wxRect &rect)
CloseButtonHandle &	operator= (const CloseButtonHandle &)=default
virtual	~CloseButtonHandle ()
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< CloseButtonHandle > &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 &project) 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 ()
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
	CloseButtonHandle (const CloseButtonHandle &)=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 45 of file TrackButtonHandles.h.

Constructor & Destructor Documentation

CloseButtonHandle() [1/2]

CloseButtonHandle::CloseButtonHandle ( const CloseButtonHandle &  )

privatedelete

CloseButtonHandle() [2/2]

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

explicit

Definition at line 86 of file TrackButtonHandles.cpp.

   : ButtonHandle{ pTrack, rect }
{}

~CloseButtonHandle()

CloseButtonHandle::~CloseButtonHandle ( )

virtual

Definition at line 91 of file TrackButtonHandles.cpp.

{
}

Member Function Documentation

CommitChanges()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 95 of file TrackButtonHandles.cpp.

{
   using namespace RefreshCode;
   Result result = RefreshNone;
 
   auto pTrack = mpTrack.lock();
   if (pTrack) {
      auto &toRemove = PendingTracks::Get(*pProject)
         .SubstitutePendingChangedTrack(*pTrack);
      ProjectAudioManager::Get( *pProject ).StopIfPaused();
      if (!ProjectAudioIO::Get( *pProject ).IsAudioActive()) {
         // This pushes an undo item:
         TrackUtilities::DoRemoveTrack(*pProject, toRemove);
         // Redraw all tracks when any one of them closes
         // (Could we invent a return code that draws only those at or below
         // the affected track?)
         result |= Resize | RefreshAll | FixScrollbars | DestroyedCell;
      }
   }
 
   return result;
}

References RefreshCode::DestroyedCell, TrackUtilities::DoRemoveTrack(), RefreshCode::FixScrollbars, ProjectAudioIO::Get(), PendingTracks::Get(), ProjectAudioManager::Get(), ProjectAudioIO::IsAudioActive(), ButtonHandle::mpTrack, RefreshCode::RefreshAll, RefreshCode::RefreshNone, RefreshCode::Resize, ProjectAudioManager::StopIfPaused(), and PendingTracks::SubstitutePendingChangedTrack().

Here is the call graph for this function:

HitTest()

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

static

Definition at line 133 of file TrackButtonHandles.cpp.

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

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

Referenced by CommonTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

CloseButtonHandle & CloseButtonHandle::operator= ( const CloseButtonHandle &  )

default

StopsOnKeystroke()

bool CloseButtonHandle::StopsOnKeystroke ( )

inlineoverrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 57 of file TrackButtonHandles.h.

{ return true; }

Tip()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 119 of file TrackButtonHandles.cpp.

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

References TrackFocus::Get(), CommandManager::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), ButtonHandle::GetTrack(), name, project, wxT(), 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