#include <NoteTrackButtonHandle.h>

Inheritance diagram for NoteTrackButtonHandle:

Collaboration diagram for NoteTrackButtonHandle:

Public Member Functions
	NoteTrackButtonHandle (const std::shared_ptr< NoteTrack > &pTrack, int channel, const wxRect &rect)

NoteTrackButtonHandle &	operator= (const NoteTrackButtonHandle &)=default

virtual	~NoteTrackButtonHandle ()

std::shared_ptr< NoteTrack >	GetTrack () const

std::shared_ptr< const Track >	FindTrack () const override

int	GetChannel () const

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< NoteTrackButtonHandle > &holder, const wxMouseState &state, const wxRect &rect, const std::shared_ptr< NoteTrack > &pTrack)

static UIHandle::Result	NeedChangeHighlight (const NoteTrackButtonHandle &oldState, const NoteTrackButtonHandle &newState)

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
void	Enter (bool forward, AudacityProject *) override

Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) override

Result	Release (const TrackPanelMouseEvent &event, AudacityProject pProject, wxWindow pParent) override

Result	Cancel (AudacityProject *pProject) override

Protected Attributes
std::weak_ptr< NoteTrack >	mpTrack

int	mChannel { -1 }

wxRect	mRect {}

Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Private Member Functions
	NoteTrackButtonHandle (const NoteTrackButtonHandle &)

	NoteTrackButtonHandle ()

Static Private Member Functions
static NoteTrackButtonHandle &	Instance ()

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned

using	Cell = TrackPanelCell

Detailed Description

Definition at line 21 of file NoteTrackButtonHandle.h.

Constructor & Destructor Documentation

◆ NoteTrackButtonHandle() [1/3]

NoteTrackButtonHandle::NoteTrackButtonHandle ( const NoteTrackButtonHandle & )

private

◆ NoteTrackButtonHandle() [2/3]

NoteTrackButtonHandle::NoteTrackButtonHandle ( )

private

◆ NoteTrackButtonHandle() [3/3]

NoteTrackButtonHandle::NoteTrackButtonHandle	(	const std::shared_ptr< NoteTrack > &	pTrack,
		int	channel,
		const wxRect &	rect
	)

explicit

Definition at line 26 of file NoteTrackButtonHandle.cpp.

   : mpTrack{ pTrack }
   , mChannel{ channel }
   , mRect{ rect }
{
}

◆ ~NoteTrackButtonHandle()

NoteTrackButtonHandle::~NoteTrackButtonHandle ( )

virtual

Definition at line 40 of file NoteTrackButtonHandle.cpp.

41{

42}

Member Function Documentation

◆ Cancel()

UIHandle::Result NoteTrackButtonHandle::Cancel ( AudacityProject * pProject )

overrideprotectedvirtual

Implements UIHandle.

Definition at line 151 of file NoteTrackButtonHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

◆ Click()

UIHandle::Result NoteTrackButtonHandle::Click	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overrideprotectedvirtual

Implements UIHandle.

Definition at line 109 of file NoteTrackButtonHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

◆ Drag()

UIHandle::Result NoteTrackButtonHandle::Drag	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject
	)

overrideprotectedvirtual

Implements UIHandle.

Definition at line 115 of file NoteTrackButtonHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

◆ Enter()

void NoteTrackButtonHandle::Enter	(	bool	forward,
		AudacityProject *
	)

overrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 35 of file NoteTrackButtonHandle.cpp.

{
   mChangeHighlight = RefreshCode::RefreshCell;
}

References UIHandle::mChangeHighlight, and RefreshCode::RefreshCell.

◆ FindTrack()

std::shared_ptr< const Track > NoteTrackButtonHandle::FindTrack ( ) const

overridevirtual

Returns: pointer to associated track, if any

Implements UIHandle.

Definition at line 44 of file NoteTrackButtonHandle.cpp.

{
   return mpTrack.lock();
}

References mpTrack.

◆ GetChannel()

int NoteTrackButtonHandle::GetChannel ( ) const

inline

Definition at line 43 of file NoteTrackButtonHandle.h.

43{ return mChannel; }

References mChannel.

Referenced by NeedChangeHighlight().

Here is the caller graph for this function:

◆ GetTrack()

std::shared_ptr< NoteTrack > NoteTrackButtonHandle::GetTrack ( ) const

inline

Definition at line 41 of file NoteTrackButtonHandle.h.

41{ return mpTrack.lock(); }

References mpTrack.

Referenced by anonymous_namespace{NoteTrackControls.cpp}::MidiControlsDrawFunction().

Here is the caller graph for this function:

◆ HitTest()

UIHandlePtr NoteTrackButtonHandle::HitTest	(	std::weak_ptr< NoteTrackButtonHandle > &	holder,
		const wxMouseState &	state,
		const wxRect &	rect,
		const std::shared_ptr< NoteTrack > &	pTrack
	)

static

Definition at line 89 of file NoteTrackButtonHandle.cpp.

{
   wxRect midiRect;
   NoteTrackControls::GetMidiControlsRect(rect, midiRect);
   if ( CommonTrackInfo::HideTopItem( rect, midiRect ) )
      return {};
   if (midiRect.Contains(state.m_x, state.m_y)) {
      auto channel = FindChannelNumber(midiRect, state.m_x, state.m_y);
      auto result = std::make_shared<NoteTrackButtonHandle>(
         pTrack, channel, midiRect );
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
   else
      return {};
}

References AssignUIHandlePtr(), FindChannelNumber(), NoteTrackControls::GetMidiControlsRect(), and CommonTrackInfo::HideTopItem().

Referenced by NoteTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Instance()

static NoteTrackButtonHandle & NoteTrackButtonHandle::Instance ( )

staticprivate

◆ NeedChangeHighlight()

UIHandle::Result NoteTrackButtonHandle::NeedChangeHighlight	(	const NoteTrackButtonHandle &	oldState,
		const NoteTrackButtonHandle &	newState
	)

static

Definition at line 49 of file NoteTrackButtonHandle.cpp.

{
   if (oldState.GetChannel() != newState.GetChannel())
      // Repaint whenever the highlighted button is different
      return RefreshCode::RefreshCell;
   return 0;
}

References GetChannel(), and RefreshCode::RefreshCell.

Here is the call graph for this function:

◆ operator=()

NoteTrackButtonHandle & NoteTrackButtonHandle::operator= ( const NoteTrackButtonHandle & )

default

◆ Preview()

HitTestPreview NoteTrackButtonHandle::Preview	(	const TrackPanelMouseState &	state,
		AudacityProject *	pProject
	)

overrideprotectedvirtual

Implements UIHandle.

Definition at line 121 of file NoteTrackButtonHandle.cpp.

{
   // auto pTrack = pProject->GetTracks()->Lock(mpTrack);
   auto pTrack = mpTrack.lock();
   if ( !pTrack )
      return {};
   // No special message or cursor
   return {};
}

References mpTrack.

◆ Release()

UIHandle::Result NoteTrackButtonHandle::Release	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent
	)

overrideprotectedvirtual

Implements UIHandle.

Definition at line 132 of file NoteTrackButtonHandle.cpp.

{
   using namespace RefreshCode;
 
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   if (!pTrack)
      return Cancelled;
 
   const wxMouseEvent &event = evt.event;
   if (LabelClick(*pTrack, mRect, event.m_x, event.m_y,
      event.Button(wxMOUSE_BTN_RIGHT))) {
      // No undo items needed??
      ProjectHistory::Get( *pProject ).ModifyState(false);
      return RefreshAll;
   }
   return RefreshNone;
}

References Cancelled, TrackPanelMouseEvent::event, ProjectHistory::Get(), TrackList::Get(), LabelClick(), TrackList::Lock(), ProjectHistory::ModifyState(), mpTrack, mRect, RefreshCode::RefreshAll, and RefreshCode::RefreshNone.

Here is the call graph for this function:

Member Data Documentation

◆ mChannel

int NoteTrackButtonHandle::mChannel { -1 }

protected

Definition at line 69 of file NoteTrackButtonHandle.h.

Referenced by GetChannel().

◆ mpTrack

std::weak_ptr<NoteTrack> NoteTrackButtonHandle::mpTrack

protected

Definition at line 68 of file NoteTrackButtonHandle.h.

Referenced by FindTrack(), GetTrack(), Preview(), and Release().

◆ mRect

wxRect NoteTrackButtonHandle::mRect {}

protected

Definition at line 70 of file NoteTrackButtonHandle.h.

Referenced by Release().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NoteTrackButtonHandle() [1/3]

◆ NoteTrackButtonHandle() [2/3]

◆ NoteTrackButtonHandle() [3/3]

◆ ~NoteTrackButtonHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ Enter()

◆ FindTrack()

◆ GetChannel()

◆ GetTrack()

◆ HitTest()

◆ Instance()

◆ NeedChangeHighlight()

◆ operator=()

◆ Preview()

◆ Release()

Member Data Documentation

◆ mChannel

◆ mpTrack

◆ mRect