TrackSelectHandle Class Reference

#include <TrackSelectHandle.h>

Inheritance diagram for TrackSelectHandle:

Collaboration diagram for TrackSelectHandle:

Public Member Functions
	TrackSelectHandle (const std::shared_ptr< Track > &pTrack)
TrackSelectHandle &	operator= (const TrackSelectHandle &)=default
virtual	~TrackSelectHandle ()
std::shared_ptr< const Track >	FindTrack () const 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 *) override
bool	StopsOnKeystroke () 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	HitAnywhere (std::weak_ptr< TrackSelectHandle > &holder, 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)

Private Member Functions
	TrackSelectHandle (const TrackSelectHandle &)=delete
void	CalculateRearrangingThresholds (const wxMouseEvent &event, AudacityProject *project)

Private Attributes
std::shared_ptr< Track >	mpTrack
bool	mClicked {}
int	mMoveUpThreshold {}
int	mMoveDownThreshold {}
int	mRearrangeCount {}

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 19 of file TrackSelectHandle.h.

Constructor & Destructor Documentation

TrackSelectHandle() [1/2]

TrackSelectHandle::TrackSelectHandle ( const TrackSelectHandle &  )

privatedelete

TrackSelectHandle() [2/2]

TrackSelectHandle::TrackSelectHandle ( const std::shared_ptr< Track > &  pTrack )

explicit

Definition at line 51 of file TrackSelectHandle.cpp.

   : mpTrack( pTrack )
{}

~TrackSelectHandle()

TrackSelectHandle::~TrackSelectHandle ( )

virtual

Definition at line 64 of file TrackSelectHandle.cpp.

{
}

Member Function Documentation

CalculateRearrangingThresholds()

void TrackSelectHandle::CalculateRearrangingThresholds ( const wxMouseEvent &  event, AudacityProject *  project  )

private

Figure out how far the user must drag the mouse up or down before the track will swap with the one above or below

Definition at line 224 of file TrackSelectHandle.cpp.

{
   // JH: this will probably need to be tweaked a bit, I'm just
   //   not sure what formula will have the best feel for the
   //   user.
 
   auto &tracks = TrackList::Get( *project );
 
   if (mpTrack && tracks.CanMoveUp(*mpTrack))
      mMoveUpThreshold =
         event.m_y -
            ChannelView::GetChannelGroupHeight(
               * -- tracks.Find(mpTrack.get()));
   else
      mMoveUpThreshold = INT_MIN;
 
   if (mpTrack && tracks.CanMoveDown(*mpTrack))
      mMoveDownThreshold =
         event.m_y +
            ChannelView::GetChannelGroupHeight(
               * ++ tracks.Find(mpTrack.get()));
   else
      mMoveDownThreshold = INT_MAX;
}

References TrackList::Get(), ChannelView::GetChannelGroupHeight(), mMoveDownThreshold, mMoveUpThreshold, mpTrack, project, and tracks.

Referenced by Click(), and Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 214 of file TrackSelectHandle.cpp.

{
   ProjectHistory::Get( *pProject ).RollbackState();
   // Bug 1677
   mpTrack.reset();
   return RefreshCode::RefreshAll;
}

References ProjectHistory::Get(), mpTrack, RefreshCode::RefreshAll, and ProjectHistory::RollbackState().

Here is the call graph for this function:

Click()

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

overridevirtual

Implements UIHandle.

Definition at line 73 of file TrackSelectHandle.cpp.

{
   // If unsafe to drag, still, it does harmlessly change the selected track
   // set on button down.
 
   using namespace RefreshCode;
   Result result = RefreshNone;
 
   const wxMouseEvent &event = evt.event;
 
   // AS: If not a click, ignore the mouse event.
   if (!event.ButtonDown() && !event.ButtonDClick())
      return Cancelled;
   if (!event.Button(wxMOUSE_BTN_LEFT))
      return Cancelled;
 
   const auto pTrack = mpTrack;
   if (!pTrack)
      return Cancelled;
   const bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
 
   // DM: If they weren't clicking on a particular part of a track label,
   //  deselect other tracks and select this one.
 
   // JH: also, capture the current track for rearranging, so the user
   //  can drag the track up or down to swap it with others
   if (unsafe)
      result |= Cancelled;
   else {
      mRearrangeCount = 0;
      CalculateRearrangingThresholds(event, pProject);
   }
 
   SelectUtilities::DoListSelection(*pProject,
      *pTrack, event.ShiftDown(), event.ControlDown(), !unsafe);
 
   mClicked = true;
   return result;
}

References CalculateRearrangingThresholds(), Cancelled, SelectUtilities::DoListSelection(), TrackPanelMouseEvent::event, ProjectAudioIO::Get(), ProjectAudioIO::IsAudioActive(), mClicked, mpTrack, mRearrangeCount, and RefreshCode::RefreshNone.

Here is the call graph for this function:

Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 114 of file TrackSelectHandle.cpp.

{
   using namespace RefreshCode;
   Result result = RefreshNone;
   if (!mpTrack)
      return result;
 
   const wxMouseEvent &event = evt.event;
 
   auto &tracks = TrackList::Get( *pProject );
 
   // probably harmless during play?  However, we do disallow the click, so check this too.
   bool unsafe = ProjectAudioIO::Get( *pProject ).IsAudioActive();
   if (unsafe)
      return result;
 
   if (event.m_y < mMoveUpThreshold || event.m_y < 0) {
      tracks.MoveUp(*mpTrack);
      --mRearrangeCount;
   }
   else if ( event.m_y > mMoveDownThreshold
      || event.m_y > evt.whole.GetHeight() ) {
      tracks.MoveDown(*mpTrack);
      ++mRearrangeCount;
   }
   else
      return result;
 
   // JH: if we moved up or down, recalculate the thresholds and make sure the
   // track is fully on-screen.
   CalculateRearrangingThresholds(event, pProject);
 
   result |= EnsureVisible | RefreshAll;
   return result;
}

References CalculateRearrangingThresholds(), RefreshCode::EnsureVisible, TrackPanelMouseEvent::event, ProjectAudioIO::Get(), TrackList::Get(), ProjectAudioIO::IsAudioActive(), mMoveDownThreshold, mMoveUpThreshold, mpTrack, mRearrangeCount, RefreshCode::RefreshAll, RefreshCode::RefreshNone, tracks, and TrackPanelMouseEvent::whole.

Here is the call graph for this function:

FindTrack()

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

overridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 68 of file TrackSelectHandle.cpp.

{
   return mpTrack;
}

References mpTrack.

HitAnywhere()

UIHandlePtr TrackSelectHandle::HitAnywhere ( std::weak_ptr< TrackSelectHandle > &  holder, const std::shared_ptr< Track > &  pTrack  )

static

Definition at line 55 of file TrackSelectHandle.cpp.

{
   auto result = std::make_shared<TrackSelectHandle>(pTrack);
   result = AssignUIHandlePtr(holder, result);
   return result;
}

References AssignUIHandlePtr().

Referenced by CommonTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

TrackSelectHandle & TrackSelectHandle::operator= ( const TrackSelectHandle &  )

default

Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 151 of file TrackSelectHandle.cpp.

{
   static auto disabledCursor =
      ::MakeCursor(wxCURSOR_NO_ENTRY, DisabledCursorXpm, 16, 16);
   //static wxCursor rearrangeCursor{ wxCURSOR_HAND };
   static auto rearrangingCursor =
      ::MakeCursor(wxCURSOR_HAND, RearrangingCursorXpm, 16, 16);
   static wxCursor arrowCursor{ wxCURSOR_ARROW };
 
   //static auto hoverCursor =
   //   ::MakeCursor(wxCURSOR_HAND, RearrangeCursorXpm, 16, 16);
   //static auto clickedCursor =
   //   ::MakeCursor(wxCURSOR_HAND, RearrangingCursorXpm, 16, 16);
 
   const auto trackCount = TrackList::Get( *project ).Any().size();
   auto message = Message(trackCount);
   if (mClicked) {
      const bool unsafe =
         ProjectAudioIO::Get( *project ).IsAudioActive();
      const bool canMove = TrackList::Get( *project ).Any().size() > 1;
      return {
         message,
         (unsafe
          ? &*disabledCursor
          : canMove
             ? &*rearrangingCursor
             : &arrowCursor)
         // , message // Stop showing the tooltip after the click
      };
   }
   else {
      // Only mouse-over
      // Don't test safety, because the click to change selection is allowed
      return {
         message,
         &arrowCursor,
         message
      };
   }
}

References TrackList::Any(), ProjectAudioIO::Get(), TrackList::Get(), ProjectAudioIO::IsAudioActive(), MakeCursor(), mClicked, and anonymous_namespace{TrackSelectHandle.cpp}::Message().

Here is the call graph for this function:

Release()

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

overridevirtual

Implements UIHandle.

Definition at line 193 of file TrackSelectHandle.cpp.

{
   // If we're releasing, surely we are dragging a track?
   wxASSERT( mpTrack );
   if (mRearrangeCount != 0) {
      ProjectHistory::Get( *project ).PushState(
         /* i18n-hint: will substitute name of track for %s */
         ( mRearrangeCount < 0 ? XO("Moved '%s' up") : XO("Moved '%s' down") )
            .Format( mpTrack->GetName() ),
         XO("Move Track"));
   }
   // Bug 1677
   // Holding on to the reference to the track was causing it to be released far later
   // than necessary, on shutdown, and so causing a crash as a dialog about cleaning
   // out files could not show at that time.
   mpTrack.reset();
   // No need to redraw, that was done when drag moved the track
   return RefreshCode::RefreshNone;
}

References ProjectHistory::Get(), mpTrack, mRearrangeCount, ProjectHistory::PushState(), RefreshCode::RefreshNone, and XO().

Here is the call graph for this function:

StopsOnKeystroke()

bool TrackSelectHandle::StopsOnKeystroke ( )

inlineoverridevirtual

Reimplemented from UIHandle.

Definition at line 52 of file TrackSelectHandle.h.

{ return true; }

Member Data Documentation

mClicked

bool TrackSelectHandle::mClicked {}

private

Definition at line 56 of file TrackSelectHandle.h.

Referenced by Click(), and Preview().

mMoveDownThreshold

int TrackSelectHandle::mMoveDownThreshold {}

private

Definition at line 61 of file TrackSelectHandle.h.

Referenced by CalculateRearrangingThresholds(), and Drag().

mMoveUpThreshold

int TrackSelectHandle::mMoveUpThreshold {}

private

Definition at line 60 of file TrackSelectHandle.h.

Referenced by CalculateRearrangingThresholds(), and Drag().

mpTrack

std::shared_ptr<Track> TrackSelectHandle::mpTrack

private

Definition at line 55 of file TrackSelectHandle.h.

Referenced by CalculateRearrangingThresholds(), Cancel(), Click(), Drag(), FindTrack(), and Release().

mRearrangeCount

int TrackSelectHandle::mRearrangeCount {}

private

Definition at line 62 of file TrackSelectHandle.h.

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

---

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

• TrackSelectHandle.h
• TrackSelectHandle.cpp