Audacity 3.2.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
CloseButtonHandle Class Referencefinal

#include <TrackButtonHandles.h>

Inheritance diagram for CloseButtonHandle:
Collaboration diagram for CloseButtonHandle:

Public Member Functions

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

 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< TrackmpTrack
wxRect mRect
bool mWasIn { true }
bool mIsClicked {}
- Protected Attributes inherited from UIHandle
Result mChangeHighlight { 0 }

Detailed Description

Definition at line 70 of file TrackButtonHandles.h.

Constructor & Destructor Documentation

◆ CloseButtonHandle() [1/2]

CloseButtonHandle::CloseButtonHandle ( const CloseButtonHandle )

◆ CloseButtonHandle() [2/2]

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

Definition at line 140 of file TrackButtonHandles.cpp.

142 : ButtonHandle{ pTrack, rect }
A UIHandle for a TrackPanel button, such as the Mute and Solo buttons.
Definition: ButtonHandle.h:26

◆ ~CloseButtonHandle()

CloseButtonHandle::~CloseButtonHandle ( )

Definition at line 145 of file TrackButtonHandles.cpp.


Member Function Documentation

◆ CommitChanges()

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

Implements ButtonHandle.

Definition at line 149 of file TrackButtonHandles.cpp.

152 using namespace RefreshCode;
153 Result result = RefreshNone;
155 auto pTrack = mpTrack.lock();
156 if (pTrack)
157 {
158 auto toRemove = pTrack->SubstitutePendingChangedTrack();
160 if (!ProjectAudioIO::Get( *pProject ).IsAudioActive()) {
161 // This pushes an undo item:
162 TrackUtilities::DoRemoveTrack(*pProject, toRemove.get());
163 // Redraw all tracks when any one of them closes
164 // (Could we invent a return code that draws only those at or below
165 // the affected track?)
167 }
168 }
170 return result;
std::weak_ptr< Track > mpTrack
Definition: ButtonHandle.h:72
bool IsAudioActive() const
static ProjectAudioIO & Get(AudacityProject &project)
static ProjectAudioManager & Get(AudacityProject &project)
unsigned Result
Definition: UIHandle.h:38
Namespace containing an enum 'what to do on a refresh?'.
Definition: RefreshCode.h:16
void DoRemoveTrack(AudacityProject &project, Track *toRemove)

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

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 

Definition at line 187 of file TrackButtonHandles.cpp.

191 wxRect buttonRect;
192 TrackInfo::GetCloseBoxRect(rect, buttonRect);
194 if (buttonRect.Contains(state.m_x, state.m_y)) {
195 auto pTrack = static_cast<CommonTrackPanelCell*>(pCell)->FindTrack();
196 auto result = std::make_shared<CloseButtonHandle>( pTrack, buttonRect );
197 result = AssignUIHandlePtr(holder, result);
198 return result;
199 }
200 else
201 return {};
std::shared_ptr< Subclass > AssignUIHandlePtr(std::weak_ptr< Subclass > &holder, const std::shared_ptr< Subclass > &pNew)
Definition: UIHandle.h:151
AUDACITY_DLL_API void GetCloseBoxRect(const wxRect &rect, wxRect &dest)
Definition: TrackInfo.cpp:459
std::shared_ptr< Track > FindTrack(TrackPanelCell *pCell)
Definition: TrackPanel.cpp:525

References AssignUIHandlePtr(), anonymous_namespace{TrackPanel.cpp}::FindTrack(), and TrackInfo::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 )

◆ StopsOnKeystroke()

bool CloseButtonHandle::StopsOnKeystroke ( )

Reimplemented from UIHandle.

Definition at line 82 of file TrackButtonHandles.h.

82{ return true; }

◆ Tip()

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

Implements ButtonHandle.

Definition at line 173 of file TrackButtonHandles.cpp.

176 auto name = XO("Close");
177 auto focused =
178 TrackFocus::Get( project ).Get() == GetTrack().get();
179 if (!focused)
180 return name;
182 auto &commandManager = CommandManager::Get( project );
183 ComponentInterfaceSymbol command{ wxT("TrackClose"), name };
184 return commandManager.DescribeCommandsAndShortcuts( &command, 1u );
const TranslatableString name
Definition: Distortion.cpp:76
const auto project
std::shared_ptr< Track > GetTrack() const
Definition: ButtonHandle.h:30
Subclass & Get(const RegisteredFactory &key)
Get reference to an attachment, creating on demand if not present, down-cast it to Subclass.
Definition: ClientData.h:309
static CommandManager & Get(AudacityProject &project)
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Track * Get()

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: