#include <ChannelVRulerControls.h>

Inheritance diagram for ChannelVRulerControls:

Collaboration diagram for ChannelVRulerControls:

Public Member Functions
	ChannelVRulerControls (const std::shared_ptr< ChannelView > &pChannelView)

virtual	~ChannelVRulerControls ()=0

std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject) override

virtual void	UpdateRuler (const wxRect &rect)=0

std::shared_ptr< const ChannelView >	GetChannelView () const

Public Member Functions inherited from CommonChannelCell
	CommonChannelCell (const std::shared_ptr< Channel > &pChannel)
	Construct from a channel. More...

	~CommonChannelCell ()

std::shared_ptr< Track >	DoFindTrack () override

void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...

template<typename Subtype = Channel>
auto	FindChannel () -> std::shared_ptr< Subtype >
	May return null. More...

template<typename Subtype = const Channel>
auto	FindChannel () const -> std::enable_if_t< std::is_const_v< Subtype >, std::shared_ptr< Subtype > >
	May return null. More...

Public Member Functions inherited from CommonTrackPanelCell
	CommonTrackPanelCell ()

virtual	~CommonTrackPanelCell ()=0

HitTestPreview	DefaultPreview (const TrackPanelMouseState &, const AudacityProject *) override

std::shared_ptr< Track >	FindTrack ()

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

virtual std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint pPosition, AudacityProject pProject)
	Return a list of items for DoContextMenu() (empties for separators) More...

Public Member Functions inherited from TrackPanelCell
	TrackPanelCell ()=default

	TrackPanelCell (const TrackPanelCell &)=delete

TrackPanelCell &	operator= (const TrackPanelCell &)=delete

virtual	~TrackPanelCell ()=0

virtual HitTestPreview	DefaultPreview (const TrackPanelMouseState &state, const AudacityProject *pProject)

virtual std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject)=0

virtual unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject)

virtual std::shared_ptr< TrackPanelCell >	ContextMenuDelegate ()

virtual unsigned	DoContextMenu (const wxRect &rect, wxWindow pParent, const wxPoint pPosition, AudacityProject *pProject)

virtual unsigned	CaptureKey (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	KeyDown (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	KeyUp (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	Char (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow pParent, AudacityProject project)

virtual unsigned	LoseFocus (AudacityProject *project)

Public Member Functions inherited from TrackPanelNode
	TrackPanelNode ()

virtual	~TrackPanelNode ()=0

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)

Public Member Functions inherited from ChannelAttachment
virtual	~ChannelAttachment ()

virtual void	CopyTo (Track &track, size_t iChannel) const
	Copy state, for undo/redo purposes. More...

virtual void	Reparent (const std::shared_ptr< Track > &parent, size_t iChannel)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...

virtual void	WriteXMLAttributes (XMLWriter &writer, size_t iChannel) const
	Serialize persistent attributes. More...

virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView, size_t iChannel)
	Deserialize an attribute, returning true if recognized. More...

Static Public Member Functions
static ChannelVRulerControls &	Get (ChannelView &)

static const ChannelVRulerControls &	Get (const ChannelView &)

static void	DrawZooming (TrackPanelDrawingContext &context, const wxRect &rect, int zoomStart, int zoomEnd)

static wxRect	ZoomingArea (const wxRect &rect, const wxRect &panelRect)

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 Member Functions
std::shared_ptr< Track >	DoFindTrack () override

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

Track *	GetTrack () const

Protected Member Functions inherited from CommonTrackPanelCell
virtual std::shared_ptr< Track >	DoFindTrack ()=0

unsigned	DoContextMenu (const wxRect &rect, wxWindow pParent, const wxPoint pPosition, AudacityProject *pProject) override

unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject) override

Protected Attributes
std::weak_ptr< ChannelView >	mwChannelView

Detailed Description

Definition at line 22 of file ChannelVRulerControls.h.

Constructor & Destructor Documentation

◆ ChannelVRulerControls()

ChannelVRulerControls::ChannelVRulerControls ( const std::shared_ptr< ChannelView > & pChannelView )

explicit

Definition at line 26 of file ChannelVRulerControls.cpp.

  : CommonChannelCell{ pChannelView->FindChannel() }
  , mwChannelView{ pChannelView }
{
}

◆ ~ChannelVRulerControls()

ChannelVRulerControls::~ChannelVRulerControls ( )

pure virtual

Definition at line 33 of file ChannelVRulerControls.cpp.

34{

35}

Member Function Documentation

◆ DoFindTrack()

std::shared_ptr< Track > ChannelVRulerControls::DoFindTrack ( )

overrideprotectedvirtual

Implements CommonTrackPanelCell.

Definition at line 48 of file ChannelVRulerControls.cpp.

{
   // Just pass-through to related ChannelView object
   const auto pView = mwChannelView.lock();
   if (pView)
      return pView->DoFindTrack();
   return {};
}

References mwChannelView.

◆ DrawingArea()

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

overrideprotectedvirtual

Reimplemented from TrackPanelDrawable.

Definition at line 100 of file ChannelVRulerControls.cpp.

{
   // Common area change for all subclasses when drawing the controls
   // A bevel extends below one pixel outside of the hit-test area
   if (iPass == TrackArtist::PassControls)
      return { rect.x, rect.y, rect.width, rect.height + 1 };
   else
      return rect;
}

References TrackArtist::PassControls.

◆ DrawZooming()

void ChannelVRulerControls::DrawZooming	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		int	zoomStart,
		int	zoomEnd
	)

static

Definition at line 63 of file ChannelVRulerControls.cpp.

{
   // Draw a dashed rectangle, its right side disappearing in the black right
   // border of the track area, which is not part of this cell but right of it.
   auto &dc = context.dc;
 
   dc.SetBrush(*wxTRANSPARENT_BRUSH);
   dc.SetPen(*wxBLACK_DASHED_PEN);
 
   wxRect rect {
      rect_.x,
      std::min( zoomStart, zoomEnd),
      rect_.width,
      1 + abs( zoomEnd - zoomStart)
   };
 
   dc.DrawRectangle(rect);
}

References TrackPanelDrawingContext::dc, and min().

Referenced by WaveChannelVZoomHandle::DoDraw(), and NoteTrackVZoomHandle::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

ChannelVRulerControls & ChannelVRulerControls::Get ( ChannelView & trackView )

static

Definition at line 37 of file ChannelVRulerControls.cpp.

{
   return *trackView.GetVRulerControls();
}

References ChannelView::GetVRulerControls().

Referenced by anonymous_namespace{TrackPanel.cpp}::VRulerAndChannel::Children(), and TrackPanel::UpdateTrackVRuler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

const ChannelVRulerControls & ChannelVRulerControls::Get ( const ChannelView & trackView )

static

Definition at line 42 of file ChannelVRulerControls.cpp.

{
   return *trackView.GetVRulerControls();
}

References ChannelView::GetVRulerControls().

Here is the call graph for this function:

◆ GetChannelView()

std::shared_ptr< const ChannelView > ChannelVRulerControls::GetChannelView ( ) const

inline

Definition at line 50 of file ChannelVRulerControls.h.

   {
      return mwChannelView.lock();
   }

◆ GetTrack()

Track * ChannelVRulerControls::GetTrack ( ) const

protected

◆ HitTest()

std::vector< UIHandlePtr > ChannelVRulerControls::HitTest	(	const TrackPanelMouseState &	state,
		const AudacityProject *	pProject
	)

overridevirtual

Implements TrackPanelCell.

Definition at line 57 of file ChannelVRulerControls.cpp.

{
   return std::vector<UIHandlePtr>{};
}

Referenced by SpectrumVRulerControls::HitTest(), WaveformVRulerControls::HitTest(), TimeTrackVRulerControls::HitTest(), and NoteTrackVRulerControls::HitTest().

Here is the caller graph for this function:

◆ UpdateRuler()

virtual void ChannelVRulerControls::UpdateRuler ( const wxRect & rect )

pure virtual

Implemented in LabelTrackVRulerControls, NoteTrackVRulerControls, SpectrumVRulerControls, WaveformVRulerControls, and TimeTrackVRulerControls.

Referenced by WaveChannelVRulerControls::DoDraw(), and TrackPanel::UpdateTrackVRuler().

Here is the caller graph for this function:

◆ ZoomingArea()

wxRect ChannelVRulerControls::ZoomingArea	(	const wxRect &	rect,
		const wxRect &	panelRect
	)

static

Definition at line 84 of file ChannelVRulerControls.cpp.

{
   // TODO: Don't use the constant kRightMargin, but somehow discover the
   // neighboring track rectangle
   return {
      // Left edge of the rectangle disappears in the vertical line at
      // left edge of the ruler
      rect.x,
      rect.y,
      // Extend the dashed rectangle right up to the track border
      (panelRect.width - kRightMargin + kBorderThickness) - rect.x,
      rect.height
   };
}

References kBorderThickness, and kRightMargin.

Referenced by WaveChannelVZoomHandle::DoDrawingArea(), and NoteTrackVZoomHandle::DrawingArea().

Here is the caller graph for this function:

Member Data Documentation

◆ mwChannelView

std::weak_ptr<ChannelView> ChannelVRulerControls::mwChannelView

protected

Definition at line 64 of file ChannelVRulerControls.h.

Referenced by DoFindTrack().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ChannelVRulerControls()

◆ ~ChannelVRulerControls()

Member Function Documentation

◆ DoFindTrack()

◆ DrawingArea()

◆ DrawZooming()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetChannelView()

◆ GetTrack()

◆ HitTest()

◆ UpdateRuler()

◆ ZoomingArea()

Member Data Documentation

◆ mwChannelView