#include <CommonTrackControls.h>

Inheritance diagram for CommonTrackControls:

Collaboration diagram for CommonTrackControls:

Classes
struct	InitMenuData

Public Member Functions
virtual const TCPLines &	GetTCPLines () const

	TrackControls (std::shared_ptr< Track > pTrack)

Public Member Functions inherited from TrackControls
	TrackControls (std::shared_ptr< Track > pTrack)

virtual	~TrackControls ()=0

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 const TCPLines &	StaticTCPLines ()

Static Public Member Functions inherited from TrackControls
static TrackControls &	Get (Track &track)

static const TrackControls &	Get (const Track &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::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *) override=0

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

virtual PopupMenuTable *	GetMenuExtension (Track *pTrack)=0

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

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

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< CloseButtonHandle >	mCloseHandle

std::weak_ptr< MenuButtonHandle >	mMenuHandle

std::weak_ptr< MinimizeButtonHandle >	mMinimizeHandle

std::weak_ptr< SelectButtonHandle >	mSelectButtonHandle

std::weak_ptr< TrackSelectHandle >	mSelectHandle

Detailed Description

Definition at line 26 of file CommonTrackControls.h.

Member Function Documentation

◆ DoContextMenu()

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

overrideprotectedvirtual

Reimplemented from TrackPanelCell.

Definition at line 273 of file CommonTrackControls.cpp.

{
   using namespace RefreshCode;
   wxRect buttonRect;
   TrackInfo::GetTitleBarRect(rect, buttonRect);
 
   auto track = FindTrack();
   if (!track)
      return RefreshNone;
 
   InitMenuData data{ *pProject, track.get(), pParent, RefreshNone };
 
   const auto pTable = &TrackMenuTable::Instance();
   auto pMenu = PopupMenuTable::BuildMenu(pTable, &data);
 
   PopupMenuTable *const pExtension = GetMenuExtension(track.get());
   if (pExtension)
      PopupMenuTable::ExtendMenu( *pMenu, *pExtension );
 
   pMenu->Popup( *pParent,
      { buttonRect.x + 1, buttonRect.y + buttonRect.height + 1 } );
 
   return data.result;
}

References PopupMenuTable::BuildMenu(), PopupMenuTable::ExtendMenu(), CommonTrackPanelCell::FindTrack(), GetMenuExtension(), TrackInfo::GetTitleBarRect(), TrackMenuTable::Instance(), and RefreshCode::RefreshNone.

Here is the call graph for this function:

◆ Draw()

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

overrideprotectedvirtual

Reimplemented from TrackPanelDrawable.

Definition at line 354 of file CommonTrackControls.cpp.

{
   if ( iPass == TrackArtist::PassMargins ) {
      // fill in label
      auto dc = &context.dc;
      const auto pTrack = FindTrack();
      AColor::MediumTrackInfo( dc, pTrack && pTrack->GetSelected() );
      dc->DrawRectangle( rect_ );
   }
 
   if ( iPass == TrackArtist::PassControls ) {
      // Given rectangle excludes left and right margins, and encompasses a
      // channel group of tracks, plus the resizer area below
      auto pTrack = FindTrack();
      // First counteract DrawingArea() correction
      wxRect rect{ rect_.x, rect_.y, rect_.width - 1, rect_.height };
   
      // Vaughan, 2010-08-24: No longer doing this.
      // Draw sync-lock tiles in ruler area.
      //if (SyncLock::IsSyncLockSelected(t)) {
      //   wxRect tileFill = rect;
      //   tileFill.x = mViewInfo->GetVRulerOffset();
      //   tileFill.width = mViewInfo->GetVRulerWidth();
      //   TrackArt::DrawSyncLockTiles(dc, tileFill);
      //}
 
      if (pTrack)
         // Draw things within the track control panel
         TrackInfo::DrawItems( context, rect, *pTrack );
 
      //mTrackInfo.DrawBordersWithin( dc, rect, *t );
   }
 
   // Some old cut-and-paste legacy from TrackPanel.cpp here:
#undef USE_BEVELS
#ifdef USE_BEVELS
   // This branch is not now used
   // PRL:  todo:  banish magic numbers.
   // PRL: vrul was the x coordinate of left edge of the vertical ruler.
   // PRL: bHasMuteSolo was true iff the track was WaveTrack.
   if( bHasMuteSolo )
   {
      int ylast = rect.height-20;
      int ybutton = wxMin(32,ylast-17);
      int ybuttonEnd = 67;
 
      fill=wxRect( rect.x+1, rect.y+17, vrul-6, ybutton);
      AColor::BevelTrackInfo( *dc, true, fill );
   
      if( ybuttonEnd < ylast ){
         fill=wxRect( rect.x+1, rect.y+ybuttonEnd, fill.width, ylast - ybuttonEnd);
         AColor::BevelTrackInfo( *dc, true, fill );
      }
   }
   else
   {
      fill=wxRect( rect.x+1, rect.y+17, vrul-6, rect.height-37);
      AColor::BevelTrackInfo( *dc, true, fill );
   }
#endif
 
}

References AColor::BevelTrackInfo(), TrackPanelDrawingContext::dc, TrackInfo::DrawItems(), CommonTrackPanelCell::FindTrack(), AColor::MediumTrackInfo(), TrackArtist::PassControls, and TrackArtist::PassMargins.

Here is the call graph for this function:

◆ DrawingArea()

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

overrideprotectedvirtual

Reimplemented from TrackPanelDrawable.

Definition at line 419 of file CommonTrackControls.cpp.

{
   if ( iPass == TrackArtist::PassControls )
      // Some bevels spill out right
      return { rect.x, rect.y, rect.width + 1, rect.height };
   else
      return rect;
}

References TrackArtist::PassControls.

◆ GetMenuExtension()

virtual PopupMenuTable * CommonTrackControls::GetMenuExtension ( Track * pTrack )

protectedpure virtual

Implemented in LabelTrackControls, NoteTrackControls, WaveTrackControls, and TimeTrackControls.

Referenced by DoContextMenu().

Here is the caller graph for this function:

◆ GetTCPLines()

const TCPLines & CommonTrackControls::GetTCPLines ( ) const

virtual

Reimplemented in NoteTrackControls, and WaveTrackControls.

Definition at line 191 of file TrackInfo.cpp.

{
   return commonTrackTCPLines();
}

References commonTrackTCPLines().

Referenced by TrackInfo::DrawItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HitTest()

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

overrideprotectedpure virtual

Implements TrackPanelCell.

Implemented in LabelTrackControls, NoteTrackControls, WaveTrackControls, and TimeTrackControls.

Definition at line 35 of file CommonTrackControls.cpp.

{
   // Hits are mutually exclusive, results single
 
   const wxMouseState &state = st.state;
   const wxRect &rect = st.rect;
   UIHandlePtr result;
   std::vector<UIHandlePtr> results;
 
   auto sThis = shared_from_this();
 
   if (NULL != (result = CloseButtonHandle::HitTest(
      mCloseHandle, state, rect, this)))
      results.push_back(result);
 
   if (NULL != (result = MenuButtonHandle::HitTest(
      mMenuHandle, state, rect, sThis)))
      results.push_back(result);
 
   if (NULL != (result = MinimizeButtonHandle::HitTest(
      mMinimizeHandle, state, rect, this)))
      results.push_back(result);
 
   if (NULL != (result = SelectButtonHandle::HitTest(
      mSelectButtonHandle, state, rect, this)))
      results.push_back(result);
 
   if (results.empty()) {
      if (NULL != (result = TrackSelectHandle::HitAnywhere(
         mSelectHandle, FindTrack())))
         results.push_back(result);
   }
 
   return results;
}

References CommonTrackPanelCell::FindTrack(), TrackSelectHandle::HitAnywhere(), CloseButtonHandle::HitTest(), MenuButtonHandle::HitTest(), MinimizeButtonHandle::HitTest(), SelectButtonHandle::HitTest(), mCloseHandle, mMenuHandle, mMinimizeHandle, mSelectButtonHandle, mSelectHandle, TrackPanelMouseState::rect, and TrackPanelMouseState::state.

Referenced by LabelTrackControls::HitTest(), NoteTrackControls::HitTest(), WaveTrackControls::HitTest(), and TimeTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StaticTCPLines()

const TCPLines & CommonTrackControls::StaticTCPLines ( )

static

Definition at line 123 of file TrackInfo.cpp.

{
   return commonTrackTCPLines();
}

References commonTrackTCPLines().

Referenced by PlayableTrackControls::StaticNoteTCPLines(), and PlayableTrackControls::StaticWaveTCPLines().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrackControls()

TrackControls::TrackControls ( std::shared_ptr< Track > pTrack )

explicit

Definition at line 26 of file TrackControls.cpp.

   : CommonTrackCell{ pTrack }
{
}

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

Here is the call graph for this function:

Member Data Documentation

◆ mCloseHandle

std::weak_ptr<CloseButtonHandle> CommonTrackControls::mCloseHandle

protected

Definition at line 70 of file CommonTrackControls.h.

Referenced by HitTest().

◆ mMenuHandle

std::weak_ptr<MenuButtonHandle> CommonTrackControls::mMenuHandle

protected

Definition at line 71 of file CommonTrackControls.h.

Referenced by HitTest().

◆ mMinimizeHandle

std::weak_ptr<MinimizeButtonHandle> CommonTrackControls::mMinimizeHandle

protected

Definition at line 72 of file CommonTrackControls.h.

Referenced by HitTest().

◆ mSelectButtonHandle

std::weak_ptr<SelectButtonHandle> CommonTrackControls::mSelectButtonHandle

protected

Definition at line 73 of file CommonTrackControls.h.

Referenced by HitTest().

◆ mSelectHandle

std::weak_ptr<TrackSelectHandle> CommonTrackControls::mSelectHandle

protected

Definition at line 74 of file CommonTrackControls.h.

Referenced by HitTest().

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ DoContextMenu()

◆ Draw()

◆ DrawingArea()

◆ GetMenuExtension()

◆ GetTCPLines()

◆ HitTest()

◆ StaticTCPLines()

◆ TrackControls()

Member Data Documentation

◆ mCloseHandle

◆ mMenuHandle

◆ mMinimizeHandle

◆ mSelectButtonHandle

◆ mSelectHandle