CommonChannelCell Class Reference

#include <CommonTrackPanelCell.h>

Inheritance diagram for CommonChannelCell:

Collaboration diagram for CommonChannelCell:

Public Member Functions
	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...

Private Member Functions
std::shared_ptr< Channel >	DoFindChannel ()
std::shared_ptr< const Channel >	DoFindChannel () const

Private Attributes
std::weak_ptr< Channel >	mwChannel

Additional Inherited Members
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 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

Detailed Description

Definition at line 118 of file CommonTrackPanelCell.h.

Constructor & Destructor Documentation

CommonChannelCell()

CommonChannelCell::CommonChannelCell

(

const std::shared_ptr< Channel > &

pChannel

)

Construct from a channel.

Definition at line 135 of file CommonTrackPanelCell.cpp.

   : mwChannel{ parent }
{
}

~CommonChannelCell()

CommonChannelCell::~CommonChannelCell ( )

default

Member Function Documentation

DoFindChannel() [1/2]

std::shared_ptr< Channel > CommonChannelCell::DoFindChannel ( )

private

Definition at line 156 of file CommonTrackPanelCell.cpp.

{
   return mwChannel.lock();
}

References mwChannel.

DoFindChannel() [2/2]

std::shared_ptr< const Channel > CommonChannelCell::DoFindChannel ( ) const

private

Definition at line 161 of file CommonTrackPanelCell.cpp.

{
   return const_cast<CommonChannelCell*>(this)->FindChannel();
}

References FindChannel().

Here is the call graph for this function:

DoFindTrack()

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

overridevirtual

Implements CommonTrackPanelCell.

Definition at line 148 of file CommonTrackPanelCell.cpp.

{
   Track *pTrack{};
   if (const auto pChannel = mwChannel.lock())
      pTrack = dynamic_cast<Track *>(&pChannel->GetChannelGroup());
   return pTrack ? pTrack->SharedPointer() : nullptr;
}

References mwChannel, and Track::SharedPointer().

Referenced by NoteTrackView::GetAffordanceControls().

Here is the call graph for this function:

Here is the caller graph for this function:

FindChannel() [1/2]

template<typename Subtype = Channel>

auto CommonChannelCell::FindChannel ( ) -> std::shared_ptr<Subtype>

inline

May return null.

Definition at line 134 of file CommonTrackPanelCell.h.

         { return std::dynamic_pointer_cast<Subtype>(DoFindChannel()); }

Referenced by anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), DoFindChannel(), TimeShiftHandle::Drag(), LabelTrackView::Draw(), TrackPanelResizerCell::Draw(), NoteTrackView::Draw(), SpectrumView::Draw(), WaveformView::Draw(), TimeTrackView::Draw(), CommonChannelView::GetMinimizedHeight(), TrackPanelResizerCell::HitTest(), SubViewCloseHandle::HitTest(), anonymous_namespace{SelectHandle.cpp}::isSpectralSelectionView(), anonymous_namespace{BrushHandle.cpp}::isSpectralSelectionView(), SelectHandle::MoveSnappingFreqSelection(), and SelectHandle::StartFreqSelection().

Here is the caller graph for this function:

FindChannel() [2/2]

template<typename Subtype = const Channel>

auto CommonChannelCell::FindChannel ( ) const -> std::enable_if_t<std::is_const_v<Subtype>, std::shared_ptr<Subtype> >

inline

May return null.

Definition at line 140 of file CommonTrackPanelCell.h.

         { return std::dynamic_pointer_cast<Subtype>(DoFindChannel()); }

Reparent()

void CommonChannelCell::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 142 of file CommonTrackPanelCell.cpp.

{
   mwChannel = parent->NthChannel(iChannel);
}

References anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, and mwChannel.

Referenced by ChannelView::Reparent().

Here is the caller graph for this function:

Member Data Documentation

mwChannel

std::weak_ptr<Channel> CommonChannelCell::mwChannel

private

Definition at line 150 of file CommonTrackPanelCell.h.

Referenced by DoFindChannel(), DoFindTrack(), and Reparent().

---

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

• CommonTrackPanelCell.h
• CommonTrackPanelCell.cpp