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	MinimizeSyncLockDrawFunction (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	GetTitleBarHorizontalBounds (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetTitleBarRect (const wxRect &rect, wxRect &dest)
AUDACITY_DLL_API void	GetSliderHorizontalBounds (const wxPoint &topleft, 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 ()

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 22 of file CommonTrackInfo.h.

TCPLines

using CommonTrackInfo::TCPLines = typedef TrackInfo::TCPLines

Definition at line 23 of file CommonTrackInfo.h.

Function Documentation

CloseTitleDrawFunction()

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

Definition at line 206 of file CommonTrackInfo.cpp.

{
   auto dc = &context.dc;
   bool selected = pTrack ? pTrack->GetSelected() : true;
   {
      wxRect bev = rect;
      GetCloseBoxHorizontalBounds( rect, bev );
      auto target = context.target.get();
      DrawCloseButton(context, bev,
         (*pTrack->Channels().begin()).get(), target);
   }
 
   {
      wxRect bev = rect;
      GetTitleBarHorizontalBounds( rect, bev );
      auto target = context.target.get();
      bool hit = target &&
         target->FindTrack().get() == pTrack;
      bool captured = hit && target->IsDragging();
      bool down = captured && bev.Contains( context.lastState.GetPosition());
      wxString titleStr =
         pTrack ? pTrack->GetName() : _("Name");
 
      //bev.Inflate(-1, -1);
      AColor::Bevel2(*dc, !down, bev, selected, hit);
 
      // Draw title text
      TrackInfo::SetTrackInfoFont(dc);
 
      // Bug 1660 The 'k' of 'Audio Track' was being truncated.
      // Constant of 32 found by counting pixels on a windows machine.
      // I believe it's the size of the X close button + the size of the 
      // drop down arrow.
      int allowableWidth = rect.width - 32;
 
      wxCoord textWidth, textHeight;
      dc->GetTextExtent(titleStr, &textWidth, &textHeight);
      while (textWidth > allowableWidth) {
         titleStr = titleStr.Left(titleStr.length() - 1);
         dc->GetTextExtent(titleStr, &textWidth, &textHeight);
      }
 
      // Pop-up triangle
      wxColour c = theTheme.Colour( clrTrackPanelText );
 
      // wxGTK leaves little scraps (antialiasing?) of the
      // characters if they are repeatedly drawn.  This
      // happens when holding down mouse button and moving
      // in and out of the title bar.  So clear it first.
   //   AColor::MediumTrackInfo(dc, t->GetSelected());
   //   dc->DrawRectangle(bev);
 
      dc->SetTextForeground( c );
      dc->SetTextBackground( wxTRANSPARENT );
      dc->DrawText(titleStr, bev.x + 2, bev.y + (bev.height - textHeight) / 2);
 
 
 
      dc->SetPen(c);
      dc->SetBrush(c);
 
      int s = 10; // Width of dropdown arrow...height is half of width
      AColor::Arrow(*dc,
                    bev.GetRight() - s - 3, // 3 to offset from right border
                    bev.y + ((bev.height - (s / 2)) / 2),
                    s);
 
   }
}

References _, AColor::Arrow(), AColor::Bevel2(), ChannelGroup::Channels(), ThemeBase::Colour(), TrackPanelDrawingContext::dc, DrawCloseButton(), GetCloseBoxHorizontalBounds(), Track::GetName(), Track::GetSelected(), GetTitleBarHorizontalBounds(), TrackPanelDrawingContext::lastState, TrackInfo::SetTrackInfoFont(), TrackPanelDrawingContext::target, and theTheme.

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 404 of file CommonTrackInfo.cpp.

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

References anonymous_namespace{CommonTrackInfo.cpp}::commonTrackTCPBottomLines, ChannelView::DefaultHeight, kVerticalPadding, 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 174 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());
   AColor::Bevel2(*dc, !down, bev, selected, hit );
 
   wxPen pen( theTheme.Colour( clrTrackPanelText ));
   dc->SetPen( pen );
   bev.Inflate( -1, -1 );
   // Draw the "X"
   const int s = 6;
 
   int ls = bev.x + ((bev.width - s) / 2);
   int ts = bev.y + ((bev.height - s) / 2);
   int rs = ls + s;
   int bs = ts + s;
 
   AColor::Line(*dc, ls,     ts, rs,     bs);
   AColor::Line(*dc, ls + 1, ts, rs + 1, bs);
   AColor::Line(*dc, rs,     ts, ls,     bs);
   AColor::Line(*dc, rs + 1, ts, ls + 1, bs);
   //   bev.Inflate(-1, -1);
}

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

Referenced by CloseTitleDrawFunction(), and 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 126 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 137 of file CommonTrackInfo.cpp.

{
   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(), TrackInfo::SetTrackInfoFont(), and theTheme.

Here is the call graph for this function:

GetCloseBoxHorizontalBounds()

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

Definition at line 329 of file CommonTrackInfo.cpp.

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

References kTrackInfoBtnSize.

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

Here is the caller graph for this function:

GetCloseBoxRect()

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

Definition at line 335 of file CommonTrackInfo.cpp.

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

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

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 366 of file CommonTrackInfo.cpp.

{
   const int space = 0;// was 3.
   dest.x = rect.x + space;
 
   wxRect syncLockRect;
   GetSyncLockHorizontalBounds( rect, syncLockRect );
 
   // Width is rect.width less space on left for track select
   // and on right for sync-lock icon.
   dest.width = kTrackInfoBtnSize;
// rect.width - (space + syncLockRect.width);
}

References GetSyncLockHorizontalBounds(), and kTrackInfoBtnSize.

Referenced by GetMinimizeRect(), and MinimizeSyncLockDrawFunction().

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 380 of file CommonTrackInfo.cpp.

{
   GetMinimizeHorizontalBounds( rect, dest );
   auto results = CalcBottomItemY
      ( commonTrackTCPBottomLines, TCPLine::kItemMinimize, rect.height);
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

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

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 wxPoint &	topleft,
		wxRect &	dest
	)

Definition at line 360 of file CommonTrackInfo.cpp.

{
   dest.x = topleft.x + 6;
   dest.width = kTrackInfoSliderWidth;
}

References kTrackInfoSliderWidth.

Referenced by WaveTrackControls::GetGainRect(), NoteTrackControls::GetVelocityRect(), 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 389 of file CommonTrackInfo.cpp.

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

References kTrackInfoBtnSize.

Referenced by GetMinimizeHorizontalBounds(), GetSyncLockIconRect(), and MinimizeSyncLockDrawFunction().

Here is the caller graph for this function:

GetSyncLockIconRect()

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

Definition at line 395 of file CommonTrackInfo.cpp.

{
   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(), and TrackInfo::TCPLine::kItemSyncLock.

Here is the call graph for this function:

GetTitleBarHorizontalBounds()

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

Definition at line 343 of file CommonTrackInfo.cpp.

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

References GetCloseBoxHorizontalBounds(), and TitleSoloBorderOverlap.

Referenced by CloseTitleDrawFunction(), and GetTitleBarRect().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTitleBarRect()

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

Definition at line 352 of file CommonTrackInfo.cpp.

{
   GetTitleBarHorizontalBounds( rect, dest );
   auto results = CalcItemY( commonTrackTCPLines(), TCPLine::kItemBarButtons );
   dest.y = rect.y + results.first;
   dest.height = results.second;
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

HideTopItem()

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

Definition at line 117 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(), GainSliderHandle::HitTest(), MuteButtonHandle::HitTest(), NoteTrackButtonHandle::HitTest(), PanSliderHandle::HitTest(), SoloButtonHandle::HitTest(), and VelocitySliderHandle::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

MinimizeSyncLockDrawFunction()

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

Definition at line 278 of file CommonTrackInfo.cpp.

{
   auto dc = &context.dc;
   bool selected = pTrack ? pTrack->GetSelected() : true;
   bool syncLockSelected =
      pTrack ? SyncLock::IsSyncLockSelected(*pTrack) : true;
   bool minimized =
      pTrack ? ChannelView::Get(*pTrack->GetChannel(0)).GetMinimized() : false;
   {
      wxRect bev = rect;
      GetMinimizeHorizontalBounds(rect, bev);
      auto target = context.target.get();
      bool hit = target && target->FindTrack().get() == pTrack;
      bool captured = hit && target->IsDragging();
      bool down = captured && bev.Contains( context.lastState.GetPosition());
 
      // Clear background to get rid of previous arrow
      //AColor::MediumTrackInfo(dc, t->GetSelected());
      //dc->DrawRectangle(bev);
 
      AColor::Bevel2(*dc, !down, bev, selected, hit);
 
      wxColour c = theTheme.Colour(clrTrackPanelText);
      dc->SetBrush(c);
      dc->SetPen(c);
 
      AColor::Arrow(*dc,
                    bev.x - 5 + bev.width / 2,
                    bev.y - 2 + bev.height / 2,
                    10,
                    minimized);
   }
 
 
   // 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 AColor::Arrow(), AColor::Bevel2(), ThemeBase::Colour(), TrackPanelDrawingContext::dc, ChannelView::Get(), ChannelGroup::GetChannel(), ChannelView::GetMinimized(), GetMinimizeHorizontalBounds(), Track::GetSelected(), GetSyncLockHorizontalBounds(), ThemeBase::Image(), SyncLock::IsSyncLockSelected(), TrackPanelDrawingContext::lastState, TrackPanelDrawingContext::target, and theTheme.

Here is the call graph for this function:

MinimumTrackHeight()

unsigned CommonTrackInfo::MinimumTrackHeight

(

)

Definition at line 105 of file CommonTrackInfo.cpp.

{
   unsigned height = 0;
   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(), and kVerticalPadding.

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 54 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: