SubViewRearrangeHandle Class Reference

Inheritance diagram for SubViewRearrangeHandle:

Collaboration diagram for SubViewRearrangeHandle:

Public Types
enum	{ HotZoneWidth = 3 * kTrackInfoBtnSize / 2 }
enum	DragChoice_t { Upward , Downward , Neutral }
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell

Public Member Functions
	SubViewRearrangeHandle (SubViewAdjuster &&adjuster, size_t subViewIndex, wxCoord viewHeight)
std::shared_ptr< const Track >	FindTrack () const override
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
bool	Clicked () const
DragChoice_t	DragChoice (const TrackPanelMouseEvent &event) const
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *) override
HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
Result	Cancel (AudacityProject *) 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< SubViewRearrangeHandle > &holder, WaveChannelView &view, WaveChannelSubView &subView, const TrackPanelMouseState &state)
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 Attributes
SubViewAdjuster	mAdjuster
std::vector< wxCoord >	mHeights
wxCoord	mTopY
size_t	mMySubView {}
wxCoord	mViewHeight {}

Additional Inherited Members
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 486 of file WaveChannelView.cpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
HotZoneWidth

Definition at line 490 of file WaveChannelView.cpp.

{ HotZoneWidth = 3 * kTrackInfoBtnSize / 2 };

DragChoice_t

enum SubViewRearrangeHandle::DragChoice_t

Enumerator
Upward
Downward
Neutral

Definition at line 573 of file WaveChannelView.cpp.

{ Upward, Downward, Neutral };

Constructor & Destructor Documentation

SubViewRearrangeHandle()

SubViewRearrangeHandle::SubViewRearrangeHandle ( SubViewAdjuster &&  adjuster, size_t  subViewIndex, wxCoord  viewHeight  )

inline

Definition at line 533 of file WaveChannelView.cpp.

      : mAdjuster{ std::move( adjuster ) }
      , mMySubView{ subViewIndex }
      , mViewHeight{ viewHeight }
   {
   }

Member Function Documentation

Cancel()

Result SubViewRearrangeHandle::Cancel ( AudacityProject *  )

inlineoverridevirtual

Implements UIHandle.

Definition at line 665 of file WaveChannelView.cpp.

   {
      mAdjuster.UpdateViews( true );
      return RefreshCode::RefreshAll;
   }

References mAdjuster, RefreshCode::RefreshAll, and SubViewAdjuster::UpdateViews().

Here is the call graph for this function:

Click()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 550 of file WaveChannelView.cpp.

   {
      using namespace RefreshCode;
      const auto &permutation = mAdjuster.mPermutation;
      const auto size = permutation.size();
      if ( mMySubView >= size )
         return Cancelled;
 
      mHeights = mAdjuster.ComputeHeights( mViewHeight );
 
      // Find y coordinate of first sub-view
      wxCoord heightAbove = 0;
      for (auto index = mAdjuster.mFirstSubView;
         index != mMySubView; ++index)
         heightAbove += mHeights[ index ];
      mTopY = event.rect.GetTop() - heightAbove;
 
      return RefreshNone;
   }

References Cancelled, SubViewAdjuster::ComputeHeights(), mAdjuster, SubViewAdjuster::mFirstSubView, mHeights, mMySubView, SubViewAdjuster::mPermutation, mTopY, mViewHeight, RefreshCode::RefreshNone, and size.

Here is the call graph for this function:

Clicked()

bool SubViewRearrangeHandle::Clicked ( ) const

inline

Definition at line 571 of file WaveChannelView.cpp.

{ return !mHeights.empty(); }

References mHeights.

Referenced by Preview().

Here is the caller graph for this function:

Drag()

Result SubViewRearrangeHandle::Drag ( const TrackPanelMouseEvent &  event, AudacityProject *    )

inlineoverridevirtual

Implements UIHandle.

Definition at line 606 of file WaveChannelView.cpp.

   {
      using namespace RefreshCode;
      auto pView = mAdjuster.mwView.lock();
      if ( !pView )
         return Cancelled;
 
      switch( DragChoice( event ) ) {
         case Upward:
         {
            std::swap( mHeights[ mMySubView ], mHeights[ mMySubView - 1 ] );
            std::swap(
               mAdjuster.mNewPlacements[ mMySubView ].index,
               mAdjuster.mNewPlacements[ mMySubView - 1 ].index
            );
            --mMySubView;
            break;
         }
         case Downward:
         {
            std::swap( mHeights[ mMySubView ], mHeights[ mMySubView + 1 ] );
            std::swap(
               mAdjuster.mNewPlacements[ mMySubView ].index,
               mAdjuster.mNewPlacements[ mMySubView + 1 ].index
            );
            ++mMySubView;
            break;
         }
         default:
            return RefreshNone;
      }
 
      // Save adjustment to the track and request a redraw
      mAdjuster.UpdateViews( false );
      return RefreshAll;
   }

References Cancelled, Downward, DragChoice(), mAdjuster, mHeights, mMySubView, SubViewAdjuster::mNewPlacements, SubViewAdjuster::mwView, RefreshCode::RefreshAll, RefreshCode::RefreshNone, anonymous_namespace{NoteTrack.cpp}::swap(), SubViewAdjuster::UpdateViews(), and Upward.

Here is the call graph for this function:

DragChoice()

DragChoice_t SubViewRearrangeHandle::DragChoice ( const TrackPanelMouseEvent &  event ) const

inline

Definition at line 575 of file WaveChannelView.cpp.

   {
      // Disregard x coordinate -- so the mouse need not be in any sub-view,
      // just in the correct range of y coordinates
      auto yy = event.event.GetY();
      auto coord = mTopY;
      size_t ii = mAdjuster.mFirstSubView;
      if ( yy < mTopY )
         return ( mMySubView == ii ) ? Neutral : Upward;
 
      for ( auto nn = mHeights.size(); ii < nn; ++ii ) {
         const auto height = mHeights[ ii ];
         coord += height;
         if ( yy < coord )
            break;
      }
 
      if ( ii < mMySubView ) {
         if ( yy < coord - mHeights[ ii ] + mHeights[ mMySubView ] )
            return Upward;
      }
 
      if ( ii > mMySubView ) {
         if( mMySubView < mHeights.size() - 1 &&
            yy >= coord - mHeights[ mMySubView ] )
         return Downward;
      }
 
      return Neutral;
   }

References Downward, mAdjuster, SubViewAdjuster::mFirstSubView, mHeights, mMySubView, mTopY, Neutral, and Upward.

Referenced by Drag().

Here is the caller graph for this function:

FindTrack()

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

inlineoverridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 542 of file WaveChannelView.cpp.

   {
      auto pView = mAdjuster.mwView.lock();
      if (pView)
         return TrackFromChannel(pView->FindChannel());
      return nullptr;
   }

References mAdjuster, SubViewAdjuster::mwView, and UIHandle::TrackFromChannel().

Here is the call graph for this function:

HitTest()

static UIHandlePtr SubViewRearrangeHandle::HitTest ( std::weak_ptr< SubViewRearrangeHandle > &  holder, WaveChannelView &  view, WaveChannelSubView &  subView, const TrackPanelMouseState &  state  )

inlinestatic

Definition at line 492 of file WaveChannelView.cpp.

   {
      if ( !view.GetMultiView() )
         return {};
 
      SubViewAdjuster adjuster{ view };
      if ( adjuster.NVisible() < 2 )
         return {};
 
      auto relX = state.state.GetX() - state.rect.GetLeft();
      if ( relX >= HotZoneWidth )
         return {};
 
      auto index = adjuster.FindIndex( subView );
 
      // Hit on the rearrange cursor only in the top and bottom thirds of
      // sub-view height, leaving the rest free to hit the selection cursor
      // first.
      // And also exclude the top third of the topmost sub-view and bottom
      // third of bottommost.
      auto relY = state.state.GetY() - state.rect.GetTop();
      auto height = state.rect.GetHeight();
      bool hit =
         ( ( 3 * relY < height ) && index > 0 ) // top hit
      ||
         ( ( 3 * relY > 2 * height ) &&
           index < adjuster.mPermutation.size() - 1 ) // bottom
      ;
      if ( ! hit )
         return {};
 
      auto result = std::make_shared< SubViewRearrangeHandle >(
         std::move( adjuster ),
         index, view.GetLastHeight()
      );
      result = AssignUIHandlePtr( holder, result );
      return result;
   }

References AssignUIHandlePtr(), WaveChannelView::GetLastHeight(), WaveChannelView::GetMultiView(), HotZoneWidth, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Referenced by WaveChannelSubView::DoDetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

Preview()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 643 of file WaveChannelView.cpp.

   {
      static auto hoverCursor =
         ::MakeCursor(wxCURSOR_HAND, RearrangeCursorXpm, 16, 16);
      static auto clickedCursor =
         ::MakeCursor(wxCURSOR_HAND, RearrangingCursorXpm, 16, 16);
      return {
         XO("Click and drag to rearrange sub-views"),
         Clicked() ? &*clickedCursor : &*hoverCursor,
         XO("Rearrange sub-views")
      };
   }

References Clicked(), MakeCursor(), and XO().

Here is the call graph for this function:

Release()

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

inlineoverridevirtual

Implements UIHandle.

Definition at line 657 of file WaveChannelView.cpp.

   {
      ProjectHistory::Get( *pProject ).ModifyState( false );
      return RefreshCode::RefreshNone;
   }

References ProjectHistory::Get(), ProjectHistory::ModifyState(), and RefreshCode::RefreshNone.

Here is the call graph for this function:

Member Data Documentation

mAdjuster

SubViewAdjuster SubViewRearrangeHandle::mAdjuster

private

Definition at line 673 of file WaveChannelView.cpp.

Referenced by Cancel(), Click(), Drag(), DragChoice(), and FindTrack().

mHeights

std::vector<wxCoord> SubViewRearrangeHandle::mHeights

private

Definition at line 674 of file WaveChannelView.cpp.

Referenced by Click(), Clicked(), Drag(), and DragChoice().

mMySubView

size_t SubViewRearrangeHandle::mMySubView {}

private

Definition at line 678 of file WaveChannelView.cpp.

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

mTopY

wxCoord SubViewRearrangeHandle::mTopY

private

Definition at line 675 of file WaveChannelView.cpp.

Referenced by Click(), and DragChoice().

mViewHeight

wxCoord SubViewRearrangeHandle::mViewHeight {}

private

Definition at line 680 of file WaveChannelView.cpp.

Referenced by Click().

---

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

• WaveChannelView.cpp