TimeTrackVZoomHandle Class Reference

#include <TimeTrackVZoomHandle.h>

Inheritance diagram for TimeTrackVZoomHandle:

Collaboration diagram for TimeTrackVZoomHandle:

Public Member Functions
	TimeTrackVZoomHandle (const std::shared_ptr< TimeTrack > &pTrack, const wxRect &rect, int y)
TimeTrackVZoomHandle &	operator= (const TimeTrackVZoomHandle &)=default
	~TimeTrackVZoomHandle () override
std::shared_ptr< const Track >	FindTrack () const override
void	Enter (bool forward, AudacityProject *) override
bool	HandlesRightClick () override
	Whether the handle has any special right-button handling. More...
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
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)

Private Member Functions
	TimeTrackVZoomHandle (const TimeTrackVZoomHandle &)

Private Attributes
std::weak_ptr< TimeTrack >	mpTrack

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
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 Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 18 of file TimeTrackVZoomHandle.h.

Constructor & Destructor Documentation

TimeTrackVZoomHandle() [1/2]

TimeTrackVZoomHandle::TimeTrackVZoomHandle ( const TimeTrackVZoomHandle &  )

private

TimeTrackVZoomHandle() [2/2]

TimeTrackVZoomHandle::TimeTrackVZoomHandle ( const std::shared_ptr< TimeTrack > &  pTrack, const wxRect &  rect, int  y  )

explicit

Definition at line 23 of file TimeTrackVZoomHandle.cpp.

      : mpTrack{ pTrack }
{
}

~TimeTrackVZoomHandle()

TimeTrackVZoomHandle::~TimeTrackVZoomHandle ( )

overridedefault

Member Function Documentation

Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 106 of file TimeTrackVZoomHandle.cpp.

{
   // Cancel is implemented!  And there is no initial state to restore,
   // so just return a code.
   return RefreshCode::RefreshAll;
}

References RefreshCode::RefreshAll.

Click()

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

overridevirtual

Implements UIHandle.

Definition at line 48 of file TimeTrackVZoomHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 54 of file TimeTrackVZoomHandle.cpp.

{
   using namespace RefreshCode;
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   if (!pTrack)
      return Cancelled;
   return RefreshNone;
}

References Cancelled, TrackList::Get(), TrackList::Lock(), mpTrack, and RefreshCode::RefreshNone.

Here is the call graph for this function:

Enter()

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

overridevirtual

Reimplemented from UIHandle.

Definition at line 36 of file TimeTrackVZoomHandle.cpp.

{
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   mChangeHighlight = RefreshCode::RefreshCell;
#endif
}

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

FindTrack()

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

overridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 31 of file TimeTrackVZoomHandle.cpp.

{
   return mpTrack.lock();
}

References mpTrack.

HandlesRightClick()

bool TimeTrackVZoomHandle::HandlesRightClick ( )

overridevirtual

Whether the handle has any special right-button handling.

If not, then Click() will not be called for right click. Default is always false

Reimplemented from UIHandle.

Definition at line 43 of file TimeTrackVZoomHandle.cpp.

{
   return true;
}

operator=()

TimeTrackVZoomHandle & TimeTrackVZoomHandle::operator= ( const TimeTrackVZoomHandle &  )

default

Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 64 of file TimeTrackVZoomHandle.cpp.

{
   static  wxCursor arrowCursor{ wxCURSOR_ARROW };
 
   return {
      XO("Right-click for menu."),
      &arrowCursor
      // , message
   };
}

References XO().

Here is the call graph for this function:

Release()

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

overridevirtual

Implements UIHandle.

Definition at line 76 of file TimeTrackVZoomHandle.cpp.

{
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   using namespace RefreshCode;
   if (!pTrack)
      return RefreshNone;
 
   const wxMouseEvent &event = evt.event;
   const bool shiftDown = event.ShiftDown();
   const bool rightUp = event.RightUp();
 
   // Popup menu...
   if (
       rightUp &&
       !(event.ShiftDown() || event.CmdDown()))
   {
      CommonTrackControls::InitMenuData data {
         *pProject, *pTrack, pParent, RefreshNone
      };
 
      auto pMenu = PopupMenuTable::BuildMenu(
         &TimeTrackMenuTable::Instance(), &data);
      pMenu->Popup( *pParent, { event.m_x, event.m_y } );
   }
 
   return UpdateVRuler | RefreshAll;
}

References PopupMenuTable::BuildMenu(), TrackPanelMouseEvent::event, TrackList::Get(), TimeTrackMenuTable::Instance(), TrackList::Lock(), mpTrack, RefreshCode::RefreshAll, RefreshCode::RefreshNone, and RefreshCode::UpdateVRuler.

Here is the call graph for this function:

Member Data Documentation

mpTrack

std::weak_ptr<TimeTrack> TimeTrackVZoomHandle::mpTrack

private

Definition at line 53 of file TimeTrackVZoomHandle.h.

Referenced by Drag(), FindTrack(), and Release().

---

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

• TimeTrackVZoomHandle.h
• TimeTrackVZoomHandle.cpp