#include <TrackButtonHandles.h>

Inheritance diagram for MenuButtonHandle:

Collaboration diagram for MenuButtonHandle:

Public Member Functions
	MenuButtonHandle (const std::shared_ptr< TrackPanelCell > &pCell, const std::shared_ptr< Track > &pTrack, const wxRect &rect)

MenuButtonHandle &	operator= (const MenuButtonHandle &)=default

virtual	~MenuButtonHandle ()

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< MenuButtonHandle > &holder, const wxMouseState &state, const wxRect &rect, const std::shared_ptr< TrackPanelCell > &pCell)

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

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
	MenuButtonHandle (const MenuButtonHandle &)=delete

Private Attributes
std::weak_ptr< TrackPanelCell >	mpCell

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 74 of file TrackButtonHandles.h.

Constructor & Destructor Documentation

◆ MenuButtonHandle() [1/2]

MenuButtonHandle::MenuButtonHandle ( const MenuButtonHandle & )

privatedelete

◆ MenuButtonHandle() [2/2]

MenuButtonHandle::MenuButtonHandle	(	const std::shared_ptr< TrackPanelCell > &	pCell,
		const std::shared_ptr< Track > &	pTrack,
		const wxRect &	rect
	)

explicit

Definition at line 152 of file TrackButtonHandles.cpp.

   : ButtonHandle{ pTrack, rect }
   , mpCell{ pCell }
{}

◆ ~MenuButtonHandle()

MenuButtonHandle::~MenuButtonHandle ( )

virtual

Definition at line 159 of file TrackButtonHandles.cpp.

160{

161}

Member Function Documentation

◆ CommitChanges()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 163 of file TrackButtonHandles.cpp.

{
   auto &trackPanel = TrackPanel::Get( *pProject );
   auto pCell = mpCell.lock();
   if (!pCell)
      return RefreshCode::Cancelled;
   auto pTrack =
      static_cast<CommonTrackPanelCell*>(pCell.get())->FindTrack();
   if (!pTrack)
      return RefreshCode::Cancelled;
   trackPanel.CallAfter(
      [&trackPanel,pTrack]{ trackPanel.OnTrackMenu( pTrack.get() ); } );
   return RefreshCode::RefreshNone;
}

References RefreshCode::Cancelled, ButtonHandle::FindTrack(), TrackPanel::Get(), mpCell, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ HitTest()

UIHandlePtr MenuButtonHandle::HitTest	(	std::weak_ptr< MenuButtonHandle > &	holder,
		const wxMouseState &	state,
		const wxRect &	rect,
		const std::shared_ptr< TrackPanelCell > &	pCell
	)

static

Definition at line 193 of file TrackButtonHandles.cpp.

{
   wxRect buttonRect;
   CommonTrackInfo::GetTrackMenuButtonRect(rect, buttonRect);
 
   if (buttonRect.Contains(state.m_x, state.m_y)) {
      auto pTrack = static_cast<CommonTrackPanelCell*>(pCell.get())->FindTrack();
      auto result = std::make_shared<MenuButtonHandle>( pCell, pTrack, buttonRect );
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
   else
      return {};
}

References AssignUIHandlePtr(), ButtonHandle::FindTrack(), and CommonTrackInfo::GetTrackMenuButtonRect().

Referenced by CommonTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

MenuButtonHandle & MenuButtonHandle::operator= ( const MenuButtonHandle & )

default

◆ Tip()

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

overrideprotectedvirtual

Implements ButtonHandle.

Definition at line 179 of file TrackButtonHandles.cpp.

{
   auto name = XO("Open menu...");
   auto focused =
      TrackFocus::Get( project ).Get() == GetTrack().get();
   if (!focused)
      return name;
 
   auto &commandManager = CommandManager::Get( project );
   ComponentInterfaceSymbol command{ wxT("TrackMenu"), name };
   return commandManager.DescribeCommandsAndShortcuts( &command, 1u );
}

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:

Member Data Documentation

◆ mpCell

std::weak_ptr<TrackPanelCell> MenuButtonHandle::mpCell

private

Definition at line 101 of file TrackButtonHandles.h.

Referenced by CommitChanges().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MenuButtonHandle() [1/2]

◆ MenuButtonHandle() [2/2]

◆ ~MenuButtonHandle()

Member Function Documentation

◆ CommitChanges()

◆ HitTest()

◆ operator=()

◆ Tip()

Member Data Documentation

◆ mpCell