Audacity  3.0.3
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:
[legend]
Collaboration diagram for MuteButtonHandle:
[legend]

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 IsClicked () const
 
- Public Member Functions inherited from UIHandle
virtual ~UIHandle ()=0
 
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 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< 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 ()
 
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 mIsClicked {}
 
- 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 )
privatedelete

◆ MuteButtonHandle() [2/2]

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

Definition at line 25 of file PlayableTrackButtonHandles.cpp.

27  : ButtonHandle{ pTrack, rect }
28 {}

◆ ~MuteButtonHandle()

MuteButtonHandle::~MuteButtonHandle ( )
virtual

Definition at line 30 of file PlayableTrackButtonHandles.cpp.

31 {
32 }

Member Function Documentation

◆ CommitChanges()

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

Implements ButtonHandle.

Definition at line 34 of file PlayableTrackButtonHandles.cpp.

36 {
37  auto pTrack = mpTrack.lock();
38  if ( dynamic_cast< PlayableTrack* >( pTrack.get() ) )
39  TrackUtilities::DoTrackMute(*pProject, pTrack.get(), event.ShiftDown());
40 
42 }

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 
)
static

Definition at line 58 of file PlayableTrackButtonHandles.cpp.

62 {
63  wxRect buttonRect;
64  if ( pTrack )
65  PlayableTrackControls::GetMuteSoloRect(rect, buttonRect, false,
66  !ProjectSettings::Get( *pProject ).IsSoloNone(), pTrack.get());
67  if ( TrackInfo::HideTopItem( rect, buttonRect ) )
68  return {};
69 
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 {};
77 }

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=()

MuteButtonHandle& MuteButtonHandle::operator= ( const MuteButtonHandle )
default

◆ StopsOnKeystroke()

bool MuteButtonHandle::StopsOnKeystroke ( )
inlineoverrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 37 of file PlayableTrackButtonHandles.h.

37 { return true; }

◆ Tip()

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

Implements ButtonHandle.

Definition at line 44 of file PlayableTrackButtonHandles.cpp.

46 {
47  auto name = XO("Mute");
48  auto focused =
49  TrackFocus::Get( project ).Get() == GetTrack().get();
50  if (!focused)
51  return name;
52 
53  auto &commandManager = CommandManager::Get( project );
54  ComponentInterfaceSymbol command{ wxT("TrackMute"), name };
55  return commandManager.DescribeCommandsAndShortcuts(&command, 1u);
56 }

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

Here is the call graph for this function:

The documentation for this class was generated from the following files:
RefreshCode::RefreshNone
@ RefreshNone
Definition: RefreshCode.h:21
ClientData::Site::Get
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
ButtonHandle::mpTrack
std::weak_ptr< Track > mpTrack
Definition: ButtonHandle.h:72
XO
#define XO(s)
Definition: Internat.h:31
ProjectSettings::Get
static ProjectSettings & Get(AudacityProject &project)
Definition: ProjectSettings.cpp:45
ButtonHandle::GetTrack
std::shared_ptr< Track > GetTrack() const
Definition: ButtonHandle.h:30
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
PlayableTrackControls::GetMuteSoloRect
static void GetMuteSoloRect(const wxRect &rect, wxRect &dest, bool solo, bool bHasSoloButton, const Track *pTrack)
Definition: PlayableTrackControls.cpp:164
ButtonHandle
A UIHandle for a TrackPanel button, such as the Mute and Solo buttons.
Definition: ButtonHandle.h:26
name
const TranslatableString name
Definition: Distortion.cpp:98
TrackFocus::Get
Track * Get()
Definition: TrackPanelAx.cpp:760
PlayableTrack
AudioTrack subclass that can also be audibly replayed by the program.
Definition: Track.h:875
TrackInfo::HideTopItem
AUDACITY_DLL_API bool HideTopItem(const wxRect &rect, const wxRect &subRect, int allowance=0)
Definition: TrackInfo.cpp:208
TrackUtilities::DoTrackMute
void DoTrackMute(AudacityProject &project, Track *t, bool exclusive)
Definition: TrackUtilities.cpp:64
ProjectSettings::IsSoloNone
bool IsSoloNone() const
Definition: ProjectSettings.h:128
AssignUIHandlePtr
std::shared_ptr< Subclass > AssignUIHandlePtr(std::weak_ptr< Subclass > &holder, const std::shared_ptr< Subclass > &pNew)
Definition: UIHandle.h:151
CommandManager::Get
static CommandManager & Get(AudacityProject &project)
Definition: CommandManager.cpp:207