Class representing the background of a Track. It provides the hit test function that tells us what was hit. More...

#include <BackgroundCell.h>

Inheritance diagram for BackgroundCell:

Collaboration diagram for BackgroundCell:

Public Member Functions
	BackgroundCell (AudacityProject *pProject)

virtual	~BackgroundCell ()

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 ClientData::Base
virtual	~Base ()

Static Public Member Functions
static BackgroundCell &	Get (AudacityProject &project)

static const BackgroundCell &	Get (const AudacityProject &project)

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)

Public Attributes
std::weak_ptr< ZoomHandle >	mZoomHandle

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

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

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

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

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

Private Attributes
AudacityProject *	mpProject

std::weak_ptr< BackgroundHandle >	mHandle

Detailed Description

Class representing the background of a Track. It provides the hit test function that tells us what was hit.

Definition at line 25 of file BackgroundCell.h.

Constructor & Destructor Documentation

◆ BackgroundCell()

BackgroundCell::BackgroundCell ( AudacityProject * pProject )

inlineexplicit

Definition at line 34 of file BackgroundCell.h.

35 : mpProject(pProject)

36 {}

BackgroundCell::mpProject

AudacityProject * mpProject

Definition: BackgroundCell.h:61

◆ ~BackgroundCell()

BackgroundCell::~BackgroundCell ( )

virtual

Definition at line 109 of file BackgroundCell.cpp.

110{

111}

Member Function Documentation

◆ DoFindTrack()

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

overrideprotectedvirtual

Implements CommonTrackPanelCell.

Definition at line 121 of file BackgroundCell.cpp.

{
   return {};
}

◆ Draw()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 126 of file BackgroundCell.cpp.

{
   if ( iPass == TrackArtist::PassBackground ) {
      auto &dc = context.dc;
      // Paint over the part below the tracks
      AColor::TrackPanelBackground( &dc, false );
      dc.DrawRectangle( rect );
   }
}

References TrackPanelDrawingContext::dc, TrackArtist::PassBackground, and AColor::TrackPanelBackground().

Here is the call graph for this function:

◆ DrawingArea()

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

overrideprivatevirtual

Reimplemented from TrackPanelDrawable.

Definition at line 138 of file BackgroundCell.cpp.

{
   if ( iPass == TrackArtist::PassBackground )
      // If there are any tracks, extend the drawing area up, to cover the
      // bottom ends of any zooming guide lines.
      return {
         rect.x,
         rect.y - kTopMargin,
         rect.width,
         rect.height + kTopMargin
      };
   else
      return rect;
}

References kTopMargin, and TrackArtist::PassBackground.

◆ Get() [1/2]

BackgroundCell & BackgroundCell::Get ( AudacityProject & project )

static

Definition at line 99 of file BackgroundCell.cpp.

{
   return project.AttachedObjects::Get< BackgroundCell >( key );
}

References key, and project.

Referenced by Get(), and CommonChannelView::HitTest().

Here is the caller graph for this function:

◆ Get() [2/2]

const BackgroundCell & BackgroundCell::Get ( const AudacityProject & project )

static

Definition at line 104 of file BackgroundCell.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get(), and project.

Here is the call graph for this function:

◆ GetMenuItems()

auto BackgroundCell::GetMenuItems	(	const wxRect &	rect,
		const wxPoint *	pPosition,
		AudacityProject *	pProject
	)

overrideprivatevirtual

Return a list of items for DoContextMenu() (empties for separators)

If the vector is empty (as in the default), there is no context menu.

Commands are invoked with temporary selection fields of CommandContext set to a point selected region at the mouse pick, and the cell's track.

A function may be given, but if it is null, then the command can be found by name in the CommandManager.

An item in the list with no command name marks a menu separator.

The menu item is enabled only if it contains a true flag, but if looked up in the command manager, it must also satisfy the command manager's conditions.

Reimplemented from CommonTrackPanelCell.

Definition at line 155 of file BackgroundCell.cpp.

{
   // These commands exist in toolbar menus too, but maybe with other labels
   // TODO: devise a system of registration so that BackgroundCell has no
   // special knowledge about track sub-types
   return {
      { L"NewMonoTrack", XO("Add Mono Track")},
      { L"NewStereoTrack", XO("Add Stereo Track") },
      { L"NewLabelTrack", XO("Add Label Track"),  },
      {},
      { L"Export", XO("Export Audio..."),  },
      {},
      { L"SelectAll", XO("Select All") },
   };
}

References XO().

Here is the call graph for this function:

◆ HitTest()

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

overrideprotectedvirtual

Implements TrackPanelCell.

Definition at line 113 of file BackgroundCell.cpp.

{
   auto result = AssignUIHandlePtr(mHandle, std::make_shared<BackgroundHandle>());
   return { result };
}

References AssignUIHandlePtr(), and mHandle.

Here is the call graph for this function:

Member Data Documentation

◆ mHandle

std::weak_ptr<BackgroundHandle> BackgroundCell::mHandle

private

Definition at line 63 of file BackgroundCell.h.

Referenced by HitTest().

◆ mpProject

AudacityProject* BackgroundCell::mpProject

private

Definition at line 61 of file BackgroundCell.h.

◆ mZoomHandle

std::weak_ptr<ZoomHandle> BackgroundCell::mZoomHandle

mutable

Definition at line 67 of file BackgroundCell.h.

Referenced by CommonChannelView::HitTest().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BackgroundCell()

◆ ~BackgroundCell()

Member Function Documentation

◆ DoFindTrack()

◆ Draw()

◆ DrawingArea()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetMenuItems()

◆ HitTest()

Member Data Documentation

◆ mHandle

◆ mpProject

◆ mZoomHandle