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

#include <PlayableTrackButtonHandles.h>

Inheritance diagram for MuteButtonHandle:
Collaboration diagram for MuteButtonHandle:

Public Member Functions

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

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

Detailed Description

Definition at line 17 of file PlayableTrackButtonHandles.h.

Constructor & Destructor Documentation

◆ MuteButtonHandle() [1/2]

MuteButtonHandle::MuteButtonHandle ( const MuteButtonHandle )

◆ MuteButtonHandle() [2/2]

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

Definition at line 25 of file PlayableTrackButtonHandles.cpp.

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

◆ ~MuteButtonHandle()

MuteButtonHandle::~MuteButtonHandle ( )

Definition at line 30 of file PlayableTrackButtonHandles.cpp.


Member Function Documentation

◆ CommitChanges()

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

Implements ButtonHandle.

Definition at line 34 of file PlayableTrackButtonHandles.cpp.

37 auto pTrack = mpTrack.lock();
38 if ( dynamic_cast< PlayableTrack* >( pTrack.get() ) )
39 TrackUtilities::DoTrackMute(*pProject, pTrack.get(), event.ShiftDown());
std::weak_ptr< Track > mpTrack
Definition: ButtonHandle.h:74
AudioTrack subclass that can also be audibly replayed by the program.
Definition: PlayableTrack.h:40
void DoTrackMute(AudacityProject &project, Track *t, bool exclusive)

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

Here is the call graph for this function:

◆ HitTest()

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

Definition at line 58 of file PlayableTrackButtonHandles.cpp.

63 wxRect buttonRect;
64 if ( pTrack )
65 PlayableTrackControls::GetMuteSoloRect(rect, buttonRect, false,
66 pTrack.get());
67 if ( CommonTrackInfo::HideTopItem( rect, buttonRect ) )
68 return {};
70 if ( pTrack && buttonRect.Contains(state.m_x, state.m_y) ) {
71 auto result = std::make_shared<MuteButtonHandle>(pTrack, buttonRect);
72 result = AssignUIHandlePtr(holder, result);
73 return result;
74 }
75 else
76 return {};
std::shared_ptr< Subclass > AssignUIHandlePtr(std::weak_ptr< Subclass > &holder, const std::shared_ptr< Subclass > &pNew)
Definition: UIHandle.h:159
static void GetMuteSoloRect(const wxRect &rect, wxRect &dest, bool solo, const Track *pTrack)
AUDACITY_DLL_API bool HideTopItem(const wxRect &rect, const wxRect &subRect, int allowance=0)

References AssignUIHandlePtr(), PlayableTrackControls::GetMuteSoloRect(), and CommonTrackInfo::HideTopItem().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

MuteButtonHandle & MuteButtonHandle::operator= ( const MuteButtonHandle )

◆ StopsOnKeystroke()

bool MuteButtonHandle::StopsOnKeystroke ( )

Reimplemented from UIHandle.

Definition at line 37 of file PlayableTrackButtonHandles.h.

37{ return true; }

◆ Tip()

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

Implements ButtonHandle.

Definition at line 44 of file PlayableTrackButtonHandles.cpp.

47 auto name = XO("Mute");
48 auto focused =
49 TrackFocus::Get( project ).Get() == GetTrack().get();
50 if (!focused)
51 return name;
53 auto &commandManager = CommandManager::Get( project );
54 ComponentInterfaceSymbol command{ wxT("TrackMute"), name };
55 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:317
static CommandManager & Get(AudacityProject &project)
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Track * Get()
Definition: TrackFocus.cpp:156

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: