EffectsButtonHandle Class Reference

#include <PlayableTrackButtonHandles.h>

Inheritance diagram for EffectsButtonHandle:

Collaboration diagram for EffectsButtonHandle:

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

privatedelete

EffectsButtonHandle() [2/2]

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

explicit

Definition at line 138 of file PlayableTrackButtonHandles.cpp.

   : ButtonHandle{ pTrack, rect }
{}

~EffectsButtonHandle()

EffectsButtonHandle::~EffectsButtonHandle ( )

virtual

Definition at line 143 of file PlayableTrackButtonHandles.cpp.

{
}

Member Function Documentation

CommitChanges()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 147 of file PlayableTrackButtonHandles.cpp.

{
   RealtimeEffectPanel::Get(*pProject).ShowPanel(
      dynamic_cast<SampleTrack *>(mpTrack.lock().get()), true);
   return RefreshCode::RefreshNone;
}

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  )

static

Definition at line 174 of file PlayableTrackButtonHandles.cpp.

{
   wxRect buttonRect;
   if ( pTrack )
      PlayableTrackControls::GetEffectsButtonRect(rect, buttonRect,
         pTrack.get());
 
   if ( CommonTrackInfo::HideTopItem( rect, buttonRect ) )
      return {};
 
   if ( pTrack && buttonRect.Contains(state.m_x, state.m_y) ) {
      auto result = std::make_shared<EffectsButtonHandle>( pTrack, buttonRect );
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
   else
      return {};
}

References AssignUIHandlePtr(), PlayableTrackControls::GetEffectsButtonRect(), 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 &  )

default

StopsOnKeystroke()

bool EffectsButtonHandle::StopsOnKeystroke ( )

inlineoverrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 99 of file PlayableTrackButtonHandles.h.

{ return true; }

Tip()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 155 of file PlayableTrackButtonHandles.cpp.

{
   auto name = XO("Effects");
   auto focused =
      TrackFocus::Get( project ).Get() == GetTrack().get();
   if (!focused)
      return name;
   else {
      return name;
   // Instead supply shortcut when "TrackEffects" is defined
   /*
   auto &commandManager = CommandManager::Get( project );
   ComponentInterfaceSymbol command{ wxT("TrackEffects"), name };
   return commandManager.DescribeCommandsAndShortcuts( &command, 1u );
    */
   }
}

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:

• PlayableTrackButtonHandles.h
• PlayableTrackButtonHandles.cpp