NoteTrackVZoomHandle Class Reference

#include <NoteTrackVZoomHandle.h>

Inheritance diagram for NoteTrackVZoomHandle:

Collaboration diagram for NoteTrackVZoomHandle:

Public Member Functions
	NoteTrackVZoomHandle (const std::shared_ptr< NoteTrack > &pTrack, const wxRect &rect, int y)
NoteTrackVZoomHandle &	operator= (const NoteTrackVZoomHandle &)=default
virtual	~NoteTrackVZoomHandle ()
std::shared_ptr< const Channel >	FindChannel () 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 Channel >	FindChannel () 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< NoteTrackVZoomHandle > &holder, const wxMouseState &state, const std::shared_ptr< NoteTrack > &pTrack, const wxRect &rect)
Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)
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
	NoteTrackVZoomHandle (const NoteTrackVZoomHandle &)
void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass) override
wxRect	DrawingArea (TrackPanelDrawingContext &, const wxRect &rect, const wxRect &panelRect, unsigned iPass) override

Static Private Member Functions
static HitTestPreview	HitPreview (const wxMouseState &state)

Private Attributes
std::weak_ptr< NoteTrack >	mpTrack
int	mZoomStart
int	mZoomEnd
wxRect	mRect

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 NoteTrackVZoomHandle.h.

Constructor & Destructor Documentation

NoteTrackVZoomHandle() [1/2]

NoteTrackVZoomHandle::NoteTrackVZoomHandle ( const NoteTrackVZoomHandle &  )

private

NoteTrackVZoomHandle() [2/2]

NoteTrackVZoomHandle::NoteTrackVZoomHandle ( const std::shared_ptr< NoteTrack > &  pTrack, const wxRect &  rect, int  y  )

explicit

Definition at line 54 of file NoteTrackVZoomHandle.cpp.

   : mpTrack{ pTrack } , mZoomStart(y), mZoomEnd(y), mRect(rect)
{
}

~NoteTrackVZoomHandle()

NoteTrackVZoomHandle::~NoteTrackVZoomHandle ( )

virtual

Definition at line 103 of file NoteTrackVZoomHandle.cpp.

{
}

Member Function Documentation

Cancel()

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

overridevirtual

Implements UIHandle.

Definition at line 364 of file NoteTrackVZoomHandle.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 NoteTrackVZoomHandle::Click ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Implements UIHandle.

Definition at line 117 of file NoteTrackVZoomHandle.cpp.

{
   // change note track to zoom like audio track
   //          mpTrack->StartVScroll();
 
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

Drag()

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

overridevirtual

Implements UIHandle.

Definition at line 126 of file NoteTrackVZoomHandle.cpp.

{
   using namespace RefreshCode;
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   if (!pTrack)
      return Cancelled;
 
   const wxMouseEvent &event = evt.event;
   mZoomEnd = event.m_y;
   if (IsDragZooming(mZoomStart, mZoomEnd)) {
      // changed Note track to work like audio track
      //         pTrack->VScroll(mZoomStart, mZoomEnd);
      return RefreshAll;
   }
   return RefreshNone;
}

References Cancelled, TrackPanelMouseEvent::event, TrackList::Get(), anonymous_namespace{NoteTrackVZoomHandle.cpp}::IsDragZooming(), TrackList::Lock(), mpTrack, mZoomEnd, mZoomStart, RefreshCode::RefreshAll, and RefreshCode::RefreshNone.

Here is the call graph for this function:

Draw()

void NoteTrackVZoomHandle::Draw ( TrackPanelDrawingContext &  context, const wxRect &  rect, unsigned  iPass  )

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 371 of file NoteTrackVZoomHandle.cpp.

{
   if ( iPass == TrackArtist::PassZooming ) {
      if (!mpTrack.lock()) //? TrackList::Lock()
         return;
      
      if ( IsDragZooming( mZoomStart, mZoomEnd ) )
         ChannelVRulerControls::DrawZooming(
            context, rect, mZoomStart, mZoomEnd);
   }
}

References ChannelVRulerControls::DrawZooming(), anonymous_namespace{NoteTrackVZoomHandle.cpp}::IsDragZooming(), mpTrack, mZoomEnd, mZoomStart, and TrackArtist::PassZooming.

Here is the call graph for this function:

DrawingArea()

wxRect NoteTrackVZoomHandle::DrawingArea ( TrackPanelDrawingContext &  , const wxRect &  rect, const wxRect &  panelRect, unsigned  iPass  )

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 385 of file NoteTrackVZoomHandle.cpp.

{
   if ( iPass == TrackArtist::PassZooming )
      return ChannelVRulerControls::ZoomingArea(rect, panelRect);
   else
      return rect;
}

References TrackArtist::PassZooming, and ChannelVRulerControls::ZoomingArea().

Here is the call graph for this function:

Enter()

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

overridevirtual

Reimplemented from UIHandle.

Definition at line 60 of file NoteTrackVZoomHandle.cpp.

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

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

FindChannel()

std::shared_ptr< const Channel > NoteTrackVZoomHandle::FindChannel ( ) const

overridevirtual

Returns

pointer to associated channel, if any

Implements UIHandle.

Definition at line 107 of file NoteTrackVZoomHandle.cpp.

{
   return mpTrack.lock();
}

References mpTrack.

HandlesRightClick()

bool NoteTrackVZoomHandle::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 112 of file NoteTrackVZoomHandle.cpp.

{
   return true;
}

HitPreview()

HitTestPreview NoteTrackVZoomHandle::HitPreview ( const wxMouseState &  state )

staticprivate

Definition at line 67 of file NoteTrackVZoomHandle.cpp.

{
   static auto zoomInCursor =
      ::MakeCursor(wxCURSOR_MAGNIFIER, ZoomInCursorXpm, 19, 15);
   static auto zoomOutCursor =
      ::MakeCursor(wxCURSOR_MAGNIFIER, ZoomOutCursorXpm, 19, 15);
   static  wxCursor arrowCursor{ wxCURSOR_ARROW };
 
   bool bVZoom;
   gPrefs->Read(wxT("/GUI/VerticalZooming"), &bVZoom, false);
   bVZoom &= !state.RightIsDown();
   const auto message = bVZoom ? 
      XO("Click to vertically zoom in. Shift-click to zoom out. Drag to specify a zoom region.") :
      XO("Right-click for menu.");
 
   return {
      message,
      bVZoom ? (state.ShiftDown() ? &*zoomOutCursor : &*zoomInCursor) : &arrowCursor
      // , message
   };
}

References bVZoom, gPrefs, MakeCursor(), audacity::BasicSettings::Read(), wxT(), and XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

HitTest()

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

static

Definition at line 89 of file NoteTrackVZoomHandle.cpp.

{
   if (pTrack) {
      auto result = std::make_shared<NoteTrackVZoomHandle>(
         pTrack, rect, state.m_y);
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
   return {};
}

References AssignUIHandlePtr().

Referenced by NoteTrackVRulerControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

NoteTrackVZoomHandle & NoteTrackVZoomHandle::operator= ( const NoteTrackVZoomHandle &  )

default

Preview()

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

overridevirtual

Implements UIHandle.

Definition at line 144 of file NoteTrackVZoomHandle.cpp.

{
   return HitPreview(st.state);
}

References HitPreview(), and TrackPanelMouseState::state.

Here is the call graph for this function:

Release()

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

overridevirtual

Implements UIHandle.

Definition at line 295 of file NoteTrackVZoomHandle.cpp.

{
   using namespace RefreshCode;
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   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()))
   {
      InitMenuData data {
         *pProject, pTrack.get(), mRect, RefreshNone, event.m_y
      };
 
      PopupMenuTable *const pTable =
          (PopupMenuTable *) &NoteTrackVRulerMenuTable::Instance();
      auto pMenu = PopupMenuTable::BuildMenu(pTable, &data);
 
      pMenu->Popup( *pParent, { event.m_x, event.m_y } );
 
      return data.result;
   }
 
   bool bVZoom;
   gPrefs->Read(wxT("/GUI/VerticalZooming"), &bVZoom, false);
   bVZoom &= event.GetId() != kCaptureLostEventId;
   if( !bVZoom )
      return RefreshAll;
 
   NoteTrackDisplayData data{ *pTrack, evt.rect };
   if (IsDragZooming(mZoomStart, mZoomEnd)) {
      data.ZoomTo(mZoomStart, mZoomEnd);
   }
   else if (event.ShiftDown() || event.RightUp()) {
      if (event.ShiftDown() && event.RightUp()) {
         auto &data = NoteTrackRange::Get(*pTrack);
         auto oldBotNote = data.GetBottomNote();
         auto oldTopNote = data.GetTopNote();
         // Zoom out to show all notes
         data.ZoomAllNotes(&pTrack->GetSeq());
         if (data.GetBottomNote() == oldBotNote &&
               data.GetTopNote() == oldTopNote) {
            // However if we are already showing all notes, zoom out further
            data.ZoomMaxExtent();
         }
      } else {
         // Zoom out
         data.ZoomOut(mZoomEnd);
      }
   }
   else {
      data.ZoomIn(mZoomEnd);
   }
 
   mZoomEnd = mZoomStart = 0;
   ProjectHistory::Get( *pProject ).ModifyState(false);
 
   return RefreshAll;
}

References PopupMenuTable::BuildMenu(), bVZoom, ProjectHistory::Get(), TrackList::Get(), NoteTrackRange::Get(), gPrefs, NoteTrackVRulerMenuTable::Instance(), anonymous_namespace{NoteTrackVZoomHandle.cpp}::IsDragZooming(), kCaptureLostEventId, TrackList::Lock(), ProjectHistory::ModifyState(), audacity::BasicSettings::Read(), RefreshCode::RefreshAll, RefreshCode::RefreshNone, wxT(), and NoteTrackDisplayData::ZoomTo().

Here is the call graph for this function:

Member Data Documentation

mpTrack

std::weak_ptr<NoteTrack> NoteTrackVZoomHandle::mpTrack

private

Definition at line 69 of file NoteTrackVZoomHandle.h.

Referenced by Drag(), Draw(), and FindChannel().

mRect

wxRect NoteTrackVZoomHandle::mRect

private

Definition at line 72 of file NoteTrackVZoomHandle.h.

mZoomEnd

int NoteTrackVZoomHandle::mZoomEnd

private

Definition at line 71 of file NoteTrackVZoomHandle.h.

Referenced by Drag(), and Draw().

mZoomStart

int NoteTrackVZoomHandle::mZoomStart

private

Definition at line 71 of file NoteTrackVZoomHandle.h.

Referenced by Drag(), and Draw().

---

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

• NoteTrackVZoomHandle.h
• NoteTrackVZoomHandle.cpp