CommonTrackInfo Namespace Reference

Functions for drawing the track control panel, which is shown to the side of a track It has the menus, pan and gain controls displayed in it. So "Info" is somewhat a misnomer. Should possibly be "TrackControls". More...

Typedefs
using	TCPLine = TrackInfo::TCPLine
using	TCPLines = TrackInfo::TCPLines

Functions
AUDACITY_DLL_API unsigned	MinimumTrackHeight ()
AUDACITY_DLL_API unsigned	DefaultTrackHeight (const TCPLines &topLines)
AUDACITY_DLL_API void	DrawItems (TrackPanelDrawingContext &context, const wxRect &rect, const Track &track)
AUDACITY_DLL_API void	DrawItems (TrackPanelDrawingContext &context, const wxRect &rect, const Track *pTrack, const std::vector< TCPLine > &topLines, const std::vector< TCPLine > &bottomLines)
AUDACITY_DLL_API void	DrawCloseButton (TrackPanelDrawingContext &context, const wxRect &bev, const Channel *pChannel, UIHandle *target)
AUDACITY_DLL_API void	CloseTitleDrawFunction (TrackPanelDrawingContext &context, const wxRect &rect, const Track *pTrack)
AUDACITY_DLL_API void	SyncLockDrawFunction (TrackPanelDrawingContext &context, const wxRect &rect, const Track *pTrack)
AUDACITY_DLL_API void	GetCloseBoxHorizontalBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetCloseBoxRect (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetTrackTitleHorizontalBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetTrackTitleRect (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetSliderHorizontalBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetTrackMenuButtonBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetTrackMenuButtonRect (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetMinimizeHorizontalBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetMinimizeRect (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetSyncLockHorizontalBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetSyncLockIconRect (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API bool	HideTopItem (const wxRect &rect, const wxRect &subRect, int allowance=0)
AUDACITY_DLL_API const TCPLines &	StaticTCPLines ()

Variables
static constexpr auto	Margin = 4
static constexpr auto	ToolButtonSize = 16

Detailed Description

Functions for drawing the track control panel, which is shown to the side of a track It has the menus, pan and gain controls displayed in it. So "Info" is somewhat a misnomer. Should possibly be "TrackControls".

It maintains global slider widget instances that are reparented and repositioned as needed for drawing and interaction with the user, interoperating with the custom panel subdivision implemented in CellularPanel and avoiding wxWidgets sizers

If we'd instead coded it as a wxWindow, we would have an instance of this class for each track displayed.

Typedef Documentation

TCPLine

using CommonTrackInfo::TCPLine = typedef TrackInfo::TCPLine

Definition at line 20 of file CommonTrackInfo.h.

TCPLines

using CommonTrackInfo::TCPLines = typedef TrackInfo::TCPLines

Definition at line 21 of file CommonTrackInfo.h.

Function Documentation

CloseTitleDrawFunction()

void CommonTrackInfo::CloseTitleDrawFunction	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		const Track *	pTrack
	)

Definition at line 219 of file CommonTrackInfo.cpp.

{
   const auto dc = &context.dc;
 
   const auto target = context.target.get();
   const auto hit = target && target->FindTrack().get() == pTrack;
   const auto captured = hit && target->IsDragging();
 
   {  //close button
      wxRect bev = rect;
      GetCloseBoxHorizontalBounds( rect, bev );
 
      DrawToolButtonBackground(context, bev, captured);
 
      dc->DrawBitmap(theTheme.Bitmap(tcpClose), bev.GetLeftTop());
   }
 
   {  //track title
      wxRect bev = rect;
      GetTrackTitleHorizontalBounds( rect, bev );
      const auto titleStr = TrackArt::TruncateText(*dc,
         pTrack ? pTrack->GetName() : _("Name"), bev.width);
 
      TrackInfo::SetTrackInfoFont(dc);
      const auto metrics = dc->GetFontMetrics();
 
      dc->SetTextForeground( theTheme.Colour( clrTrackPanelText ) );
      dc->SetTextBackground( wxTRANSPARENT );
      dc->DrawText(titleStr, bev.x + 2, bev.y + (bev.height - (metrics.ascent + metrics.descent)) / 2);
 
   }
 
   {  //minimize button
      const auto minimized =
         pTrack ? ChannelView::Get(*pTrack->GetChannel(0)).GetMinimized() : false;
 
      wxRect bev = rect;
      GetMinimizeHorizontalBounds(rect, bev);
 
      DrawToolButtonBackground(context, bev, captured);
 
      dc->DrawBitmap(
         minimized
            ? theTheme.Bitmap(tcpChevronDown)
            : theTheme.Bitmap(tcpChevron),
         bev.GetLeftTop());
 
   }
 
   {  //track menu button
      wxRect bev = rect;
      GetTrackMenuButtonBounds(rect, bev);
 
      DrawToolButtonBackground(context, bev, captured);
 
      dc->DrawBitmap(theTheme.Bitmap(tcpEllipses), bev.GetLeftTop());
   }
 
}

References _, ThemeBase::Bitmap(), ThemeBase::Colour(), TrackPanelDrawingContext::dc, anonymous_namespace{CommonTrackInfo.cpp}::DrawToolButtonBackground(), ChannelView::Get(), ChannelGroup::GetChannel(), GetCloseBoxHorizontalBounds(), ChannelView::GetMinimized(), GetMinimizeHorizontalBounds(), Track::GetName(), GetTrackMenuButtonBounds(), GetTrackTitleHorizontalBounds(), TrackInfo::SetTrackInfoFont(), TrackPanelDrawingContext::target, theTheme, and TrackArt::TruncateText().

Referenced by commonTrackTCPLines().

Here is the call graph for this function:

Here is the caller graph for this function:

DefaultTrackHeight()

unsigned CommonTrackInfo::DefaultTrackHeight

(

const TCPLines &

topLines

)

Definition at line 393 of file CommonTrackInfo.cpp.

{
   int needed =
      kVerticalPadding + Margin * 2 +
      totalTCPLines( topLines, true ) +
      totalTCPLines( commonTrackTCPBottomLines, false ) + 1;
   return (unsigned) std::max(needed, (int) ChannelView::DefaultHeight);
}

References anonymous_namespace{CommonTrackInfo.cpp}::commonTrackTCPBottomLines, ChannelView::DefaultHeight, kVerticalPadding, Margin, and anonymous_namespace{CommonTrackInfo.cpp}::totalTCPLines().

Referenced by NoteTrackControls::DefaultNoteTrackHeight(), and WaveTrackControls::DefaultWaveTrackHeight().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawCloseButton()

void CommonTrackInfo::DrawCloseButton	(	TrackPanelDrawingContext &	context,
		const wxRect &	bev,
		const Channel *	pChannel,
		UIHandle *	target
	)

Definition at line 180 of file CommonTrackInfo.cpp.

{
   auto dc = &context.dc;
   auto pTrack = pChannel
      ? dynamic_cast<const Track*>(&pChannel->GetChannelGroup())
      : nullptr;
   bool selected = pTrack ? pTrack->GetSelected() : true;
   bool hit = target && target->FindTrack().get() == pTrack;
   bool captured = hit && target->IsDragging();
   bool down = captured && bev.Contains( context.lastState.GetPosition());
 
   wxMemoryDC memDC;
 
   if(selected)
      memDC.SelectObject(theTheme.Bitmap(bmpCloseHover));
   else if(down)
      memDC.SelectObject(theTheme.Bitmap(bmpCloseDown));
   else
      memDC.SelectObject(theTheme.Bitmap(bmpCloseNormal));
 
   AColor::Bevel2(*dc, !down, bev, selected, hit);
 
   dc->Blit(bev.GetLeft(), bev.GetTop(), bev.width, bev.height, &memDC, 2, 2);
}

References AColor::Bevel2(), ThemeBase::Bitmap(), TrackPanelDrawingContext::dc, UIHandle::FindTrack(), Channel::GetChannelGroup(), Track::GetSelected(), UIHandle::IsDragging(), TrackPanelDrawingContext::lastState, and theTheme.

Referenced by SubViewCloseHandle::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawItems() [1/2]

void CommonTrackInfo::DrawItems	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		const Track &	track
	)

Definition at line 131 of file CommonTrackInfo.cpp.

{
   auto &trackControl = TrackControls::Get(track);
   const auto &topLines = trackControl.GetTCPLines();
   const auto &bottomLines = commonTrackTCPBottomLines;
   DrawItems
      ( context, rect, &track, topLines, bottomLines );
}

References anonymous_namespace{CommonTrackInfo.cpp}::commonTrackTCPBottomLines, DrawItems(), and TrackControls::Get().

Referenced by CommonTrackControls::Draw(), and DrawItems().

Here is the call graph for this function:

Here is the caller graph for this function:

DrawItems() [2/2]

void CommonTrackInfo::DrawItems	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		const Track *	pTrack,
		const std::vector< TCPLine > &	topLines,
		const std::vector< TCPLine > &	bottomLines
	)

Definition at line 142 of file CommonTrackInfo.cpp.

{
   const auto rect = wxRect(rect_).Deflate(Margin);
   auto dc = &context.dc;
   TrackInfo::SetTrackInfoFont(dc);
   dc->SetTextForeground(theTheme.Colour(clrTrackPanelText));
 
   {
      int yy = 0;
      for ( const auto &line : topLines ) {
         wxRect itemRect{
            rect.x, rect.y + yy,
            rect.width, line.height
         };
         if ( !CommonTrackInfo::HideTopItem( rect, itemRect ) &&
              line.drawFunction )
            line.drawFunction( context, itemRect, pTrack );
         yy += line.height + line.extraSpace;
      }
   }
   {
      int yy = rect.height;
      for ( const auto &line : bottomLines ) {
         yy -= line.height + line.extraSpace;
         if ( line.drawFunction ) {
            wxRect itemRect{
               rect.x, rect.y + yy,
               rect.width, line.height
            };
            line.drawFunction( context, itemRect, pTrack );
         }
      }
   }
}

References ThemeBase::Colour(), TrackPanelDrawingContext::dc, HideTopItem(), Margin, TrackInfo::SetTrackInfoFont(), and theTheme.

Here is the call graph for this function:

GetCloseBoxHorizontalBounds()

void CommonTrackInfo::GetCloseBoxHorizontalBounds	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 304 of file CommonTrackInfo.cpp.

{
   dest.x = rect.x;
   dest.width = ToolButtonSize;
}

References ToolButtonSize.

Referenced by CloseTitleDrawFunction(), GetCloseBoxRect(), and GetTrackTitleHorizontalBounds().

Here is the caller graph for this function:

GetCloseBoxRect()

void CommonTrackInfo::GetCloseBoxRect	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 310 of file CommonTrackInfo.cpp.

{
   const auto rect = wxRect(rect_).Deflate(Margin);
   GetCloseBoxHorizontalBounds( rect, dest );
   auto results = CalcItemY( commonTrackTCPLines(), TCPLine::kItemBarButtons );
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References TrackInfo::CalcItemY(), commonTrackTCPLines(), GetCloseBoxHorizontalBounds(), TrackInfo::TCPLine::kItemBarButtons, and Margin.

Referenced by CloseButtonHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMinimizeHorizontalBounds()

void CommonTrackInfo::GetMinimizeHorizontalBounds	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 360 of file CommonTrackInfo.cpp.

{
   GetTrackMenuButtonBounds(rect, dest);
   dest.x -= ToolButtonSize + Padding;
}

References GetTrackMenuButtonBounds(), anonymous_namespace{CommonTrackInfo.cpp}::Padding, and ToolButtonSize.

Referenced by CloseTitleDrawFunction(), GetMinimizeRect(), and GetTrackTitleHorizontalBounds().

Here is the call graph for this function:

Here is the caller graph for this function:

GetMinimizeRect()

void CommonTrackInfo::GetMinimizeRect	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 366 of file CommonTrackInfo.cpp.

{
   const auto rect = wxRect(rect_).Deflate(Margin);
 
   GetMinimizeHorizontalBounds( rect, dest );
   const auto results = CalcItemY
      ( commonTrackTCPLines(), TCPLine::kItemBarButtons);
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References TrackInfo::CalcItemY(), commonTrackTCPLines(), GetMinimizeHorizontalBounds(), TrackInfo::TCPLine::kItemBarButtons, and Margin.

Referenced by MinimizeButtonHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSliderHorizontalBounds()

void CommonTrackInfo::GetSliderHorizontalBounds	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 339 of file CommonTrackInfo.cpp.

{
   dest.x = rect.x + (rect.width - kTrackInfoSliderWidth) / 2;
   dest.width = kTrackInfoSliderWidth;
}

References kTrackInfoSliderWidth.

Referenced by WaveTrackControls::GetPanRect(), NoteTrackControls::GetVelocityRect(), WaveTrackControls::GetVolumeRect(), anonymous_namespace{NoteTrackControls.cpp}::SliderDrawFunction(), and anonymous_namespace{WaveTrackControls.cpp}::SliderDrawFunction().

Here is the caller graph for this function:

GetSyncLockHorizontalBounds()

void CommonTrackInfo::GetSyncLockHorizontalBounds	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 377 of file CommonTrackInfo.cpp.

{
   dest.width = kTrackInfoBtnSize;
   dest.x = rect.x + rect.width - dest.width;
}

References kTrackInfoBtnSize.

Referenced by GetSyncLockIconRect(), and SyncLockDrawFunction().

Here is the caller graph for this function:

GetSyncLockIconRect()

void CommonTrackInfo::GetSyncLockIconRect	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 383 of file CommonTrackInfo.cpp.

{
   const auto rect = wxRect(rect_).Deflate(Margin);
   GetSyncLockHorizontalBounds( rect, dest );
   auto results = CalcBottomItemY
      ( commonTrackTCPBottomLines, TCPLine::kItemSyncLock, rect.height);
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References anonymous_namespace{CommonTrackInfo.cpp}::CalcBottomItemY(), anonymous_namespace{CommonTrackInfo.cpp}::commonTrackTCPBottomLines, GetSyncLockHorizontalBounds(), TrackInfo::TCPLine::kItemSyncLock, and Margin.

Here is the call graph for this function:

GetTrackMenuButtonBounds()

void CommonTrackInfo::GetTrackMenuButtonBounds	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 345 of file CommonTrackInfo.cpp.

{
   dest.x = rect.x + rect.width - ToolButtonSize;
   dest.width = ToolButtonSize;
}

References ToolButtonSize.

Referenced by CloseTitleDrawFunction(), GetMinimizeHorizontalBounds(), and GetTrackMenuButtonRect().

Here is the caller graph for this function:

GetTrackMenuButtonRect()

void CommonTrackInfo::GetTrackMenuButtonRect	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 351 of file CommonTrackInfo.cpp.

{
   const auto rect = wxRect(rect_).Deflate(Margin);
   GetTrackMenuButtonBounds(rect, dest);
   auto results = TrackInfo::CalcItemY(commonTrackTCPLines(), TCPLine::kItemBarButtons);
   dest.y = rect.y + results.first;
   dest.height = ToolButtonSize;
}

References TrackInfo::CalcItemY(), commonTrackTCPLines(), GetTrackMenuButtonBounds(), TrackInfo::TCPLine::kItemBarButtons, Margin, and ToolButtonSize.

Referenced by CommonTrackControls::DoContextMenu(), and MenuButtonHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrackTitleHorizontalBounds()

void CommonTrackInfo::GetTrackTitleHorizontalBounds	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 319 of file CommonTrackInfo.cpp.

{
   // to right of CloseBoxRect, plus a little more
   wxRect closeRect;
   wxRect minRect;
   GetCloseBoxHorizontalBounds( rect, closeRect );
   GetMinimizeHorizontalBounds( rect, minRect );
   dest.x = rect.x + closeRect.width + Padding;
   dest.width = minRect.x - closeRect.width - closeRect.x;
}

References GetCloseBoxHorizontalBounds(), GetMinimizeHorizontalBounds(), and anonymous_namespace{CommonTrackInfo.cpp}::Padding.

Referenced by CloseTitleDrawFunction(), and GetTrackTitleRect().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrackTitleRect()

void CommonTrackInfo::GetTrackTitleRect	(	const wxRect &	rect,
		wxRect &	dest
	)

Definition at line 330 of file CommonTrackInfo.cpp.

{
   const auto rect = wxRect(rect_).Deflate(Margin);
   GetTrackTitleHorizontalBounds( rect, dest );
   auto results = CalcItemY( commonTrackTCPLines(), TCPLine::kItemBarButtons );
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

References TrackInfo::CalcItemY(), commonTrackTCPLines(), GetTrackTitleHorizontalBounds(), TrackInfo::TCPLine::kItemBarButtons, and Margin.

Here is the call graph for this function:

HideTopItem()

bool CommonTrackInfo::HideTopItem	(	const wxRect &	rect,
		const wxRect &	subRect,
		int	allowance = 0
	)

Definition at line 122 of file CommonTrackInfo.cpp.

                                 {
   auto limit = CalcBottomItemY
   ( commonTrackTCPBottomLines, TCPLine::kHighestBottomItem, rect.height).first;
   // Return true if the rectangle is even touching the limit
   // without an overlap.  That was the behavior as of 2.1.3.
   return subRect.y + subRect.height - allowance >= rect.y + limit;
}

References anonymous_namespace{CommonTrackInfo.cpp}::CalcBottomItemY(), anonymous_namespace{CommonTrackInfo.cpp}::commonTrackTCPBottomLines, and TrackInfo::TCPLine::kHighestBottomItem.

Referenced by DrawItems(), EffectsButtonHandle::HitTest(), MuteButtonHandle::HitTest(), NoteTrackButtonHandle::HitTest(), PanSliderHandle::HitTest(), SoloButtonHandle::HitTest(), VelocitySliderHandle::HitTest(), and VolumeSliderHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

MinimumTrackHeight()

unsigned CommonTrackInfo::MinimumTrackHeight

(

)

Definition at line 110 of file CommonTrackInfo.cpp.

{
   unsigned height = Margin * 2;
   if (!commonTrackTCPLines().empty())
      height += commonTrackTCPLines().front().height;
   if (!commonTrackTCPBottomLines.empty())
      height += commonTrackTCPBottomLines.front().height;
   // + 1 prevents the top item from disappearing for want of enough space,
   // according to the rules in HideTopItem.
   return height + kVerticalPadding + 1;
}

References anonymous_namespace{CommonTrackInfo.cpp}::commonTrackTCPBottomLines, commonTrackTCPLines(), kVerticalPadding, and Margin.

Referenced by CommonChannelView::GetMinimizedHeight(), and ProjectWindow::MinimumTrackHeight().

Here is the call graph for this function:

Here is the caller graph for this function:

StaticTCPLines()

const TCPLines & CommonTrackInfo::StaticTCPLines

(

)

Definition at line 57 of file CommonTrackInfo.cpp.

{
   return commonTrackTCPLines();
}

References commonTrackTCPLines().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SyncLockDrawFunction()

void CommonTrackInfo::SyncLockDrawFunction	(	TrackPanelDrawingContext &	context,
		const wxRect &	rect,
		const Track *	pTrack
	)

Definition at line 281 of file CommonTrackInfo.cpp.

{
   auto dc = &context.dc;
   bool syncLockSelected =
      pTrack ? SyncLock::IsSyncLockSelected(*pTrack) : true;
 
   // Draw the sync-lock indicator if this track is in a sync-lock selected group.
   if (syncLockSelected)
   {
      wxRect syncLockIconRect = rect;
   
      GetSyncLockHorizontalBounds( rect, syncLockIconRect );
      wxBitmap syncLockBitmap(theTheme.Image(bmpSyncLockIcon));
      // Icon is 12x12 and syncLockIconRect is 16x16.
      dc->DrawBitmap(syncLockBitmap,
                     syncLockIconRect.x + 3,
                     syncLockIconRect.y + 2,
                     true);
   }
}

References TrackPanelDrawingContext::dc, GetSyncLockHorizontalBounds(), ThemeBase::Image(), SyncLock::IsSyncLockSelected(), and theTheme.

Here is the call graph for this function:

Variable Documentation

Margin

constexpr auto CommonTrackInfo::Margin = 4

staticconstexpr

Definition at line 23 of file CommonTrackInfo.h.

Referenced by DefaultTrackHeight(), DrawItems(), GetCloseBoxRect(), PlayableTrackControls::GetEffectsButtonRect(), NoteTrackControls::GetMidiControlsRect(), GetMinimizeRect(), PlayableTrackControls::GetMuteSoloRect(), anonymous_namespace{PlayableTrackControls.cpp}::GetNarrowMuteHorizontalBounds(), anonymous_namespace{PlayableTrackControls.cpp}::GetNarrowSoloHorizontalBounds(), WaveTrackControls::GetPanRect(), GetSyncLockIconRect(), GetTrackMenuButtonRect(), GetTrackTitleRect(), NoteTrackControls::GetVelocityRect(), WaveTrackControls::GetVolumeRect(), MinimumTrackHeight(), PluginRegistrationDialog::PopulateOrExchange(), and WaveTrackControls::VolumeSlider().

ToolButtonSize

constexpr auto CommonTrackInfo::ToolButtonSize = 16

staticconstexpr

Definition at line 24 of file CommonTrackInfo.h.

Referenced by GetCloseBoxHorizontalBounds(), GetMinimizeHorizontalBounds(), GetTrackMenuButtonBounds(), and GetTrackMenuButtonRect().