#include <WaveChannelView.h>

Inheritance diagram for WaveChannelView:

Collaboration diagram for WaveChannelView:

Public Types
using	Display = WaveChannelViewConstants::Display

Public Types inherited from ChannelView
enum	: unsigned { DefaultHeight = 150 }

using	Refinement = std::vector< std::pair< wxCoord, std::shared_ptr< ChannelView > > >

Public Types inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
using	DataType = ClientData

using	DataPointer = Pointer< ClientData >

using	DataFactory = std::function< DataPointer(Host &) >
	Type of function from which RegisteredFactory is constructed; it builds attachments. More...

Public Member Functions
	~WaveChannelView () override

std::shared_ptr< WaveChannel >	FindWaveChannel ()

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

std::shared_ptr< ChannelVRulerControls >	DoGetVRulerControls () 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...

std::vector< WaveChannelSubView::Type >	GetDisplays () const

void	SetDisplay (Display display, bool exclusive=true)

const WaveChannelSubViewPlacements &	SavePlacements () const

void	RestorePlacements (const WaveChannelSubViewPlacements &placements)

bool	ToggleSubView (Display id)

std::vector< std::shared_ptr< WaveChannelSubView > >	GetAllSubViews ()

wxCoord	GetLastHeight () const

bool	GetMultiView () const

void	SetMultiView (bool value)

WaveTrack::IntervalHolder	GetSelectedClip ()

Refinement	GetSubViews (const wxRect *rect=nullptr)

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

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

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

unsigned	LoseFocus (AudacityProject *project) override

bool	CutSelectedText (AudacityProject &project)

bool	CopySelectedText (AudacityProject &project)

bool	PasteText (AudacityProject &project)

bool	SelectAllText (AudacityProject &project)

std::shared_ptr< CommonTrackCell >	GetAffordanceControls () override

Public Member Functions inherited from CommonChannelView
std::shared_ptr< TrackPanelCell >	ContextMenuDelegate () override

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

void	TimeShiftHitTest ()

virtual int	GetMinimizedHeight () const override

	ChannelView (const std::shared_ptr< Channel > &pChannel)

Public Member Functions inherited from ChannelView
	ChannelView (const std::shared_ptr< Channel > &pChannel)

virtual	~ChannelView ()=0

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

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

bool	GetMinimized () const

void	SetMinimized (bool minimized)

int	GetCumulativeHeightBefore () const

int	GetExpandedHeight () const

virtual int	GetMinimizedHeight () const =0

int	GetHeight () const

void	SetCumulativeHeightBefore (int y)
	Set cached value dependent on position within the track list. More...

void	SetExpandedHeight (int height)

std::shared_ptr< ChannelVRulerControls >	GetVRulerControls ()

std::shared_ptr< const ChannelVRulerControls >	GetVRulerControls () const

virtual std::shared_ptr< CommonTrackCell >	GetAffordanceControls ()

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

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

virtual Refinement	GetSubViews (const wxRect &rect)

virtual bool	IsSpectral () const

virtual void	DoSetMinimized (bool isMinimized)

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

Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
	~Site ()

	Site ()

	Site (const Site &other)

Site &	operator= (const Site &other)

	Site (Site &&other)

Site &	operator= (Site &&other)

size_t	size () const
	How many attachment pointers are in the Site. More...

template<typename Subclass = ClientData>
Subclass &	Get (const RegisteredFactory &key)
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

template<typename Subclass = const ClientData>
auto	Get (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass & >
	Get reference to an attachment, creating on demand if not present, down-cast it to Subclass. More...

template<typename Subclass = ClientData>
Subclass *	Find (const RegisteredFactory &key)
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

template<typename Subclass = const ClientData>
auto	Find (const RegisteredFactory &key) const -> std::enable_if_t< std::is_const< Subclass >::value, Subclass * >
	Get a (bare) pointer to an attachment, or null, down-cast it to Subclass *; will not create on demand. More...

template<typename ReplacementPointer >
void	Assign (const RegisteredFactory &key, ReplacementPointer &&replacement)
	Reassign Site's pointer to ClientData. More...

Static Public Member Functions
static WaveChannelView &	Get (WaveChannel &channel)

static const WaveChannelView &	Get (const WaveChannel &channel)

static WaveChannelView *	Find (WaveChannel *pChannel)

static const WaveChannelView *	Find (const WaveChannel *pChannel)

static WaveChannelView &	GetFirst (WaveTrack &wt)
	Get the view of the first channel. More...

static const WaveChannelView &	GetFirst (const WaveTrack &wt)
	Get the view of the first channel. More...

static WaveChannelView *	FindFirst (WaveTrack *pWt)
	If pWt is not null, return a pointer to the view of the first channel. More...

static const WaveChannelView *	FindFirst (const WaveTrack *pWt)
	If pWt is not null, return a pointer to the view of the first channel. More...

static std::pair< bool, std::vector< UIHandlePtr > >	DoDetailedHitTest (const TrackPanelMouseState &state, const AudacityProject *pProject, int currentTool, bool bMultiTool, const std::shared_ptr< WaveChannel > &wt, CommonChannelView &view)

static bool	ClipDetailsVisible (const ClipTimes &clip, const ZoomInfo &zoomInfo, const wxRect &viewRect)

static wxRect	ClipHitTestArea (const ClipTimes &clip, const ZoomInfo &zoomInfo, const wxRect &viewRect)

static bool	HitTest (const ClipTimes &clip, const ZoomInfo &zoomInfo, const wxRect &rect, const wxPoint &pos)

Static Public Member Functions inherited from CommonChannelView
static void	GetEnvelopeValues (const Envelope &env, double aligned_time, double sampleDur, double *buffer, int bufferLen, int leftOffset, const ZoomInfo &zoomInfo)
	Get many envelope points for pixel columns at once, but don't assume uniform time per pixel. More...

Static Public Member Functions inherited from ChannelView
static ChannelView &	Get (Channel &channel)

static const ChannelView &	Get (const Channel &channel)

static ChannelView *	Find (Channel *pChannel)

static const ChannelView *	Find (const Channel *pChannel)

static int	GetChannelGroupHeight (const Track *pTrack)

static int	GetCumulativeHeight (const Channel *pChannel)

static int	GetCumulativeHeight (const Track *pTrack)

static int	GetTotalHeight (const TrackList &list)

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)

Static Public Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
static size_t	numFactories ()
	How many static factories have been registered with this specialization of Site. More...

Static Public Attributes
static constexpr int	kChannelSeparatorThickness { 8 }

Private Member Functions
	WaveChannelView (const WaveChannelView &)=delete

WaveChannelView &	operator= (const WaveChannelView &)=delete

void	BuildSubViews () const

void	DoSetDisplay (Display display, bool exclusive=true)

bool	SelectNextClip (ViewInfo &viewInfo, AudacityProject *project, bool forward)

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

std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &state, const AudacityProject *pProject, int currentTool, bool bMultiTool) override

Refinement	GetSubViews (const wxRect &rect) override

void	DoSetMinimized (bool minimized) override

WaveChannelSubViewPlacements &	DoGetPlacements ()

const WaveChannelSubViewPlacements &	DoGetPlacements () const

bool &	DoGetMultiView ()

bool	DoGetMultiView () const

std::shared_ptr< CommonTrackCell >	DoGetAffordance (Track &track)

Private Attributes
wxCoord	mLastHeight {}

std::shared_ptr< CommonTrackCell >	mpAffordanceCellControl

std::weak_ptr< TrackPanelCell >	mKeyEventDelegate

std::weak_ptr< WaveTrackAffordanceHandle >	mAffordanceHandle

Additional Inherited Members
Public Attributes inherited from CommonChannelView
std::weak_ptr< TimeShiftHandle >	mTimeShiftHandle

Public Attributes inherited from ChannelView
std::pair< int, int >	vrulerSize

virtual std::vector< UIHandlePtr >	DetailedHitTest (const TrackPanelMouseState &, const AudacityProject *pProject, int currentTool, bool bMultiTool)=0

virtual std::shared_ptr< ChannelVRulerControls >	DoGetVRulerControls ()=0

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 Member Functions inherited from ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >
template<typename Function >
void	ForEach (const Function &function)
	Invoke function on each ClientData object that has been created in `this`. More...

template<typename Function >
void	ForEach (const Function &function) const
	Invoke function on each ClientData object that has been created in `this`. More...

template<typename Function >
void	ForCorresponding (Site &other, const Function &function, bool create=true)

template<typename Function >
ClientData *	FindIf (const Function &function)
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

template<typename Function >
const ClientData *	FindIf (const Function &function) const
	Return pointer to first attachment in `this` that is not null and satisfies a predicate, or nullptr. More...

template<typename Function >
void	EraseIf (const Function &function)
	Erase attached objects satisfying a predicate. More...

void	BuildAll ()
	For each RegisteredFactory, if the corresponding attachment is absent in `this`, build and store it. More...

Protected Attributes inherited from CommonChannelView
std::weak_ptr< SelectHandle >	mSelectHandle

Protected Attributes inherited from ChannelView
std::shared_ptr< ChannelVRulerControls >	mpVRulerControls

Detailed Description

Definition at line 97 of file WaveChannelView.h.

Member Typedef Documentation

◆ Display

using WaveChannelView::Display = WaveChannelViewConstants::Display

Definition at line 107 of file WaveChannelView.h.

Constructor & Destructor Documentation

◆ WaveChannelView()

WaveChannelView::WaveChannelView ( const WaveChannelView & )

privatedelete

◆ ~WaveChannelView()

WaveChannelView::~WaveChannelView ( )

override

Definition at line 970 of file WaveChannelView.cpp.

971{

972}

Member Function Documentation

◆ BuildSubViews()

void WaveChannelView::BuildSubViews ( ) const

private

Definition at line 1609 of file WaveChannelView.cpp.

{
   if (WaveChannelSubViews::size() == 0) {
      // On-demand steps that can't happen in the constructor
      auto pThis = const_cast<WaveChannelView*>(this);
      pThis->BuildAll();
      bool minimized = GetMinimized();
      pThis->WaveChannelSubViews::ForEach([&](WaveChannelSubView &subView){
         subView.DoSetMinimized(minimized);
      });
 
      auto &placements = pThis->DoGetPlacements();
      if (placements.empty()) {
         placements.resize(WaveChannelSubViews::size());
 
         auto display = TracksPrefs::ViewModeChoice();
         bool multi = (display == WaveChannelViewConstants::MultiView);
         if (multi) {
            pThis->SetMultiView( true );
            display = WaveChannelSubViewType::Default();
         }
 
         pThis->DoSetDisplay( display, !multi );
      }
   }
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::BuildAll(), WaveChannelSubViewType::Default(), ChannelView::DoSetMinimized(), ChannelView::GetMinimized(), WaveChannelViewConstants::MultiView, ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), and TracksPrefs::ViewModeChoice().

Referenced by DoSetMinimized(), GetAllSubViews(), GetDisplays(), and SetDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureKey()

unsigned WaveChannelView::CaptureKey	(	wxKeyEvent &	event,
		ViewInfo &	viewInfo,
		wxWindow *	pParent,
		AudacityProject *	project
	)

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 1339 of file WaveChannelView.cpp.

{
   unsigned result{ RefreshCode::RefreshNone };
   const auto pChannel = FindWaveChannel();
   if (!pChannel)
      return result;
   auto &track = pChannel->GetTrack();
   for (auto pChannel : track.Channels()) {
      event.Skip(false);
      auto &waveChannelView = WaveChannelView::Get(*pChannel);
      // Give sub-views first chance to handle the event
      for (auto &subView : waveChannelView.GetSubViews()) {
         // Event defaults in skipped state which must be turned off explicitly
         wxASSERT(!event.GetSkipped());
         result |= subView.second->CaptureKey(event, viewInfo, pParent, project);
         if (!event.GetSkipped()) {
            // sub view wants it
            mKeyEventDelegate = subView.second;
            return result;
         }
         else
            event.Skip(false);
      }
 
      if (auto affordance = waveChannelView.GetAffordanceControls()) {
         result |= affordance->CaptureKey(event, viewInfo, pParent, project);
         if (!event.GetSkipped()) {
            mKeyEventDelegate = affordance;
            return result;
         }
      }
 
      event.Skip(false);
   }
   switch (event.GetKeyCode())
   {
   case WXK_TAB:
      break;
   default:
      result |= CommonChannelView::CaptureKey(
         event, viewInfo, pParent, project);
      break;
   };
   if (!event.GetSkipped()) {
      mKeyEventDelegate = shared_from_this();
   }
 
   return result;
}

References TrackPanelCell::CaptureKey(), FindWaveChannel(), Get(), mKeyEventDelegate, project, and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ Char()

unsigned WaveChannelView::Char	(	wxKeyEvent &	event,
		ViewInfo &	viewInfo,
		wxWindow *	pParent,
		AudacityProject *	project
	)

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 1418 of file WaveChannelView.cpp.

{
   unsigned result{ RefreshCode::RefreshNone };
   if (auto delegate = mKeyEventDelegate.lock()) {
      if (auto pWaveChannelView =
         dynamic_cast<WaveChannelView*>(delegate.get()))
         result |= pWaveChannelView->CommonChannelView::Char(
            event, viewInfo, pParent, project);
      else
         result |= delegate->Char(event, viewInfo, pParent, project);
   }
   else
      event.Skip();
 
   return result;
}

References mKeyEventDelegate, project, and RefreshCode::RefreshNone.

◆ ClipDetailsVisible()

bool WaveChannelView::ClipDetailsVisible	(	const ClipTimes &	clip,
		const ZoomInfo &	zoomInfo,
		const wxRect &	viewRect
	)

static

Definition at line 1480 of file WaveChannelView.cpp.

{
   //Do not fold clips to line at sample zoom level, as
   //it may become impossible to 'unfold' it when clip is trimmed
   //to a single sample
   bool showSamples{ false };
   auto clipRect = ClipParameters::GetClipRect(clip, zoomInfo, viewRect, &showSamples);
   return showSamples || clipRect.width >= kClipDetailedViewMinimumWidth;
}

References ClipParameters::GetClipRect(), and kClipDetailedViewMinimumWidth.

Referenced by WaveTrackAffordanceHandle::Click(), DoDetailedHitTest(), WaveTrackAffordanceControls::Draw(), anonymous_namespace{SpectrumView.cpp}::DrawClipSpectrum(), anonymous_namespace{WaveformView.cpp}::DrawClipWaveform(), and WaveClipAdjustBorderHandle::HitAnywhere().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClipHitTestArea()

wxRect WaveChannelView::ClipHitTestArea	(	const ClipTimes &	clip,
		const ZoomInfo &	zoomInfo,
		const wxRect &	viewRect
	)

static

Definition at line 1491 of file WaveChannelView.cpp.

{
   bool showSamples{ false };
   auto clipRect = ClipParameters::GetClipRect(clip, zoomInfo, viewRect, &showSamples);
   if (showSamples || clipRect.width >= kClipDetailedViewMinimumWidth)
      return clipRect;
 
   return clipRect.Inflate(2, 0);
}

References ClipParameters::GetClipRect(), and kClipDetailedViewMinimumWidth.

Referenced by HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CopySelectedText()

bool WaveChannelView::CopySelectedText ( AudacityProject & project )

Definition at line 1474 of file WaveChannelView.cpp.

{
   return
      AnyAffordance(project, *this, &WaveTrackAffordanceControls::OnTextCopy);
}

References anonymous_namespace{WaveChannelView.cpp}::AnyAffordance(), WaveTrackAffordanceControls::OnTextCopy(), and project.

Here is the call graph for this function:

◆ CopyTo()

void WaveChannelView::CopyTo	(	Track &	track,
		size_t	iChannel
	)		const

overridevirtual

Copy state, for undo/redo purposes.

Parameters

iChannel position of the attachment's channel in the group The default does nothing

Reimplemented from ChannelAttachment.

Definition at line 979 of file WaveChannelView.cpp.

{
   ChannelView::CopyTo(track, iChannel);
   auto &other = ChannelView::Get(*track.GetChannel(0));
   if (const auto pOther = dynamic_cast<WaveChannelView*>(&other)) {
      // only these fields are important to preserve in undo/redo history
      pOther->RestorePlacements( SavePlacements() );
      pOther->DoGetMultiView() = DoGetMultiView();
 
      auto srcSubViewsPtrs =
         const_cast<WaveChannelView*>(this)->GetAllSubViews();
      auto destSubViewsPtrs =
         const_cast<WaveChannelView*>(pOther)->GetAllSubViews();
      wxASSERT(srcSubViewsPtrs.size() == destSubViewsPtrs.size());
 
      for(auto i = 0; i != srcSubViewsPtrs.size(); i++){
         srcSubViewsPtrs[i]->CopyToSubView(destSubViewsPtrs[i].get());
      }
   }
}

References ChannelView::CopyTo(), DoGetMultiView(), ChannelView::Get(), GetAllSubViews(), ChannelGroup::GetChannel(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and SavePlacements().

Here is the call graph for this function:

◆ CutSelectedText()

bool WaveChannelView::CutSelectedText ( AudacityProject & project )

Definition at line 1468 of file WaveChannelView.cpp.

{
   return
      AnyAffordance(project, *this, &WaveTrackAffordanceControls::OnTextCut);
}

References anonymous_namespace{WaveChannelView.cpp}::AnyAffordance(), WaveTrackAffordanceControls::OnTextCut(), and project.

Here is the call graph for this function:

◆ DetailedHitTest()

std::vector< UIHandlePtr > WaveChannelView::DetailedHitTest	(	const TrackPanelMouseState &	state,
		const AudacityProject *	pProject,
		int	currentTool,
		bool	bMultiTool
	)

overrideprivatevirtual

Implements CommonChannelView.

Definition at line 1000 of file WaveChannelView.cpp.

{
   // should not come here any more, delegation to sub-view instead
   wxASSERT( false );
   return {};
}

◆ DoDetailedHitTest()

std::pair< bool, std::vector< UIHandlePtr > > WaveChannelView::DoDetailedHitTest	(	const TrackPanelMouseState &	state,
		const AudacityProject *	pProject,
		int	currentTool,
		bool	bMultiTool,
		const std::shared_ptr< WaveChannel > &	wt,
		CommonChannelView &	view
	)

static

Definition at line 1010 of file WaveChannelView.cpp.

{
   // common hit-testing for different sub-view types, to help implement their
   // DetailedHitTest()
 
   // This is the only override of Track::DetailedHitTest that still
   // depends on the state of the Tools toolbar.
   // If that toolbar were eliminated, this could simplify to a sequence of
   // hit test routines describable by a table.
 
   std::vector<UIHandlePtr> results;
 
   const auto& viewInfo = ViewInfo::Get(*pProject);
   const auto pTrack = pChannel->GetTrack().SharedPointer<WaveTrack>();
 
   for (const auto &clip : pChannel->Intervals())
   {
      if (!WaveChannelView::ClipDetailsVisible(*clip, viewInfo, st.rect)
         && HitTest(*clip, viewInfo, st.rect, st.state.GetPosition()))
      {
         auto &waveChannelView = WaveChannelView::Get(*pChannel);
         results.push_back(
            AssignUIHandlePtr(
               waveChannelView.mAffordanceHandle,
               std::make_shared<WaveTrackAffordanceHandle>(pTrack, clip)
            )
         );
      }
   }
 
   if (bMultiTool && st.state.CmdDown()) {
      // Ctrl modifier key in multi-tool overrides everything else
      // (But this does not do the time shift constrained to the vertical only,
      //  which is what happens when you hold Ctrl in the Time Shift tool mode)
      auto result = TimeShiftHandle::HitAnywhere(view.mTimeShiftHandle,
         pTrack, false);
      if (result)
         results.push_back(result);
      return { true, results };
   }
 
   return { false, results };
}

References AssignUIHandlePtr(), ClipDetailsVisible(), ViewInfo::Get(), Get(), TimeShiftHandle::HitAnywhere(), HitTest(), CommonChannelView::mTimeShiftHandle, 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:

◆ DoGetAffordance()

std::shared_ptr< CommonTrackCell > WaveChannelView::DoGetAffordance ( Track & track )

private

Definition at line 1557 of file WaveChannelView.cpp.

{
    if (mpAffordanceCellControl == nullptr)
        mpAffordanceCellControl =
          std::make_shared<WaveTrackAffordanceControls>(track.SharedPointer());
    return mpAffordanceCellControl;
}

References mpAffordanceCellControl, and Track::SharedPointer().

Referenced by GetAffordanceControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetMultiView() [1/2]

bool & WaveChannelView::DoGetMultiView ( )

private

Definition at line 95 of file WaveChannelView.cpp.

{
   auto &waveTrack = FindWaveChannel()->GetTrack();
   return PlacementArray::Get(waveTrack).mMultiView;
}

References FindWaveChannel(), and BasicUI::Get().

Referenced by CopyTo(), and DoGetMultiView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetMultiView() [2/2]

bool WaveChannelView::DoGetMultiView ( ) const

private

Definition at line 101 of file WaveChannelView.cpp.

{
   return const_cast<WaveChannelView&>(*this).DoGetMultiView();
}

References DoGetMultiView().

Here is the call graph for this function:

◆ DoGetPlacements() [1/2]

WaveChannelSubViewPlacements & WaveChannelView::DoGetPlacements ( )

private

Definition at line 84 of file WaveChannelView.cpp.

{
   auto &waveChannel = *FindWaveChannel();
   return PlacementArray::Get(waveChannel.GetTrack()).mPlacements;
}

References FindWaveChannel(), and BasicUI::Get().

Referenced by DoGetPlacements(), DoSetDisplay(), GetDisplays(), and ToggleSubView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetPlacements() [2/2]

const WaveChannelSubViewPlacements & WaveChannelView::DoGetPlacements ( ) const

private

Definition at line 90 of file WaveChannelView.cpp.

{
   return const_cast<WaveChannelView&>(*this).DoGetPlacements();
}

References DoGetPlacements().

Here is the call graph for this function:

◆ DoGetVRulerControls()

std::shared_ptr< ChannelVRulerControls > WaveChannelView::DoGetVRulerControls ( )

overridevirtual

Implements ChannelView.

Definition at line 1576 of file WaveChannelView.cpp.

{
   return {};
}

◆ DoSetDisplay()

void WaveChannelView::DoSetDisplay	(	Display	display,
		bool	exclusive = `true`
	)

private

Definition at line 1146 of file WaveChannelView.cpp.

{
   // Some generality here anticipating more than two views.
   // The order of sub-views in the array is not specified, so make it definite
   // by sorting by the view type constants.
   size_t ii = 0;
   std::vector<std::pair<WaveChannelViewConstants::Display, size_t>> pairs;
   WaveChannelSubViews::ForEach([&pairs, &ii](WaveChannelSubView &subView){
      pairs.push_back({ subView.SubViewType().id, ii++ });
   });
   std::sort( pairs.begin(), pairs.end() );
 
   int jj = 1;
   auto &placements = DoGetPlacements();
   for ( const auto &pair : pairs ) {
      auto &placement = placements[ pair.second ];
      if (pair.first == display) {
         // 0 for first view
         placement = { 0, 1.0 };
      }
      else if( exclusive )
         // -1 for not displayed
         placement = { -1, 0.0 };
      else
         // positions other than the first.
         // (Note that the fractions in the placement don't need to be
         // denominated to 1.  Just make them all equal to get an equal
         // partitioning of the sub-views.)
         placement = { jj++, 1.0 };
   }
}

References DoGetPlacements(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach(), and WaveChannelSubView::SubViewType().

Referenced by SetDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoSetMinimized()

void WaveChannelView::DoSetMinimized ( bool minimized )

overrideprivatevirtual

Reimplemented from ChannelView.

Definition at line 1545 of file WaveChannelView.cpp.

{
   BuildSubViews();
 
   // May come here.  Invoke also on sub-views.
   ChannelView::DoSetMinimized(minimized);
   WaveChannelSubViews::ForEach([minimized](WaveChannelSubView &subView) {
      subView.DoSetMinimized(minimized);
   });
}

References BuildSubViews(), ChannelView::DoSetMinimized(), and ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach().

Here is the call graph for this function:

◆ Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 1636 of file WaveChannelView.cpp.

{
   // Should not come here, drawing is now delegated to sub-views
   wxASSERT( false );
 
   CommonChannelView::Draw(context, rect, iPass);
}

References TrackPanelDrawable::Draw().

Here is the call graph for this function:

◆ Find() [1/2]

const WaveChannelView * WaveChannelView::Find ( const WaveChannel * pChannel )

static

Definition at line 928 of file WaveChannelView.cpp.

{
   return Find(const_cast<WaveChannel*>(pChannel));
}

References Find().

Here is the call graph for this function:

◆ Find() [2/2]

WaveChannelView * WaveChannelView::Find ( WaveChannel * pChannel )

static

Definition at line 923 of file WaveChannelView.cpp.

{
   return static_cast<WaveChannelView*>(ChannelView::Find(pChannel));
}

References ChannelView::Find().

Referenced by Find().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindFirst() [1/2]

const WaveChannelView * WaveChannelView::FindFirst ( const WaveTrack * pWt )

static

If pWt is not null, return a pointer to the view of the first channel.

Definition at line 949 of file WaveChannelView.cpp.

{
   return pWt ? &GetFirst(*pWt): nullptr;
}

References GetFirst().

Here is the call graph for this function:

◆ FindFirst() [2/2]

WaveChannelView * WaveChannelView::FindFirst ( WaveTrack * pWt )

static

If pWt is not null, return a pointer to the view of the first channel.

Definition at line 944 of file WaveChannelView.cpp.

{
   return pWt ? &GetFirst(*pWt): nullptr;
}

References GetFirst().

Referenced by NyquistEffect::Init(), and NyquistEffect::ProcessOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindWaveChannel()

std::shared_ptr< WaveChannel > WaveChannelView::FindWaveChannel ( )

Definition at line 974 of file WaveChannelView.cpp.

{
   return FindChannel<WaveChannel>();
}

Referenced by anonymous_namespace{WaveChannelView.cpp}::AnyAffordance(), CaptureKey(), DoGetMultiView(), DoGetPlacements(), GetAffordanceControls(), GetSelectedClip(), WaveClipAdjustBorderHandle::HitTest(), and SelectNextClip().

Here is the caller graph for this function:

◆ Get() [1/2]

const WaveChannelView & WaveChannelView::Get ( const WaveChannel & channel )

static

Definition at line 918 of file WaveChannelView.cpp.

{
   return Get(const_cast<WaveChannel&>(channel));
}

References Get().

Here is the call graph for this function:

◆ Get() [2/2]

WaveChannelView & WaveChannelView::Get ( WaveChannel & channel )

static

Definition at line 913 of file WaveChannelView.cpp.

{
   return static_cast<WaveChannelView&>(ChannelView::Get(channel));
}

References ChannelView::Get().

Referenced by SetTrackVisualsCommand::ApplyInner(), CaptureKey(), WaveformPrefs::Commit(), DoDetailedHitTest(), Get(), GetFirst(), GetSelectedClip(), SpectrumPrefs::Rollback(), SpectrumPrefs::SpectrumPrefs(), and SubViewAdjuster::UpdateViews().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAffordanceControls()

std::shared_ptr< CommonTrackCell > WaveChannelView::GetAffordanceControls ( )

overridevirtual

Reimplemented from ChannelView.

Definition at line 1533 of file WaveChannelView.cpp.

{
   auto pChannel = FindWaveChannel();
   if (pChannel) {
      auto &track = pChannel->GetTrack();
      if (pChannel == *track.Channels().begin()) {
         return DoGetAffordance(track);
      }
   }
   return {};
}

References DoGetAffordance(), and FindWaveChannel().

Here is the call graph for this function:

◆ GetAllSubViews()

std::vector< std::shared_ptr< WaveChannelSubView > > WaveChannelView::GetAllSubViews ( )

Definition at line 1521 of file WaveChannelView.cpp.

{
   BuildSubViews();
 
   std::vector<std::shared_ptr<WaveChannelSubView>> results;
   WaveChannelSubViews::ForEach([&](WaveChannelSubView &subView) {
      results.push_back(std::static_pointer_cast<WaveChannelSubView>(
         subView.shared_from_this()));
   });
   return results;
}

References BuildSubViews(), and ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach().

Referenced by CopyTo(), and SubViewAdjuster::SubViewAdjuster().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDisplays()

auto WaveChannelView::GetDisplays ( ) const

Definition at line 1058 of file WaveChannelView.cpp.

{
   BuildSubViews();
 
   // Collect the display types of visible views and sort them by position
   using Pair = std::pair<int, WaveChannelSubView::Type>;
   std::vector< Pair > pairs;
   size_t ii = 0;
   const auto &placements = DoGetPlacements();
   WaveChannelSubViews::ForEach([&](const WaveChannelSubView &subView) {
      auto &placement = placements[ii];
      if (placement.fraction > 0)
         pairs.emplace_back(placement.index, subView.SubViewType());
      ++ii;
   } );
   std::sort( pairs.begin(), pairs.end() );
   std::vector<WaveChannelSubView::Type> results;
   for (const auto &pair : pairs)
      results.push_back(pair.second);
   return results;
}

References BuildSubViews(), DoGetPlacements(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach(), and WaveChannelSubView::SubViewType().

Referenced by anonymous_namespace{SpectrumView.cpp}::DoNextPeakFrequency(), and ToggleSubView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFirst() [1/2]

const WaveChannelView & WaveChannelView::GetFirst ( const WaveTrack & wt )

static

Get the view of the first channel.

Definition at line 939 of file WaveChannelView.cpp.

{
   return GetFirst(const_cast<WaveTrack&>(wt));
}

References GetFirst().

Here is the call graph for this function:

◆ GetFirst() [2/2]

WaveChannelView & WaveChannelView::GetFirst ( WaveTrack & wt )

static

Get the view of the first channel.

Definition at line 933 of file WaveChannelView.cpp.

{
   assert(wt.Channels().size() > 0);
   return Get(**wt.Channels().begin());
}

References WaveTrack::Channels(), and Get().

Referenced by Append(), anonymous_namespace{SpectrumView.cpp}::DoNextPeakFrequency(), anonymous_namespace{EditMenus.cpp}::DoPasteText(), anonymous_namespace{WaveTrackAffordanceControls.cpp}::FindAffordance(), FindFirst(), for(), GetFirst(), WaveTrackAffordanceControls::HitTest(), anonymous_namespace{EditMenus.cpp}::OnCopy(), anonymous_namespace{EditMenus.cpp}::OnCut(), WaveTrackMenuTable::OnMergeStereo(), WaveTrackMenuTable::OnMultiView(), SelectActions::Handler::OnSelectAll(), and WaveTrackMenuTable::OnSetDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastHeight()

wxCoord WaveChannelView::GetLastHeight ( ) const

inline

Definition at line 166 of file WaveChannelView.h.

166{ return mLastHeight; }

WaveChannelView::mLastHeight

wxCoord mLastHeight

Definition: WaveChannelView.h:240

Referenced by SubViewAdjustHandle::HitTest(), and SubViewRearrangeHandle::HitTest().

Here is the caller graph for this function:

◆ GetMultiView()

bool WaveChannelView::GetMultiView ( ) const

inline

Definition at line 168 of file WaveChannelView.h.

168{ return DoGetMultiView(); }

Referenced by SubViewAdjustHandle::HitTest(), and SubViewRearrangeHandle::HitTest().

Here is the caller graph for this function:

◆ GetSelectedClip()

WaveTrack::IntervalHolder WaveChannelView::GetSelectedClip ( )

Definition at line 1594 of file WaveChannelView.cpp.

{
   const auto pChannel = FindWaveChannel();
   if (!pChannel)
      return {};
   auto &track = pChannel->GetTrack();
   auto &topmostView = Get(**track.Channels().begin());
   if (auto affordance = std::dynamic_pointer_cast<WaveTrackAffordanceControls>(
      topmostView.GetAffordanceControls()))
   {
      return *affordance->GetSelectedInterval();
   }
   return {};
}

References FindWaveChannel(), and Get().

Here is the call graph for this function:

◆ GetSubViews() [1/2]

auto WaveChannelView::GetSubViews ( const wxRect & rect )

overrideprivatevirtual

Reimplemented from ChannelView.

Definition at line 1265 of file WaveChannelView.cpp.

{
   return GetSubViews(&rect);
}

◆ GetSubViews() [2/2]

auto WaveChannelView::GetSubViews ( const wxRect * rect = nullptr )

Definition at line 1270 of file WaveChannelView.cpp.

{
   BuildSubViews();
 
   // Collect the visible views in the right sequence
   struct Item {
      int index; float fraction; std::shared_ptr<ChannelView> pView;
   };
   std::vector< Item > items;
   size_t ii = 0;
   float total = 0;
   const auto &placements = DoGetPlacements();
   WaveChannelSubViews::ForEach([&](WaveChannelSubView& subView) {
      auto& placement = placements[ii];
      auto index = placement.index;
      auto fraction = placement.fraction;
      if (index >= 0 && fraction > 0.0)
         total += fraction,
         items.push_back({ index, fraction, subView.shared_from_this() });
      ++ii;
   });
   std::sort(items.begin(), items.end(), [](const Item& a, const Item& b) {
      return a.index < b.index;
   });
 
   // Remove views we don't need
   auto begin = items.begin(), end = items.end(),
        newEnd = std::remove_if(begin, end,
            [](const Item& item) { return !item.pView; });
   items.erase(newEnd, end);
 
   Refinement results;
 
   if (rect != nullptr)
   {
      // Assign coordinates, redenominating to the total height,
      // storing integer values
      results.reserve(items.size());
      const auto top = rect->GetTop();
      const auto height = rect->GetHeight();
      float partial = 0;
      wxCoord lastCoord = 0;
      for (const auto& item : items) {
         wxCoord newCoord = top + (partial / total) * height;
         results.emplace_back(newCoord, item.pView);
         partial += item.fraction;
      }
 
      // Cache for the use of sub-view dragging
      mLastHeight = height;
   }
   else
   {
      std::transform(items.begin(), items.end(), std::back_inserter(results), [](const auto& item) {
         return std::make_pair(0, item.pView);
      });
   }
 
   return results;
}

References details::begin(), details::end(), and ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach().

Here is the call graph for this function:

◆ HitTest()

bool WaveChannelView::HitTest	(	const ClipTimes &	clip,
		const ZoomInfo &	zoomInfo,
		const wxRect &	rect,
		const wxPoint &	pos
	)

static

Definition at line 1502 of file WaveChannelView.cpp.

{
   return ClipHitTestArea(clip, viewInfo, viewRect).Contains(pos);
}

References ClipHitTestArea().

Referenced by DoDetailedHitTest(), WaveTrackAffordanceControls::HitTest(), WaveTrackShifter::HitTest(), and SubViewAdjustHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ KeyDown()

unsigned WaveChannelView::KeyDown	(	wxKeyEvent &	event,
		ViewInfo &	viewInfo,
		wxWindow *	pParent,
		AudacityProject *	project
	)

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 1391 of file WaveChannelView.cpp.

{
   unsigned result{ RefreshCode::RefreshNone };
   if (auto delegate = mKeyEventDelegate.lock()) {
      if (auto pWaveChannelView =
         dynamic_cast<WaveChannelView*>(delegate.get()))
      {
         if (event.GetKeyCode() == WXK_TAB)
         {
            SelectNextClip(viewInfo, project, event.GetModifiers() != wxMOD_SHIFT);
            result |= RefreshCode::RefreshCell;
         }
         else
            result |= pWaveChannelView->CommonChannelView::KeyDown(
               event, viewInfo, pParent, project);
      }
      else
         result |= delegate->KeyDown(event, viewInfo, pParent, project);
   }
   else
      event.Skip();
 
   return result;
}

References mKeyEventDelegate, project, RefreshCode::RefreshCell, RefreshCode::RefreshNone, and SelectNextClip().

Here is the call graph for this function:

◆ LoseFocus()

unsigned WaveChannelView::LoseFocus ( AudacityProject * project )

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 1437 of file WaveChannelView.cpp.

{
   unsigned result = RefreshCode::RefreshNone;
   if (auto delegate = mKeyEventDelegate.lock()) {
      if (auto pWaveChannelView =
         dynamic_cast<WaveChannelView*>(delegate.get()))
         result = pWaveChannelView->CommonChannelView::LoseFocus(project);
      else
         result = delegate->LoseFocus(project);
      mKeyEventDelegate.reset();
   }
   return result;
}

References mKeyEventDelegate, project, and RefreshCode::RefreshNone.

◆ operator=()

WaveChannelView & WaveChannelView::operator= ( const WaveChannelView & )

privatedelete

◆ PasteText()

bool WaveChannelView::PasteText ( AudacityProject & project )

Definition at line 1508 of file WaveChannelView.cpp.

{
   return
      AnyAffordance(project, *this, &WaveTrackAffordanceControls::OnTextPaste);
}

References anonymous_namespace{WaveChannelView.cpp}::AnyAffordance(), WaveTrackAffordanceControls::OnTextPaste(), and project.

Here is the call graph for this function:

◆ Reparent()

void WaveChannelView::Reparent	(	const std::shared_ptr< Track > &	parent,
		size_t	iChannel
	)

overridevirtual

Object may be shared among tracks but hold a special back-pointer to one of them; reassign it.

Parameters

iChannel position of the attachment's channel in the group The default does nothing

Reimplemented from ChannelAttachment.

Definition at line 1581 of file WaveChannelView.cpp.

{
   // BuildSubViews(); // not really needed
   CommonChannelView::Reparent(parent, iChannel);
   WaveChannelSubViews::ForEach([&parent, iChannel](WaveChannelSubView &subView)
   {
      subView.Reparent(parent, iChannel);
   });
   if (mpAffordanceCellControl)
      mpAffordanceCellControl->Reparent(parent);
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::ForEach(), anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, mpAffordanceCellControl, and ChannelView::Reparent().

Here is the call graph for this function:

◆ RestorePlacements()

void WaveChannelView::RestorePlacements ( const WaveChannelSubViewPlacements & placements )

inline

Definition at line 154 of file WaveChannelView.h.

155 { DoGetPlacements() = placements; }

Referenced by SpectrumPrefs::Rollback(), and SubViewAdjuster::UpdateViews().

Here is the caller graph for this function:

◆ SavePlacements()

const WaveChannelSubViewPlacements & WaveChannelView::SavePlacements ( ) const

inline

Definition at line 152 of file WaveChannelView.h.

153 { return DoGetPlacements(); }

Referenced by CopyTo(), SpectrumPrefs::SpectrumPrefs(), and SubViewAdjuster::SubViewAdjuster().

Here is the caller graph for this function:

◆ SelectAllText()

bool WaveChannelView::SelectAllText ( AudacityProject & project )

Definition at line 1514 of file WaveChannelView.cpp.

{
   return
      AnyAffordance(project, *this, &WaveTrackAffordanceControls::OnTextSelect);
}

References anonymous_namespace{WaveChannelView.cpp}::AnyAffordance(), WaveTrackAffordanceControls::OnTextSelect(), and project.

Here is the call graph for this function:

◆ SelectNextClip()

bool WaveChannelView::SelectNextClip	(	ViewInfo &	viewInfo,
		AudacityProject *	project,
		bool	forward
	)

private

Definition at line 1207 of file WaveChannelView.cpp.

{
   //Iterates through clips in a looped manner
   const auto pChannel = FindWaveChannel();
   if (!pChannel)
      return false;
   auto clips = WaveChannelUtilities::SortedClipArray(*pChannel);
   if (clips.empty())
      return false;
 
   std::shared_ptr<WaveChannelInterval> clip{};
   if (forward)
   {
      clip = NextClipLooped(viewInfo, clips.begin(), clips.end(),
      [&](const auto &other) {
         return other->GetPlayStartTime() >= viewInfo.selectedRegion.t1();
      });
   }
   else
   {
      clip = NextClipLooped(viewInfo, clips.rbegin(), clips.rend(),
      [&](const auto &other) {
         return other->GetPlayStartTime() <= viewInfo.selectedRegion.t0();
      });
   }
 
   viewInfo.selectedRegion.setTimes(clip->GetPlayStartTime(), clip->GetPlayEndTime());
   ProjectHistory::Get(*project).ModifyState(false);
 
   // create and send message to screen reader
   auto it = std::find(clips.begin(), clips.end(), clip);
   auto index = std::distance(clips.begin(), it);
 
   auto &waveTrack = pChannel->GetTrack();
   auto wideClipIt = waveTrack.Intervals().first;
   std::advance(wideClipIt, waveTrack.GetClipIndex(clip->GetClip()));
   PitchAndSpeedDialog::Get(*project)
      .Retarget(waveTrack.SharedPointer<WaveTrack>(), *wideClipIt);
 
   auto message = XP(
   /* i18n-hint:
       string is the name of a clip
       first number is the position of that clip in a sequence of clips,
       second number counts the clips */
       "%s, %d of %d clip",
       "%s, %d of %d clips",
       2
   )(
      clip->GetClip().GetName(),
      static_cast<int>(index + 1),
      static_cast<int>(clips.size())
  );
 
   TrackFocus::Get(*project).MessageForScreenReader(message);
   return true;
}

References FindWaveChannel(), forward, TrackFocus::Get(), ProjectHistory::Get(), PitchAndSpeedDialog::Get(), ProjectHistory::ModifyState(), anonymous_namespace{WaveChannelView.cpp}::NextClipLooped(), project, PitchAndSpeedDialog::Retarget(), ViewInfo::selectedRegion, NotifyingSelectedRegion::setTimes(), WaveChannelUtilities::SortedClipArray(), and XP.

Referenced by KeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDisplay()

void WaveChannelView::SetDisplay	(	Display	display,
		bool	exclusive = `true`
	)

Definition at line 1081 of file WaveChannelView.cpp.

{
   BuildSubViews();
   DoSetDisplay( display, exclusive );
}

References BuildSubViews(), and DoSetDisplay().

Referenced by WaveformPrefs::Commit(), and WaveTrackMenuTable::OnSetDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMultiView()

void WaveChannelView::SetMultiView ( bool value )

inline

Definition at line 169 of file WaveChannelView.h.

169{ DoGetMultiView() = value; }

◆ ToggleSubView()

bool WaveChannelView::ToggleSubView ( Display id )

Definition at line 1087 of file WaveChannelView.cpp.

{
   size_t ii = 0;
   size_t found = 0;
   if (WaveChannelSubViews::FindIf([&](const WaveChannelSubView &subView) {
      if (subView.SubViewType().id == display) {
         found = ii;
         return true;
      }
      ++ii;
      return false;
   })) {
      auto &placements = DoGetPlacements();
      auto &foundPlacement = placements[found];
      if ( foundPlacement.fraction > 0.0 ) {
         // Toggle off
 
         if (GetDisplays().size() < 2)
            // refuse to do it
            return false;
 
         auto index = foundPlacement.index;
         foundPlacement = { -1, 0.0 };
         if (index >= 0) {
            for ( auto &placement : placements ) {
               if ( placement.index > index )
                  --placement.index;
            }
         }
 
         return true;
      }
      else {
         // Toggle on
         float total = 0;
         int greatest = -1;
         unsigned nn = 0;
         for ( const auto &placement : placements ) {
            if ( placement.fraction > 0.0 && placement.index >= 0 ) {
               total += placement.fraction;
               greatest = std::max( greatest, placement.index );
               ++nn;
            }
         }
         // Turn on the sub-view, putting it lowest, and with average of the
         // heights of the other sub-views
         foundPlacement = { greatest + 1, total / nn };
 
         return true;
      }
   }
   else
      // unknown sub-view
      return false;
}

References DoGetPlacements(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::FindIf(), GetDisplays(), WaveChannelSubViewType::id, ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::size(), and WaveChannelSubView::SubViewType().

Here is the call graph for this function:

Member Data Documentation

◆ kChannelSeparatorThickness

constexpr int WaveChannelView::kChannelSeparatorThickness { 8 }

staticconstexpr

Definition at line 105 of file WaveChannelView.h.

Referenced by WaveChannelSubView::DoDetailedHitTest().

◆ mAffordanceHandle

std::weak_ptr<WaveTrackAffordanceHandle> WaveChannelView::mAffordanceHandle

private

Definition at line 251 of file WaveChannelView.h.

◆ mKeyEventDelegate

std::weak_ptr<TrackPanelCell> WaveChannelView::mKeyEventDelegate

private

Definition at line 249 of file WaveChannelView.h.

Referenced by CaptureKey(), Char(), KeyDown(), and LoseFocus().

◆ mLastHeight

wxCoord WaveChannelView::mLastHeight {}

mutableprivate

Definition at line 240 of file WaveChannelView.h.

◆ mpAffordanceCellControl

std::shared_ptr<CommonTrackCell> WaveChannelView::mpAffordanceCellControl

private

Definition at line 247 of file WaveChannelView.h.

Referenced by DoGetAffordance(), and Reparent().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Display

Constructor & Destructor Documentation

◆ WaveChannelView()

◆ ~WaveChannelView()

Member Function Documentation

◆ BuildSubViews()

◆ CaptureKey()

◆ Char()

◆ ClipDetailsVisible()

◆ ClipHitTestArea()

◆ CopySelectedText()

◆ CopyTo()

◆ CutSelectedText()

◆ DetailedHitTest()

◆ DoDetailedHitTest()

◆ DoGetAffordance()

◆ DoGetMultiView() [1/2]

◆ DoGetMultiView() [2/2]

◆ DoGetPlacements() [1/2]

◆ DoGetPlacements() [2/2]

◆ DoGetVRulerControls()

◆ DoSetDisplay()

◆ DoSetMinimized()

◆ Draw()

◆ Find() [1/2]

◆ Find() [2/2]

◆ FindFirst() [1/2]

◆ FindFirst() [2/2]

◆ FindWaveChannel()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAffordanceControls()

◆ GetAllSubViews()

◆ GetDisplays()

◆ GetFirst() [1/2]

◆ GetFirst() [2/2]

◆ GetLastHeight()

◆ GetMultiView()

◆ GetSelectedClip()

◆ GetSubViews() [1/2]

◆ GetSubViews() [2/2]

◆ HitTest()

◆ KeyDown()

◆ LoseFocus()

◆ operator=()

◆ PasteText()

◆ Reparent()

◆ RestorePlacements()

◆ SavePlacements()

◆ SelectAllText()

◆ SelectNextClip()

◆ SetDisplay()

◆ SetMultiView()

◆ ToggleSubView()

Member Data Documentation

◆ kChannelSeparatorThickness

◆ mAffordanceHandle

◆ mKeyEventDelegate

◆ mLastHeight

◆ mpAffordanceCellControl