#include <TrackView.h>

Inheritance diagram for TrackView:

Collaboration diagram for TrackView:

Public Types
enum	: unsigned { DefaultHeight = 150 }

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

Public Member Functions
	TrackView (const std::shared_ptr< Track > &pTrack)

virtual	~TrackView ()=0

void	CopyTo (Track &track) 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< TrackVRulerControls >	GetVRulerControls ()

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

virtual std::shared_ptr< CommonTrackCell >	GetAffordanceControls ()

void	WriteXMLAttributes (XMLWriter &) const override
	Serialize persistent attributes. More...

bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView) 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 CommonTrackCell
	CommonTrackCell (const std::shared_ptr< Track > &pTrack)

	~CommonTrackCell ()

std::shared_ptr< Track >	DoFindTrack () override

void	Reparent (const std::shared_ptr< Track > &parent) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. 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 &) PROHIBITED

TrackPanelCell &	operator= (const TrackPanelCell &) PROHIBITED

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 TrackAttachment
virtual	~TrackAttachment ()

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

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

virtual void	WriteXMLAttributes (XMLWriter &) const
	Serialize persistent attributes. More...

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

Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static int	GetTrackHeight (const Track *pTrack)

static int	GetChannelGroupHeight (const Track *pTrack)

static int	GetCumulativeHeight (const Track *pTrack)

static int	GetTotalHeight (const TrackList &list)

static TrackView &	Get (Track &)

static const TrackView &	Get (const Track &)

static TrackView *	Find (Track *)

static const TrackView *	Find (const Track *)

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
virtual std::shared_ptr< TrackVRulerControls >	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 Attributes
std::shared_ptr< TrackVRulerControls >	mpVRulerControls

Private Member Functions
	TrackView (const TrackView &)=delete

TrackView &	operator= (const TrackView &)=delete

void	DoSetY (int y)

void	DoSetHeight (int h)

Private Attributes
bool	mMinimized { false }

int	mY { 0 }

int	mHeight { DefaultHeight }

Detailed Description

Definition at line 23 of file TrackView.h.

Member Typedef Documentation

◆ Refinement

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

Definition at line 102 of file TrackView.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned

Enumerator
DefaultHeight

Definition at line 30 of file TrackView.h.

30: unsigned { DefaultHeight = 150 };

TrackView::DefaultHeight

@ DefaultHeight

Definition: TrackView.h:30

Constructor & Destructor Documentation

◆ TrackView() [1/2]

TrackView::TrackView ( const TrackView & )

privatedelete

◆ TrackView() [2/2]

TrackView::TrackView ( const std::shared_ptr< Track > & pTrack )

explicit

Definition at line 19 of file TrackView.cpp.

   : CommonTrackCell{ pTrack }
{
   DoSetHeight( GetDefaultTrackHeight::Call( *pTrack ) );
}

References AttachedVirtualFunction< Tag, Return, This, Arguments >::Call(), and DoSetHeight().

Here is the call graph for this function:

◆ ~TrackView()

TrackView::~TrackView ( )

pure virtual

Definition at line 25 of file TrackView.cpp.

26{

27}

Member Function Documentation

◆ CopyTo()

void TrackView::CopyTo ( Track & track ) const

overridevirtual

Copy state, for undo/redo purposes.

Reimplemented from TrackAttachment.

Definition at line 52 of file TrackView.cpp.

{
   auto &other = Get( track );
 
   other.mMinimized = mMinimized;
 
   // Let mY remain 0 -- TrackPositioner corrects it later
   other.mY = 0;
   other.mHeight = mHeight;
}

References Get(), mHeight, and mMinimized.

Referenced by LabelTrackView::CopyTo(), and WaveTrackView::CopyTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetVRulerControls()

virtual std::shared_ptr< TrackVRulerControls > TrackView::DoGetVRulerControls ( )

protectedpure virtual

Implemented in LabelTrackView, NoteTrackView, SpectrumView, WaveformView, WaveTrackView, and TimeTrackView.

Referenced by GetVRulerControls().

Here is the caller graph for this function:

◆ DoSetHeight()

void TrackView::DoSetHeight ( int h )

private

Definition at line 178 of file TrackView.cpp.

{
   mHeight = h;
}

References mHeight.

Referenced by SetExpandedHeight(), and TrackView().

Here is the caller graph for this function:

◆ DoSetMinimized()

void TrackView::DoSetMinimized ( bool isMinimized )

virtual

Reimplemented in SpectrumView, WaveformView, and WaveTrackView.

Definition at line 141 of file TrackView.cpp.

{
   mMinimized = isMinimized;
}

References mMinimized.

Referenced by WaveTrackView::BuildSubViews(), SpectrumView::DoSetMinimized(), WaveformView::DoSetMinimized(), WaveTrackView::DoSetMinimized(), and SetMinimized().

Here is the caller graph for this function:

◆ DoSetY()

void TrackView::DoSetY ( int y )

private

Definition at line 159 of file TrackView.cpp.

{
   mY = y;
}

References mY.

◆ Find() [1/2]

const TrackView * TrackView::Find ( const Track * pTrack )

static

Definition at line 88 of file TrackView.cpp.

{
   return Find( const_cast< Track* >( pTrack ) );
}

References Find().

Here is the call graph for this function:

◆ Find() [2/2]

TrackView * TrackView::Find ( Track * pTrack )

static

Definition at line 79 of file TrackView.cpp.

{
   if (!pTrack)
      return nullptr;
   auto &track = *pTrack;
   // do not create on demand if it is null
   return track.AttachedObjects::Find< TrackView >( key );
}

References key.

Referenced by Find(), and WaveTrackView::Find().

Here is the caller graph for this function:

◆ Get() [1/2]

const TrackView & TrackView::Get ( const Track & track )

static

Definition at line 74 of file TrackView.cpp.

{
   return Get( const_cast< Track & >( track ) );
}

References Get().

Here is the call graph for this function:

◆ Get() [2/2]

TrackView & TrackView::Get ( Track & track )

static

Definition at line 69 of file TrackView.cpp.

{
   return track.AttachedObjects::Get< TrackView >( key );
}

References key.

Referenced by SetTrackVisualsCommand::ApplyInner(), TrackPanelResizeHandle::Cancel(), anonymous_namespace{TrackPanel.cpp}::Subgroup::Children(), anonymous_namespace{TrackPanel.cpp}::ChannelGroup::Children(), TrackPanelResizeHandle::Click(), LabelDefaultClickHandle::Click(), MinimizeButtonHandle::CommitChanges(), WaveTrackView::CopySelectedText(), LabelTrackView::CopyTo(), WaveTrackView::CopyTo(), CopyTo(), WaveTrackView::CutSelectedText(), ProjectAudioManager::DoRecord(), anonymous_namespace{ViewMenus.cpp}::DoZoomFitV(), TrackPanelResizeHandle::Drag(), anonymous_namespace{TrackPanel.cpp}::ChannelGroup::Draw(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), anonymous_namespace{TrackPanel.cpp}::FindAdjustedChannelHeights(), anonymous_namespace{WaveTrackAffordanceControls.cpp}::FindAffordance(), SpectrumView::ForAll(), Get(), LabelTrackView::Get(), WaveTrackView::Get(), GetCumulativeHeight(), TrackPanel::GetFocusedCell(), GetTrackHeight(), NoteTrackAffordanceControls::HitTest(), WaveTrackAffordanceControls::HitTest(), TrackInfo::MinimizeSyncLockDrawFunction(), ViewActions::Handler::OnCollapseAllTracks(), ViewActions::Handler::OnExpandAllTracks(), WaveTrackMenuTable::OnMergeStereo(), anonymous_namespace{Printing.cpp}::AudacityPrintout::OnPrintPage(), ScreenshotBigDialog::OnShortTracks(), SelectHandle::TimerHandler::OnTimer(), TrackPanel::OnTrackMenu(), anonymous_namespace{TrackView.cpp}::TrackPositioner::OnUpdate(), WaveTrackView::PasteText(), SpectralDataManager::ProcessTracks(), TrackPanel::RefreshTrack(), WaveTrackView::SelectAllText(), ScreenshotBigDialog::SizeTracks(), WaveTrackMenuTable::SplitStereo(), MinimizeButtonHandle::Tip(), TrackPanelResizeHandle::TrackPanelResizeHandle(), and TrackPanel::UpdateTrackVRuler().

Here is the caller graph for this function:

◆ GetAffordanceControls()

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

virtual

Reimplemented in NoteTrackView, and WaveTrackView.

Definition at line 183 of file TrackView.cpp.

{
   return {};
}

◆ GetChannelGroupHeight()

int TrackView::GetChannelGroupHeight ( const Track * pTrack )

static

Definition at line 34 of file TrackView.cpp.

{
   return pTrack ? TrackList::Channels( pTrack ).sum( GetTrackHeight ) : 0;
}

References TrackList::Channels(), and GetTrackHeight().

Referenced by TrackSelectHandle::CalculateRearrangingThresholds(), and TrackPanel::VerticalScroll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCumulativeHeight()

int TrackView::GetCumulativeHeight ( const Track * pTrack )

static

Definition at line 39 of file TrackView.cpp.

{
   if ( !pTrack )
      return 0;
   auto &view = Get( *pTrack );
   return view.GetCumulativeHeightBefore() + view.GetHeight();
}

References Get().

Referenced by GetTotalHeight(), and anonymous_namespace{TrackView.cpp}::TrackPositioner::OnUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCumulativeHeightBefore()

int TrackView::GetCumulativeHeightBefore ( ) const

inline

Returns: cached sum of GetHeight() of all preceding tracks

Definition at line 56 of file TrackView.h.

56{ return mY; }

◆ GetExpandedHeight()

int TrackView::GetExpandedHeight ( ) const

inline

Returns: height of the track when expanded

See other comments for GetHeight

Definition at line 60 of file TrackView.h.

60{ return mHeight; }

Referenced by WriteXMLAttributes().

Here is the caller graph for this function:

◆ GetHeight()

int TrackView::GetHeight ( ) const

Returns: height of the track as it now appears, expanded or collapsed

Total "height" of channels of a track includes padding areas above and below it, and is pixel-accurate for the channel group. The "heights" of channels within a group determine the proportions of heights of the track data shown – but the actual total pixel heights may differ when other fixed-height adornments and paddings are added, according to other rules for allocation of height.

Definition at line 164 of file TrackView.cpp.

{
   if ( GetMinimized() )
      return GetMinimizedHeight();
 
   return mHeight;
}

References GetMinimized(), GetMinimizedHeight(), and mHeight.

Referenced by TrackPanelResizeHandle::Click(), anonymous_namespace{TrackPanel.cpp}::DrawTrackName(), and GetTrackHeight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMinimized()

bool TrackView::GetMinimized ( ) const

inline

Definition at line 52 of file TrackView.h.

52{ return mMinimized; }

Referenced by WaveTrackView::BuildSubViews(), TrackPanelResizeHandle::Click(), MinimizeButtonHandle::CommitChanges(), anonymous_namespace{ViewMenus.cpp}::DoZoomFitV(), GetHeight(), TrackInfo::MinimizeSyncLockDrawFunction(), WaveTrackMenuTable::OnMergeStereo(), MinimizeButtonHandle::Tip(), and WriteXMLAttributes().

Here is the caller graph for this function:

◆ GetMinimizedHeight()

virtual int TrackView::GetMinimizedHeight ( ) const

pure virtual

Returns: height of the track when collapsed

See other comments for GetHeight

Implemented in CommonTrackView.

Referenced by GetHeight().

Here is the caller graph for this function:

◆ GetSubViews()

auto TrackView::GetSubViews ( const wxRect & rect )

virtual

Reimplemented in WaveTrackView.

Definition at line 131 of file TrackView.cpp.

{
   return { { rect.GetTop(), shared_from_this() } };
}

Referenced by anonymous_namespace{TrackPanel.cpp}::ChannelGroup::Children().

Here is the caller graph for this function:

◆ GetTotalHeight()

int TrackView::GetTotalHeight ( const TrackList & list )

static

Definition at line 47 of file TrackView.cpp.

{
   return GetCumulativeHeight( *list.Any().rbegin() );
}

References TrackList::Any(), and GetCumulativeHeight().

Referenced by ProjectWindow::FixScrollbars(), and anonymous_namespace{Printing.cpp}::AudacityPrintout::OnPrintPage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTrackHeight()

int TrackView::GetTrackHeight ( const Track * pTrack )

static

Definition at line 29 of file TrackView.cpp.

{
   return pTrack ? Get( *pTrack ).GetHeight() : 0;
}

References Get(), and GetHeight().

Referenced by anonymous_namespace{ViewMenus.cpp}::DoZoomFitV(), GetChannelGroupHeight(), TrackPanel::OnEnsureVisible(), and TrackPanel::RefreshTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVRulerControls() [1/2]

std::shared_ptr< TrackVRulerControls > TrackView::GetVRulerControls ( )

Definition at line 146 of file TrackView.cpp.

{
   if (!mpVRulerControls)
      // create on demand
      mpVRulerControls = DoGetVRulerControls();
   return mpVRulerControls;
}

References DoGetVRulerControls(), and mpVRulerControls.

Referenced by TrackVRulerControls::Get(), and GetVRulerControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVRulerControls() [2/2]

std::shared_ptr< const TrackVRulerControls > TrackView::GetVRulerControls ( ) const

Definition at line 154 of file TrackView.cpp.

{
   return const_cast< TrackView* >( this )->GetVRulerControls();
}

References GetVRulerControls().

Here is the call graph for this function:

◆ HandleXMLAttribute()

bool TrackView::HandleXMLAttribute	(	const std::string_view &	attr,
		const XMLAttributeValueView &	valueView
	)

overridevirtual

Deserialize an attribute, returning true if recognized.

default recognizes no attributes, and returns false

Reimplemented from TrackAttachment.

Definition at line 110 of file TrackView.cpp.

{
   long nValue;
 
   if (attr == "height" && valueView.TryGet(nValue)) {
      // Bug 2803: Extreme values for track height (caused by integer overflow)
      // will stall Audacity as it tries to create an enormous vertical ruler.
      // So clamp to reasonable values.
      nValue = std::max( 40l, std::min( nValue, 1000l ));
      SetExpandedHeight(nValue);
      return true;
   }
   else if ( attr == "minimized" && valueView.TryGet(nValue)) {
      SetMinimized(nValue != 0);
      return true;
   }
   else
      return false;
}

References min(), SetExpandedHeight(), SetMinimized(), and XMLAttributeValueView::TryGet().

Here is the call graph for this function:

◆ IsSpectral()

bool TrackView::IsSpectral ( ) const

virtual

Reimplemented in SpectrumView.

Definition at line 136 of file TrackView.cpp.

{
   return false;
}

Referenced by anonymous_namespace{BrushHandle.cpp}::isSpectralSelectionView(), and anonymous_namespace{SelectHandle.cpp}::isSpectralSelectionView().

Here is the caller graph for this function:

◆ operator=()

TrackView & TrackView::operator= ( const TrackView & )

privatedelete

◆ SetCumulativeHeightBefore()

void TrackView::SetCumulativeHeightBefore ( int y )

inline

Set cached value dependent on position within the track list.

Definition at line 78 of file TrackView.h.

78{ DoSetY( y ); }

TrackView::DoSetY

void DoSetY(int y)

Definition: TrackView.cpp:159

◆ SetExpandedHeight()

void TrackView::SetExpandedHeight ( int height )

Sets height for expanded state. Does not expand a track if it is now collapsed. See other comments for GetHeight

Definition at line 172 of file TrackView.cpp.

{
   DoSetHeight(h);
   FindTrack()->AdjustPositions();
}

References DoSetHeight(), and CommonTrackPanelCell::FindTrack().

Referenced by SetTrackVisualsCommand::ApplyInner(), TrackPanelResizeHandle::Click(), anonymous_namespace{ViewMenus.cpp}::DoZoomFitV(), HandleXMLAttribute(), ScreenshotBigDialog::SizeTracks(), and WaveTrackMenuTable::SplitStereo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMinimized()

void TrackView::SetMinimized ( bool minimized )

Definition at line 93 of file TrackView.cpp.

{
   // Do special changes appropriate to subclass
   DoSetMinimized(isMinimized);
 
   // Update positions and heights starting from the first track in the group
   auto leader = *TrackList::Channels( FindTrack().get() ).begin();
   if ( leader )
      leader->AdjustPositions();
}

References TrackList::Channels(), DoSetMinimized(), and CommonTrackPanelCell::FindTrack().

Referenced by MinimizeButtonHandle::CommitChanges(), ProjectAudioManager::DoRecord(), HandleXMLAttribute(), ViewActions::Handler::OnCollapseAllTracks(), and ViewActions::Handler::OnExpandAllTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteXMLAttributes()

void TrackView::WriteXMLAttributes ( XMLWriter & ) const

overridevirtual

Serialize persistent attributes.

default does nothing

Reimplemented from TrackAttachment.

Definition at line 104 of file TrackView.cpp.

{
   xmlFile.WriteAttr(wxT("height"), GetExpandedHeight());
   xmlFile.WriteAttr(wxT("minimized"), GetMinimized());
}

References GetExpandedHeight(), GetMinimized(), XMLWriter::WriteAttr(), and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ mHeight

int TrackView::mHeight { DefaultHeight }

private

Definition at line 130 of file TrackView.h.

Referenced by CopyTo(), DoSetHeight(), and GetHeight().

◆ mMinimized

bool TrackView::mMinimized { false }

private

Definition at line 128 of file TrackView.h.

Referenced by CopyTo(), and DoSetMinimized().

◆ mpVRulerControls

std::shared_ptr<TrackVRulerControls> TrackView::mpVRulerControls

protected

Definition at line 125 of file TrackView.h.

Referenced by GetVRulerControls().

◆ mY

int TrackView::mY { 0 }

private

Definition at line 129 of file TrackView.h.

Referenced by DoSetY().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Refinement

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TrackView() [1/2]

◆ TrackView() [2/2]

◆ ~TrackView()

Member Function Documentation

◆ CopyTo()

◆ DoGetVRulerControls()

◆ DoSetHeight()

◆ DoSetMinimized()

◆ DoSetY()

◆ Find() [1/2]

◆ Find() [2/2]

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAffordanceControls()

◆ GetChannelGroupHeight()

◆ GetCumulativeHeight()

◆ GetCumulativeHeightBefore()

◆ GetExpandedHeight()

◆ GetHeight()

◆ GetMinimized()

◆ GetMinimizedHeight()

◆ GetSubViews()

◆ GetTotalHeight()

◆ GetTrackHeight()

◆ GetVRulerControls() [1/2]

◆ GetVRulerControls() [2/2]

◆ HandleXMLAttribute()

◆ IsSpectral()

◆ operator=()

◆ SetCumulativeHeightBefore()

◆ SetExpandedHeight()

◆ SetMinimized()

◆ WriteXMLAttributes()

Member Data Documentation

◆ mHeight

◆ mMinimized

◆ mpVRulerControls

◆ mY