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

#include <PlayableTrackButtonHandles.h>

Inheritance diagram for EffectsButtonHandle:
Collaboration diagram for EffectsButtonHandle:

Public Member Functions

 EffectsButtonHandle (const std::shared_ptr< Track > &pTrack, const wxRect &rect)
EffectsButtonHandleoperator= (const EffectsButtonHandle &)=default
virtual ~EffectsButtonHandle ()
- 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< EffectsButtonHandle > &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

 EffectsButtonHandle (const EffectsButtonHandle &)=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 79 of file PlayableTrackButtonHandles.h.

Constructor & Destructor Documentation

◆ EffectsButtonHandle() [1/2]

EffectsButtonHandle::EffectsButtonHandle ( const EffectsButtonHandle )

◆ EffectsButtonHandle() [2/2]

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

Definition at line 138 of file PlayableTrackButtonHandles.cpp.

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

◆ ~EffectsButtonHandle()

EffectsButtonHandle::~EffectsButtonHandle ( )

Definition at line 143 of file PlayableTrackButtonHandles.cpp.


Member Function Documentation

◆ CommitChanges()

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

Implements ButtonHandle.

Definition at line 147 of file PlayableTrackButtonHandles.cpp.

151 dynamic_cast<SampleTrack *>(mpTrack.lock().get()), true);
std::weak_ptr< Track > mpTrack
Definition: ButtonHandle.h:74
void ShowPanel(SampleTrack *track, bool focus)
static RealtimeEffectPanel & Get(AudacityProject &project)

References RealtimeEffectPanel::Get(), ButtonHandle::mpTrack, RefreshCode::RefreshNone, and RealtimeEffectPanel::ShowPanel().

Here is the call graph for this function:

◆ HitTest()

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

Definition at line 174 of file PlayableTrackButtonHandles.cpp.

179 wxRect buttonRect;
180 if ( pTrack )
182 pTrack.get());
184 if ( CommonTrackInfo::HideTopItem( rect, buttonRect ) )
185 return {};
187 if ( pTrack && buttonRect.Contains(state.m_x, state.m_y) ) {
188 auto result = std::make_shared<EffectsButtonHandle>( pTrack, buttonRect );
189 result = AssignUIHandlePtr(holder, result);
190 return result;
191 }
192 else
193 return {};
std::shared_ptr< Subclass > AssignUIHandlePtr(std::weak_ptr< Subclass > &holder, const std::shared_ptr< Subclass > &pNew)
Definition: UIHandle.h:159
static void GetEffectsRect(const wxRect &rect, wxRect &dest, const Track *pTrack)
AUDACITY_DLL_API bool HideTopItem(const wxRect &rect, const wxRect &subRect, int allowance=0)

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

Referenced by WaveTrackControls::HitTest().

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

◆ operator=()

EffectsButtonHandle & EffectsButtonHandle::operator= ( const EffectsButtonHandle )

◆ StopsOnKeystroke()

bool EffectsButtonHandle::StopsOnKeystroke ( )

Reimplemented from UIHandle.

Definition at line 99 of file PlayableTrackButtonHandles.h.

99{ return true; }

◆ Tip()

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

Implements ButtonHandle.

Definition at line 155 of file PlayableTrackButtonHandles.cpp.

158 auto name = XO("Effects");
159 auto focused =
160 TrackFocus::Get( project ).Get() == GetTrack().get();
161 if (!focused)
162 return name;
163 else {
164 return name;
165 // Instead supply shortcut when "TrackEffects" is defined
166 /*
167 auto &commandManager = CommandManager::Get( project );
168 ComponentInterfaceSymbol command{ wxT("TrackEffects"), name };
169 return commandManager.DescribeCommandsAndShortcuts( &command, 1u );
170 */
171 }
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
Track * Get()
Definition: TrackFocus.cpp:156

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

Here is the call graph for this function:

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