WaveChannelVZoomHandle Namespace Reference

Typedefs
using	Result = unsigned
using	DoZoomFunction = void(*)(AudacityProject *pProject, WaveChannel &wc, WaveChannelViewConstants::ZoomActions ZoomKind, const wxRect &rect, int zoomStart, int zoomEnd, bool fixedMousePoint)

Functions
AUDACITY_DLL_API HitTestPreview	HitPreview (const bool bVZoom)
AUDACITY_DLL_API bool	IsDragZooming (int zoomStart, int zoomEnd, bool hasDragZoom)
AUDACITY_DLL_API Result	DoDrag (const TrackPanelMouseEvent &event, AudacityProject *pProject, int zoomStart, int &zoomEnd, bool hasDragZoom)
AUDACITY_DLL_API Result	DoRelease (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent, WaveChannel &wc, const wxRect &mRect, DoZoomFunction doZoom, PopupMenuTable &table, int zoomStart, int zoomEnd)
AUDACITY_DLL_API void	DoDraw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass, int zoomStart, int zoomEnd, bool hasDragZoom)
AUDACITY_DLL_API wxRect	DoDrawingArea (const wxRect &rect, const wxRect &panelRect, unsigned iPass)

Typedef Documentation

DoZoomFunction

using WaveChannelVZoomHandle::DoZoomFunction = typedef void (*)(AudacityProject *pProject, WaveChannel &wc, WaveChannelViewConstants::ZoomActions ZoomKind, const wxRect &rect, int zoomStart, int zoomEnd, bool fixedMousePoint)

Definition at line 33 of file WaveChannelVZoomHandle.h.

Result

using WaveChannelVZoomHandle::Result = typedef unsigned

Definition at line 25 of file WaveChannelVZoomHandle.h.

Function Documentation

DoDrag()

UIHandle::Result WaveChannelVZoomHandle::DoDrag	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		int	zoomStart,
		int &	zoomEnd,
		bool	hasDragZoom
	)

Definition at line 74 of file WaveChannelVZoomHandle.cpp.

{
   using namespace RefreshCode;
 
   const wxMouseEvent &event = evt.event;
   if ( event.RightIsDown() )
      return RefreshNone;
   zoomEnd = event.m_y;
   if (IsDragZooming( zoomStart, zoomEnd, hasDragZooming))
      return RefreshAll;
   return RefreshNone;
}

References TrackPanelMouseEvent::event, anonymous_namespace{NoteTrackVZoomHandle.cpp}::IsDragZooming(), RefreshCode::RefreshAll, and RefreshCode::RefreshNone.

Referenced by SpectrumVZoomHandle::Drag(), and WaveformVZoomHandle::Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

DoDraw()

void WaveChannelVZoomHandle::DoDraw	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		unsigned	iPass,
		int	zoomStart,
		int	zoomEnd,
		bool	hasDragZoom
	)

Definition at line 130 of file WaveChannelVZoomHandle.cpp.

{
   if (iPass == TrackArtist::PassZooming) {
      if (IsDragZooming(zoomStart, zoomEnd, hasDragZoom))
         ChannelVRulerControls::DrawZooming(context, rect, zoomStart, zoomEnd);
   }
}

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

Referenced by SpectrumVZoomHandle::Draw(), and WaveformVZoomHandle::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DoDrawingArea()

wxRect WaveChannelVZoomHandle::DoDrawingArea	(	const wxRect &	rect,
		const wxRect &	panelRect,
		unsigned	iPass
	)

Definition at line 140 of file WaveChannelVZoomHandle.cpp.

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

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

Referenced by SpectrumVZoomHandle::DrawingArea(), and WaveformVZoomHandle::DrawingArea().

Here is the call graph for this function:

Here is the caller graph for this function:

DoRelease()

UIHandle::Result WaveChannelVZoomHandle::DoRelease	(	const TrackPanelMouseEvent &	event,
		AudacityProject *	pProject,
		wxWindow *	pParent,
		WaveChannel &	wc,
		const wxRect &	mRect,
		DoZoomFunction	doZoom,
		PopupMenuTable &	table,
		int	zoomStart,
		int	zoomEnd
	)

Definition at line 89 of file WaveChannelVZoomHandle.cpp.

{
   using namespace RefreshCode;
   const wxMouseEvent &event = evt.event;
   const bool shiftDown = event.ShiftDown();
   const bool rightUp = event.RightUp();
 
 
   // Popup menu...
   using namespace WaveChannelViewConstants;
   if (
       rightUp &&
       !(event.ShiftDown() || event.CmdDown()))
   {
      WaveChannelVRulerMenuTable::InitMenuData data {
         *pProject,
         wc, rect, RefreshCode::RefreshNone, event.m_y, doZoom };
 
      auto pMenu = PopupMenuTable::BuildMenu( &table, &data );
      pMenu->Popup( *pParent, { event.m_x, event.m_y } );
 
      return data.result;
   }
   else {
      // Ignore Capture Lost event 
      bool notLost = event.GetId() != kCaptureLostEventId;
      // Shift+rightclick to reset zoom
      if( shiftDown && notLost)
         zoomStart = zoomEnd;
      doZoom(pProject, wc, kZoom1to1,
         rect, zoomStart, zoomEnd, !shiftDown);
      
   }
 
   return UpdateVRuler | RefreshAll;
}

References PopupMenuTable::BuildMenu(), TrackPanelMouseEvent::event, kCaptureLostEventId, WaveChannelViewConstants::kZoom1to1, RefreshCode::RefreshAll, RefreshCode::RefreshNone, and RefreshCode::UpdateVRuler.

Referenced by SpectrumVZoomHandle::Release(), and WaveformVZoomHandle::Release().

Here is the call graph for this function:

Here is the caller graph for this function:

HitPreview()

HitTestPreview WaveChannelVZoomHandle::HitPreview

(

const bool

bVZoom

)

Definition at line 59 of file WaveChannelVZoomHandle.cpp.

{
   static wxCursor crossCursor{wxCURSOR_CROSS};
   static  wxCursor arrowCursor{ wxCURSOR_ARROW };
   const auto message = bVZoom ? 
      XO("Drag to specify a zoom region. Right-click for menu. Ctrl+scroll to zoom.") :
      XO("Right-click for menu. Ctrl+scroll to zoom.");
 
   return {
      message,
      bVZoom ? &crossCursor : &arrowCursor
      // , message
   };
}

References bVZoom, and XO().

Referenced by SpectrumVZoomHandle::Preview(), and WaveformVZoomHandle::Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

IsDragZooming()

bool WaveChannelVZoomHandle::IsDragZooming	(	int	zoomStart,
		int	zoomEnd,
		bool	hasDragZoom
	)

Definition at line 24 of file WaveChannelVZoomHandle.cpp.

{
   const int DragThreshold = 3;// Anything over 3 pixels is a drag, else a click.
   return hasDragZoom && (abs(zoomEnd - zoomStart) > DragThreshold);
}

References DragThreshold.

Referenced by SpectrumVZoomHandle::DoZoom().

Here is the caller graph for this function: