This is an Audacity Specific ruler panel which additionally has border, selection markers, play marker. More...

#include <AdornedRulerPanel.h>

Inheritance diagram for AdornedRulerPanel:

Collaboration diagram for AdornedRulerPanel:

Classes
class	CommonCell

class	CommonRulerHandle

struct	MainGroup

class	MovePlayRegionHandle

class	NewPlayRegionHandle

class	PlayRegionAdjustingHandle

class	QPCell

struct	Resetter

class	ResizePlayRegionHandle

class	ScrubbingCell

class	ScrubbingHandle

class	ScrubbingRulerOverlay

struct	Subgroup

class	TrackPanelGuidelineOverlay

Public Member Functions
	AdornedRulerPanel (AudacityProject project, wxWindow parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, ViewInfo *viewinfo=NULL)

	~AdornedRulerPanel ()

void	Refresh (bool eraseBackground=true, const wxRect rect=(const wxRect ) NULL) override

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

void	SetFocusFromKbd () override

int	GetRulerHeight ()

wxRect	GetInnerRect () const

void	SetLeftOffset (int offset)

void	DrawSelection ()

void	SetPlayRegion (double playRegionStart, double playRegionEnd)

void	ClearPlayRegion ()

void	TogglePinnedHead ()

void	GetMaxSize (wxCoord width, wxCoord height)

void	InvalidateRuler ()

void	UpdatePrefs () override

void	ReCreateButtons ()

void	UpdateQuickPlayPos (wxCoord &mousePosX)

bool	ShowingScrubRuler () const

bool	SetPanelSize ()

void	DrawBothOverlays ()

void	DoDrawScrubIndicator (wxDC *dc, wxCoord xx, int width, bool scrub, bool seek)

void	UpdateButtonStates ()

void	SetNumGuides (size_t nn)

AudacityProject *	GetProject () const override

TimeDisplayMode	GetTimeDisplayMode () const

void	SetTimeDisplayMode (TimeDisplayMode rulerType)

Public Member Functions inherited from CellularPanel
	CellularPanel (wxWindow parent, wxWindowID id, const wxPoint &pos, const wxSize &size, ViewInfo viewInfo, long style=wxTAB_TRAVERSAL\|wxNO_BORDER)

	~CellularPanel () override

virtual AudacityProject *	GetProject () const =0

virtual std::shared_ptr< TrackPanelNode >	Root ()=0

virtual TrackPanelCell *	GetFocusedCell ()=0

virtual void	SetFocusedCell ()=0

virtual void	ProcessUIHandleResult (TrackPanelCell pClickedCell, TrackPanelCell pLatestCell, unsigned refreshResult)=0

virtual void	UpdateStatusMessage (const TranslatableString &)=0

void	Visit (Visitor &visitor)

void	VisitCells (const SimpleCellVisitor &visitor)

void	VisitPreorder (const SimpleNodeVisitor &visitor)

void	VisitPostorder (const SimpleNodeVisitor &visitor)

FoundCell	FindCell (int mouseX, int mouseY)

wxRect	FindRect (const TrackPanelCell &cell)

wxRect	FindRect (const std::function< bool(TrackPanelNode &) > &pred)

UIHandlePtr	Target ()

std::shared_ptr< TrackPanelCell >	LastCell () const

bool	IsMouseCaptured ()
	Determines if a modal tool is active. More...

wxCoord	MostRecentXCoord () const

void	HandleCursorForPresentMouseState (bool doHit=true)

void	Draw (TrackPanelDrawingContext &context, unsigned nPasses)

Public Member Functions inherited from OverlayPanel
	OverlayPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style=wxTAB_TRAVERSAL\|wxNO_BORDER)

void	AddOverlay (const std::weak_ptr< Overlay > &pOverlay)

void	ClearOverlays ()

void	DrawOverlays (bool repaint_all, wxDC *pDC=nullptr)

Public Member Functions inherited from BackedPanel
	BackedPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style)

	~BackedPanel ()

wxDC &	GetBackingDC ()

wxDC &	GetBackingDCForRepaint ()

void	ResizeBacking ()

void	RepairBitmap (wxDC &dc, wxCoord x, wxCoord y, wxCoord width, wxCoord height)

void	DisplayBitmap (wxDC &dc)

void	OnSize (wxSizeEvent &event)

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

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

static const AdornedRulerPanel &	Get (const AudacityProject &project)

static void	Destroy (AudacityProject &project)

static int	GetRulerHeight (bool showScrubBar)

static TempAllowFocus	TemporarilyAllowFocus ()

Private Types
enum class	MenuChoice { QuickPlay , Scrub }

enum	MouseEventState { mesNone , mesDraggingPlayRegionStart , mesDraggingPlayRegionEnd , mesSelectingPlayRegionClick , mesSelectingPlayRegionRange }

using	TempAllowFocus = std::unique_ptr< bool, Resetter >

Private Member Functions
void	DoIdle ()

void	OnIdle (wxIdleEvent &evt)

void	OnAudioStartStop (AudioIOEvent)

void	OnPaint (wxPaintEvent &evt)

void	OnSize (wxSizeEvent &evt)

void	OnLeave (wxMouseEvent &evt)

void	OnThemeChange (struct ThemeChangeMessage)

void	OnSelectionChange (Observer::Message)

void	DoSelectionChange (const SelectedRegion &selectedRegion)

bool	UpdateRects ()

void	HandleQPClick (wxMouseEvent &event, wxCoord mousePosX)

void	HandleQPDrag (wxMouseEvent &event, wxCoord mousePosX)

void	HandleQPRelease (wxMouseEvent &event)

void	StartQPPlay (bool newDefault, bool cutPreview, const double *pStartTime=nullptr)

void	DoDrawBackground (wxDC *dc)

void	DoDrawEdge (wxDC *dc)

void	DoDrawMarks (wxDC *dc, bool)

wxRect	RegionRectangle (double t0, double t1) const

wxRect	PlayRegionRectangle () const

wxRect	SelectedRegionRectangle () const

void	DoDrawPlayRegion (wxDC *dc, const wxRect &rectP, const wxRect &rectL, const wxRect &rectR)

void	DoDrawPlayRegionLimits (wxDC *dc, const wxRect &rect)

void	DoDrawOverlap (wxDC *dc, const wxRect &rect)

void	DoDrawSelection (wxDC *dc, const wxRect &rectS, const wxRect &rectL, const wxRect &rectR)

void	ShowContextMenu (MenuChoice choice, const wxPoint *pPosition)

double	Pos2Time (int p, bool ignoreFisheye=false) const

int	Time2Pos (double t, bool ignoreFisheye=false) const

bool	IsWithinMarker (int mousePosX, double markerTime)

void	ShowMenu (const wxPoint &pos)

void	ShowScrubMenu (const wxPoint &pos)

void	HandleSnapping (size_t index)

void	OnTimelineFormatChange (wxCommandEvent &evt)

void	OnSyncSelToQuickPlay (wxCommandEvent &evt)

void	OnAutoScroll (wxCommandEvent &evt)

void	OnTogglePlayRegion (wxCommandEvent &evt)

void	OnClearPlayRegion (wxCommandEvent &evt)

void	OnSetPlayRegionToSelection (wxCommandEvent &evt)

void	OnPinnedButton (wxCommandEvent &event)

void	OnTogglePinnedState (wxCommandEvent &event)

std::shared_ptr< TrackPanelNode >	Root () override

TrackPanelCell *	GetFocusedCell () override

void	SetFocusedCell () override

void	ProcessUIHandleResult (TrackPanelCell pClickedTrack, TrackPanelCell pLatestCell, unsigned refreshResult) override

void	UpdateStatusMessage (const TranslatableString &) override

void	CreateOverlays ()

Private Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

virtual void	UpdateSelectedPrefs (int id)

Static Private Member Functions
static void	DragSelection (AudacityProject &project)

Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Private Attributes
AudacityProject *const	mProject

LinearUpdater &	mUpdater

Ruler &	mRuler

TrackList *	mTracks

wxRect	mOuter

wxRect	mScrubZone

wxRect	mInner

int	mLeftOffset

double	mIndTime

double	mQuickPlayOffset [MAX_GUIDES] {}

double	mQuickPlayPosUnsnapped [MAX_GUIDES] {}

double	mQuickPlayPos [MAX_GUIDES] {}

bool	mIsSnapped [MAX_GUIDES] {}

size_t	mNumGuides { 1 }

PlayRegion	mOldPlayRegion

bool	mIsRecording

bool	mPlayRegionDragsSelection

bool	mTimelineToolTip

MouseEventState	mMouseEventState

double	mLeftDownClickUnsnapped

double	mLeftDownClick

bool	mIsDragging

wxWindow *	mButtons [3]

bool	mNeedButtonUpdate { true }

std::shared_ptr< TrackPanelGuidelineOverlay >	mOverlay

std::shared_ptr< QPCell >	mQPCell

std::shared_ptr< ScrubbingCell >	mScrubbingCell

Observer::Subscription	mAudioIOSubscription

Observer::Subscription	mPlayRegionSubscription

Observer::Subscription	mThemeChangeSubscription

Observer::Subscription	mRulerInvalidatedSubscription

SelectedRegion	mLastDrawnSelectedRegion

std::pair< double, double >	mLastDrawnPlayRegion {}

bool	mLastPlayRegionActive = false

double	mLastDrawnH {}

double	mLastDrawnZoom {}

TimeDisplayMode	mTimeDisplayMode

Static Private Attributes
static bool	s_AcceptsFocus { false }

static constexpr size_t	MAX_GUIDES = 2

Additional Inherited Members
Public Types inherited from CellularPanel
using	SimpleCellVisitor = std::function< void(const wxRect &rect, TrackPanelCell &cell) >

using	SimpleNodeVisitor = std::function< void(const wxRect &rect, TrackPanelNode &node) >

Protected Member Functions inherited from CellularPanel
bool	HasEscape ()

bool	CancelDragging (bool escaping)

void	DoContextMenu (TrackPanelCell *pCell=nullptr)

void	ClearTargets ()

Protected Attributes inherited from CellularPanel
ViewInfo *	mViewInfo

wxMouseState	mLastMouseState

Detailed Description

This is an Audacity Specific ruler panel which additionally has border, selection markers, play marker.

Once TrackPanel uses wxSizers, we will derive it from some wxWindow and the GetSize and SetSize functions will then be wxWidgets functions instead.

Definition at line 29 of file AdornedRulerPanel.h.

Member Typedef Documentation

◆ TempAllowFocus

using AdornedRulerPanel::TempAllowFocus = std::unique_ptr<bool, Resetter>

private

Definition at line 121 of file AdornedRulerPanel.h.

Member Enumeration Documentation

◆ MenuChoice

enum class AdornedRulerPanel::MenuChoice

strongprivate

Enumerator
QuickPlay
Scrub

Definition at line 129 of file AdornedRulerPanel.h.

129{ QuickPlay, Scrub };

◆ MouseEventState

enum AdornedRulerPanel::MouseEventState

private

Enumerator
mesNone
mesDraggingPlayRegionStart
mesDraggingPlayRegionEnd
mesSelectingPlayRegionClick
mesSelectingPlayRegionRange

Definition at line 186 of file AdornedRulerPanel.h.

                        {
      mesNone,
      mesDraggingPlayRegionStart,
      mesDraggingPlayRegionEnd,
      mesSelectingPlayRegionClick,
      mesSelectingPlayRegionRange
   };

Constructor & Destructor Documentation

◆ AdornedRulerPanel()

AdornedRulerPanel::AdornedRulerPanel	(	AudacityProject *	project,
		wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		ViewInfo *	viewinfo = `NULL`
	)

Definition at line 1283 of file AdornedRulerPanel.cpp.

   : CellularPanel(parent, id, pos, size, viewinfo)
   , mProject { project }
   , mUpdater { ProjectTimeRuler::Get(*project).GetUpdater() }
   , mRuler { ProjectTimeRuler::Get(*project).GetRuler() }   
{
   SetLayoutDirection(wxLayout_LeftToRight);
 
   mQPCell = std::make_shared<QPCell>( this );
   mScrubbingCell = std::make_shared<ScrubbingCell>( this );
   
   for (auto &button : mButtons)
      button = nullptr;
 
   SetLabel( XO("Timeline") );
   SetName();
   SetBackgroundStyle(wxBG_STYLE_PAINT);
 
   mLeftOffset = 0;
   mIndTime = -1;
 
   mLeftDownClick = -1;
   mMouseEventState = mesNone;
   mIsDragging = false;
 
   mOuter = GetClientRect();
 
   mTimeDisplayMode = TimeDisplayModePreference.ReadEnum();
 
   mUpdater.SetData(mViewInfo, mLeftOffset);
 
   mRuler.SetLabelEdges( false );
 
   mTracks = &TrackList::Get( *project );
 
   mIsRecording = false;
 
   mTimelineToolTip = !!gPrefs->Read(wxT("/QuickPlay/ToolTips"), 1L);
   mPlayRegionDragsSelection = (gPrefs->Read(wxT("/QuickPlay/DragSelection"), 0L) == 1)? true : false; 
 
#if wxUSE_TOOLTIPS
   wxToolTip::Enable(true);
#endif
 
   mAudioIOSubscription = AudioIO::Get()
      ->Subscribe(*this, &AdornedRulerPanel::OnAudioStartStop);
 
   // Delay until after CommandManager has been populated:
   this->CallAfter( &AdornedRulerPanel::UpdatePrefs );
 
   mThemeChangeSubscription =
      theTheme.Subscribe(*this, &AdornedRulerPanel::OnThemeChange);
 
   // Bind event that updates the play region
   mPlayRegionSubscription = mViewInfo->selectedRegion.Subscribe(
      *this, &AdornedRulerPanel::OnSelectionChange);
 
   mRulerInvalidatedSubscription =
      mRuler.Subscribe([this](auto) { Refresh(); });
   
   // And call it once to initialize it
   DoSelectionChange( mViewInfo->selectedRegion );
}

References BasicUI::CallAfter(), DoSelectionChange(), AudioIO::Get(), TrackList::Get(), gPrefs, mAudioIOSubscription, mButtons, mesNone, mIndTime, mIsDragging, mIsRecording, mLeftDownClick, mLeftOffset, mMouseEventState, mOuter, mPlayRegionDragsSelection, mPlayRegionSubscription, mQPCell, mRuler, mRulerInvalidatedSubscription, mScrubbingCell, mThemeChangeSubscription, mTimeDisplayMode, mTimelineToolTip, mTracks, mUpdater, CellularPanel::mViewInfo, OnAudioStartStop(), OnSelectionChange(), OnThemeChange(), project, audacity::BasicSettings::Read(), EnumSetting< Enum >::ReadEnum(), Refresh(), ViewInfo::selectedRegion, LinearUpdater::SetData(), wxPanelWrapper::SetLabel(), Ruler::SetLabelEdges(), wxPanelWrapper::SetName(), Observer::Publisher< Message, NotifyAll >::Subscribe(), theTheme, TimeDisplayModePreference, UpdatePrefs(), wxT(), and XO().

Here is the call graph for this function:

◆ ~AdornedRulerPanel()

AdornedRulerPanel::~AdornedRulerPanel ( )

Definition at line 1352 of file AdornedRulerPanel.cpp.

1353{

1354}

Member Function Documentation

◆ AcceptsFocus()

bool AdornedRulerPanel::AcceptsFocus ( ) const

inlineoverride

Definition at line 51 of file AdornedRulerPanel.h.

51{ return s_AcceptsFocus; }

AdornedRulerPanel::s_AcceptsFocus

static bool s_AcceptsFocus

Definition: AdornedRulerPanel.h:119

◆ AcceptsFocusFromKeyboard()

bool AdornedRulerPanel::AcceptsFocusFromKeyboard ( ) const

inlineoverride

Definition at line 52 of file AdornedRulerPanel.h.

52{ return true; }

◆ ClearPlayRegion()

void AdornedRulerPanel::ClearPlayRegion ( )

Definition at line 2740 of file AdornedRulerPanel.cpp.

{
   ProjectAudioManager::Get( *mProject ).Stop();
 
   auto &viewInfo = ViewInfo::Get( *GetProject() );
   auto &playRegion = viewInfo.playRegion;
   playRegion.SetTimes( -1, -1 );
 
   Refresh();
}

References ViewInfo::Get(), ProjectAudioManager::Get(), GetProject(), Refresh(), and ProjectAudioManager::Stop().

Here is the call graph for this function:

◆ CreateOverlays()

void AdornedRulerPanel::CreateOverlays ( )

private

Definition at line 2860 of file AdornedRulerPanel.cpp.

{
   if (!mOverlay) {
      mOverlay =
         std::make_shared<TrackPanelGuidelineOverlay>( mProject );
      auto pCellularPanel =
         dynamic_cast<CellularPanel*>( &GetProjectPanel( *GetProject() ) );
      if ( !pCellularPanel ) {
         wxASSERT( false );
      }
      else
         pCellularPanel->AddOverlay( mOverlay );
      this->AddOverlay( mOverlay->mPartner );
   }
}

References OverlayPanel::AddOverlay(), GetProject(), GetProjectPanel(), mOverlay, and mProject.

Here is the call graph for this function:

◆ Destroy()

void AdornedRulerPanel::Destroy ( AudacityProject & project )

static

Definition at line 1274 of file AdornedRulerPanel.cpp.

{
   auto *pPanel = GetAttachedWindows(project).Find( sKey );
   if (pPanel) {
      pPanel->wxWindow::Destroy();
      GetAttachedWindows(project).Assign( sKey, nullptr );
   }
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Assign(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Find(), GetAttachedWindows(), project, and anonymous_namespace{AdornedRulerPanel.cpp}::sKey.

Referenced by ProjectManager::OnCloseWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawBackground()

void AdornedRulerPanel::DoDrawBackground ( wxDC * dc )

private

Definition at line 2485 of file AdornedRulerPanel.cpp.

{
   // Draw AdornedRulerPanel border
   AColor::UseThemeColour( dc, TimelineBackgroundColor() );
   dc->DrawRectangle( mInner );
 
   if (ShowingScrubRuler()) {
      // Let's distinguish the scrubbing area by using a themable
      // colour and a line to set it off.  
      AColor::UseThemeColour(dc, clrScrubRuler, TimelineTextColor() );
      wxRect ScrubRect = mScrubZone;
      ScrubRect.Inflate( 1,0 );
      dc->DrawRectangle(ScrubRect);
   }
}

References mInner, mScrubZone, ShowingScrubRuler(), TimelineBackgroundColor(), TimelineTextColor(), and AColor::UseThemeColour().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawEdge()

void AdornedRulerPanel::DoDrawEdge ( wxDC * dc )

private

Definition at line 2501 of file AdornedRulerPanel.cpp.

{
   wxRect r = mOuter;
   r.width -= RightMargin;
   r.height -= BottomMargin;
   AColor::BevelTrackInfo( *dc, true, r );
 
   // Black stroke at bottom
   dc->SetPen( *wxBLACK_PEN );
   AColor::Line( *dc, mOuter.x,
                mOuter.y + mOuter.height - 1,
                mOuter.x + mOuter.width - 1  ,
                mOuter.y + mOuter.height - 1 );
}

References AColor::BevelTrackInfo(), BottomMargin, AColor::Line(), mOuter, and RightMargin.

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawMarks()

void AdornedRulerPanel::DoDrawMarks	(	wxDC *	dc,
		bool
	)

private

Definition at line 2516 of file AdornedRulerPanel.cpp.

{
   const double min = Pos2Time(0);
   const double hiddenMin = Pos2Time(0, true);
   const double max = Pos2Time(mInner.width);
   const double hiddenMax = Pos2Time(mInner.width, true);
 
   mRuler.SetTickColour( theTheme.Colour( TimelineTextColor() ) );
   mRuler.SetRange( min, max, hiddenMin, hiddenMax );
   if (mTimeDisplayMode == TimeDisplayMode::BeatsAndMeasures)
   {
      mRuler.SetTickLengths({ 5, 3, 1 });
   }
   else if (mTimeDisplayMode == TimeDisplayMode::MinutesAndSeconds)
   {
      mRuler.SetTickLengths({ 4, 2, 2 });
   }
   mRuler.Draw( *dc );
}

References BeatsAndMeasures, ThemeBase::Colour(), Ruler::Draw(), min(), mInner, MinutesAndSeconds, mRuler, mTimeDisplayMode, Pos2Time(), Ruler::SetRange(), Ruler::SetTickColour(), Ruler::SetTickLengths(), theTheme, and TimelineTextColor().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawOverlap()

void AdornedRulerPanel::DoDrawOverlap	(	wxDC *	dc,
		const wxRect &	rect
	)

private

Definition at line 2631 of file AdornedRulerPanel.cpp.

{
   dc->SetBrush( wxBrush{ AlphaBlend(
      TimelineLimitsColor(), TimelineLoopRegionColor(mLastPlayRegionActive),
      SelectionOpacity) } );
   dc->SetPen( *wxTRANSPARENT_PEN );
   dc->DrawRectangle( rect );
}

References AlphaBlend(), mLastPlayRegionActive, SelectionOpacity, TimelineLimitsColor(), and TimelineLoopRegionColor().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawPlayRegion()

void AdornedRulerPanel::DoDrawPlayRegion	(	wxDC *	dc,
		const wxRect &	rectP,
		const wxRect &	rectL,
		const wxRect &	rectR
	)

private

Definition at line 2573 of file AdornedRulerPanel.cpp.

{
   const auto &viewInfo = ViewInfo::Get(*mProject);
   const auto &playRegion = viewInfo.playRegion;
   if (playRegion.IsLastActiveRegionClear())
      return;
 
   const bool isActive = (mLastPlayRegionActive = playRegion.Active());
 
   // Paint the selected region bolder if independently varying, else dim
   const auto color = TimelineLoopRegionColor(isActive);
   dc->SetBrush( wxBrush( theTheme.Colour( color )) );
   dc->SetPen(   wxPen(   theTheme.Colour( color )) );
 
   dc->DrawRectangle( rectP.Intersect(rectL) );
   dc->DrawRectangle( rectP.Intersect(rectR) );
}

References ThemeBase::Colour(), ViewInfo::Get(), mLastPlayRegionActive, mProject, theTheme, and TimelineLoopRegionColor().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawPlayRegionLimits()

void AdornedRulerPanel::DoDrawPlayRegionLimits	(	wxDC *	dc,
		const wxRect &	rect
	)

private

Definition at line 2592 of file AdornedRulerPanel.cpp.

{
   // Color the edges of the play region like the ticks and numbers
   ADCChanger cleanup( dc );
   const auto edgeColour = theTheme.Colour(TimelineLimitsColor());
   dc->SetPen( { edgeColour } );
   dc->SetBrush( { edgeColour } );
 
   constexpr int side = 7;
   constexpr int sideLessOne = side - 1;
 
   // Paint two shapes, each a line plus triangle at bottom
   const auto left = rect.GetLeft(),
      right = rect.GetRight(),
      bottom = rect.GetBottom(),
      top = rect.GetTop();
   {
      wxPoint points[]{
         {left, bottom - sideLessOne},
         {left - sideLessOne, bottom},
         {left, bottom},
         {left, top},
      };
      dc->DrawPolygon( 4, points );
   }
 
   {
      wxPoint points[]{
         {right, top},
         {right, bottom},
         {right + sideLessOne, bottom},
         {right, bottom - sideLessOne},
      };
      dc->DrawPolygon( 4, points );
   }
}

References ThemeBase::Colour(), theTheme, and TimelineLimitsColor().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDrawScrubIndicator()

void AdornedRulerPanel::DoDrawScrubIndicator	(	wxDC *	dc,
		wxCoord	xx,
		int	width,
		bool	scrub,
		bool	seek
	)

Definition at line 2665 of file AdornedRulerPanel.cpp.

{
   ADCChanger changer(dc); // Undo pen and brush changes at function exit
 
   wxPoint tri[ 3 ];
   if (seek) {
      auto height = IndicatorHeightForWidth(width);
      // Make four triangles
      const int TriangleWidth = width * 3 / 8;
 
      // Double-double headed, left-right
      auto yy = ShowingScrubRuler()
      ? mScrubZone.y
      : (mInner.GetBottom() + 1) - 1 /* bevel */ - height;
      tri[ 0 ].x = xx - IndicatorOffset;
      tri[ 0 ].y = yy;
      tri[ 1 ].x = xx - IndicatorOffset;
      tri[ 1 ].y = yy + height;
      tri[ 2 ].x = xx - TriangleWidth;
      tri[ 2 ].y = yy + height / 2;
      dc->DrawPolygon( 3, tri );
 
      tri[ 0 ].x -= TriangleWidth;
      tri[ 1 ].x -= TriangleWidth;
      tri[ 2 ].x -= TriangleWidth;
      dc->DrawPolygon( 3, tri );
 
      tri[ 0 ].x = tri[ 1 ].x = xx + IndicatorOffset;
      tri[ 2 ].x = xx + TriangleWidth;
      dc->DrawPolygon( 3, tri );
 
 
      tri[ 0 ].x += TriangleWidth;
      tri[ 1 ].x += TriangleWidth;
      tri[ 2 ].x += TriangleWidth;
      dc->DrawPolygon( 3, tri );
   }
   else if (scrub) {
      auto height = IndicatorHeightForWidth(width);
      const int IndicatorHalfWidth = width / 2;
 
      // Double headed, left-right
      auto yy = ShowingScrubRuler()
         ? mScrubZone.y
         : (mInner.GetBottom() + 1) - 1 /* bevel */ - height;
      tri[ 0 ].x = xx - IndicatorOffset;
      tri[ 0 ].y = yy;
      tri[ 1 ].x = xx - IndicatorOffset;
      tri[ 1 ].y = yy + height;
      tri[ 2 ].x = xx - IndicatorHalfWidth;
      tri[ 2 ].y = yy + height / 2;
      dc->DrawPolygon( 3, tri );
      tri[ 0 ].x = tri[ 1 ].x = xx + IndicatorOffset;
      tri[ 2 ].x = xx + IndicatorHalfWidth;
      dc->DrawPolygon( 3, tri );
   }
}

References IndicatorHeightForWidth(), IndicatorOffset, mInner, mScrubZone, and ShowingScrubRuler().

Here is the call graph for this function:

◆ DoDrawSelection()

void AdornedRulerPanel::DoDrawSelection	(	wxDC *	dc,
		const wxRect &	rectS,
		const wxRect &	rectL,
		const wxRect &	rectR
	)

private

Definition at line 2640 of file AdornedRulerPanel.cpp.

{
   dc->SetBrush( wxBrush{ AlphaBlend(
      TimelineLimitsColor(), TimelineBackgroundColor(), SelectionOpacity) } );
   dc->SetPen( *wxTRANSPARENT_PEN );
   dc->DrawRectangle( rectS.Intersect(rectL) );
   dc->DrawRectangle( rectS.Intersect(rectR) );
}

References AlphaBlend(), SelectionOpacity, TimelineBackgroundColor(), and TimelineLimitsColor().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoIdle()

void AdornedRulerPanel::DoIdle ( )

private

Definition at line 1543 of file AdornedRulerPanel.cpp.

{
   bool changed = UpdateRects();
   changed = SetPanelSize() || changed;
 
   auto &project = *mProject;
   auto &viewInfo = ViewInfo::Get( project );
   const auto &selectedRegion = viewInfo.selectedRegion;
   const auto &playRegion = viewInfo.playRegion;
 
   changed = changed
     || mLastDrawnSelectedRegion != selectedRegion
     || mLastDrawnPlayRegion != std::pair{
         playRegion.GetLastActiveStart(), playRegion.GetLastActiveEnd() }
     || mLastDrawnH != viewInfo.h
     || mLastDrawnZoom != viewInfo.GetZoom()
     || mLastPlayRegionActive != viewInfo.playRegion.Active()
   ;
   if (changed)
      // Cause ruler redraw anyway, because we may be zooming or scrolling,
      // showing or hiding the scrub bar, etc.
      Refresh();
}

References ViewInfo::Get(), mLastDrawnH, mLastDrawnPlayRegion, mLastDrawnSelectedRegion, mLastDrawnZoom, mLastPlayRegionActive, mProject, project, Refresh(), SetPanelSize(), and UpdateRects().

Referenced by OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoSelectionChange()

void AdornedRulerPanel::DoSelectionChange ( const SelectedRegion & selectedRegion )

private

Definition at line 1678 of file AdornedRulerPanel.cpp.

{
 
   auto gAudioIO = AudioIOBase::Get();
   if ( !ViewInfo::Get( *mProject ).playRegion.Active() ) {
      // "Inactivated" play region follows the selection.
      SetPlayRegion( selectedRegion.t0(), selectedRegion.t1() );
   }
}

References PlayRegion::Active(), AudioIOBase::Get(), ViewInfo::Get(), ViewInfo::playRegion, SetPlayRegion(), SelectedRegion::t0(), and SelectedRegion::t1().

Referenced by AdornedRulerPanel(), OnAudioStartStop(), and OnSelectionChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DragSelection()

void AdornedRulerPanel::DragSelection ( AudacityProject & project )

staticprivate

Definition at line 2336 of file AdornedRulerPanel.cpp.

{
   auto &viewInfo = ViewInfo::Get( project );
   const auto &playRegion = viewInfo.playRegion;
   auto &selectedRegion = viewInfo.selectedRegion;
   selectedRegion.setT0(playRegion.GetStart(), false);
   selectedRegion.setT1(playRegion.GetEnd(), true);
}

References ViewInfo::Get(), and project.

Referenced by AdornedRulerPanel::PlayRegionAdjustingHandle::Drag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawBothOverlays()

void AdornedRulerPanel::DrawBothOverlays ( )

Definition at line 2193 of file AdornedRulerPanel.cpp.

{
   auto pCellularPanel =
      dynamic_cast<CellularPanel*>( &GetProjectPanel( *GetProject() ) );
   if ( !pCellularPanel ) {
      wxASSERT( false );
   }
   else
      pCellularPanel->DrawOverlays( false );
   DrawOverlays( false );
}

References OverlayPanel::DrawOverlays(), GetProject(), and GetProjectPanel().

Referenced by OnLeave(), and ProcessUIHandleResult().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawSelection()

void AdornedRulerPanel::DrawSelection ( )

Definition at line 2536 of file AdornedRulerPanel.cpp.

{
   Refresh();
}

References Refresh().

Referenced by TrackPanel::UpdateSelectionDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

AdornedRulerPanel & AdornedRulerPanel::Get ( AudacityProject & project )

static

Definition at line 1263 of file AdornedRulerPanel.cpp.

{
   return GetAttachedWindows(project).Get< AdornedRulerPanel >( sKey );
}

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), GetAttachedWindows(), project, and anonymous_namespace{AdornedRulerPanel.cpp}::sKey.

Referenced by ScrubbingToolBar::DoRegenerateTooltips(), AdornedRulerPanel::PlayRegionAdjustingHandle::Drag(), AdornedRulerPanel::TrackPanelGuidelineOverlay::Draw(), EditCursorOverlay::Draw(), PlayIndicatorOverlayBase::Draw(), ScrubbingToolBar::EnableDisableButtons(), Get(), anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap(), AdornedRulerPanel::ScrubbingRulerOverlay::GetRuler(), anonymous_namespace{TimelineMenus.cpp}::GetTimeDisplayMode(), AdornedRulerPanel::PlayRegionAdjustingHandle::HasEscape(), InitProjectWindow(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), anonymous_namespace{EditMenus.cpp}::OnCut(), PlayIndicatorOverlay::OnTimer(), ScrubbingOverlay::OnTimer(), anonymous_namespace{AdornedRulerPanel.cpp}::OnTogglePinnedHead(), ScrubForwarder::ScrubForwarder(), anonymous_namespace{TimelineMenus.cpp}::SetTimeDisplayMode(), AdornedRulerPanel::PlayRegionAdjustingHandle::SnappedTime(), AdornedRulerPanel::PlayRegionAdjustingHandle::SnappedTimes(), AdornedRulerPanel::CommonRulerHandle::StartPlay(), AdornedRulerPanel::PlayRegionAdjustingHandle::Unsnap(), and AdornedRulerPanel::TrackPanelGuidelineOverlay::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

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

static

Definition at line 1268 of file AdornedRulerPanel.cpp.

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

References Get(), and project.

Here is the call graph for this function:

◆ GetFocusedCell()

TrackPanelCell * AdornedRulerPanel::GetFocusedCell ( )

overrideprivatevirtual

Implements CellularPanel.

Definition at line 2834 of file AdornedRulerPanel.cpp.

{
   // No switching of focus yet to the other, scrub zone
   return mQPCell.get();
}

References mQPCell.

◆ GetInnerRect()

wxRect AdornedRulerPanel::GetInnerRect ( ) const

inline

Definition at line 58 of file AdornedRulerPanel.h.

58{ return mInner; }

Referenced by anonymous_namespace{PlayIndicatorOverlay.cpp}::GetIndicatorBitmap().

Here is the caller graph for this function:

◆ GetMaxSize()

void AdornedRulerPanel::GetMaxSize	(	wxCoord *	width,
		wxCoord *	height
	)

Definition at line 2751 of file AdornedRulerPanel.cpp.

{
   mRuler.GetMaxSize(width, height);
}

References Ruler::GetMaxSize(), and mRuler.

Here is the call graph for this function:

◆ GetProject()

AudacityProject * AdornedRulerPanel::GetProject ( ) const

overridevirtual

Implements CellularPanel.

Definition at line 2828 of file AdornedRulerPanel.cpp.

{
   return mProject;
}

References mProject.

Referenced by ClearPlayRegion(), CreateOverlays(), DrawBothOverlays(), HandleSnapping(), OnPaint(), SetPlayRegion(), ShowingScrubRuler(), ShowMenu(), and UpdateStatusMessage().

Here is the caller graph for this function:

◆ GetRulerHeight() [1/2]

int AdornedRulerPanel::GetRulerHeight ( )

inline

Definition at line 56 of file AdornedRulerPanel.h.

56{ return GetRulerHeight( ShowingScrubRuler() ); }

AdornedRulerPanel::GetRulerHeight

int GetRulerHeight()

Definition: AdornedRulerPanel.h:56

References GetRulerHeight().

Referenced by ScreenshotCommand::GetPanelRect(), GetRulerHeight(), ReCreateButtons(), and SetPanelSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRulerHeight() [2/2]

int AdornedRulerPanel::GetRulerHeight ( bool showScrubBar )

static

Definition at line 2650 of file AdornedRulerPanel.cpp.

{
   return ProperRulerHeight + (showScrubBar ? ScrubHeight : 0);
}

References ProperRulerHeight, and ScrubHeight.

◆ GetTimeDisplayMode()

TimeDisplayMode AdornedRulerPanel::GetTimeDisplayMode ( ) const

Definition at line 2891 of file AdornedRulerPanel.cpp.

{
   return mTimeDisplayMode;
}

References mTimeDisplayMode.

◆ HandleQPClick()

void AdornedRulerPanel::HandleQPClick	(	wxMouseEvent &	event,
		wxCoord	mousePosX
	)

private

◆ HandleQPDrag()

void AdornedRulerPanel::HandleQPDrag	(	wxMouseEvent &	event,
		wxCoord	mousePosX
	)

private

◆ HandleQPRelease()

void AdornedRulerPanel::HandleQPRelease ( wxMouseEvent & event )

private

◆ HandleSnapping()

void AdornedRulerPanel::HandleSnapping ( size_t index )

private

Definition at line 2345 of file AdornedRulerPanel.cpp.

{
   // Play region dragging can snap to selection boundaries
   const auto &selectedRegion = ViewInfo::Get(*GetProject()).selectedRegion;
   SnapPointArray candidates;
   if (!mPlayRegionDragsSelection)
      candidates = {
         SnapPoint{ selectedRegion.t0() },
         SnapPoint{ selectedRegion.t1() },
      };
   SnapManager snapManager{ *mProject, *mTracks, *mViewInfo, move(candidates) };
   auto results = snapManager.Snap(nullptr, mQuickPlayPos[index], false);
   mQuickPlayPos[index] = results.outTime;
   mIsSnapped[index] = results.Snapped();
}

References ViewInfo::Get(), GetProject(), mIsSnapped, mPlayRegionDragsSelection, mProject, mQuickPlayPos, mTracks, CellularPanel::mViewInfo, and ViewInfo::selectedRegion.

Referenced by UpdateQuickPlayPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InvalidateRuler()

void AdornedRulerPanel::InvalidateRuler ( )

Definition at line 1466 of file AdornedRulerPanel.cpp.

{
   mRuler.Invalidate();
}

References Ruler::Invalidate(), and mRuler.

Here is the call graph for this function:

◆ IsWithinMarker()

bool AdornedRulerPanel::IsWithinMarker	(	int	mousePosX,
		double	markerTime
	)

private

Definition at line 1756 of file AdornedRulerPanel.cpp.

{
   if (markerTime < 0)
      return false;
 
   int pixelPos = Time2Pos(markerTime);
   int boundLeft = pixelPos - SELECT_TOLERANCE_PIXEL;
   int boundRight = pixelPos + SELECT_TOLERANCE_PIXEL;
 
   return mousePosX >= boundLeft && mousePosX < boundRight;
}

References SELECT_TOLERANCE_PIXEL, and Time2Pos().

Here is the call graph for this function:

◆ OnAudioStartStop()

void AdornedRulerPanel::OnAudioStartStop ( AudioIOEvent evt )

private

Definition at line 1567 of file AdornedRulerPanel.cpp.

{
   if (evt.type == AudioIOEvent::MONITOR)
      return;
   if ( evt.type == AudioIOEvent::CAPTURE ) {
      if (evt.on)
      {
         mIsRecording = true;
         this->CellularPanel::CancelDragging( false );
         this->CellularPanel::ClearTargets();
 
         UpdateButtonStates();
      }
      else {
         mIsRecording = false;
         UpdateButtonStates();
      }
   }
 
   if ( !evt.on )
      // So that the play region is updated
      DoSelectionChange( mViewInfo->selectedRegion );
}

References CellularPanel::CancelDragging(), AudioIOEvent::CAPTURE, CellularPanel::ClearTargets(), DoSelectionChange(), mIsRecording, AudioIOEvent::MONITOR, CellularPanel::mViewInfo, AudioIOEvent::on, ViewInfo::selectedRegion, AudioIOEvent::type, and UpdateButtonStates().

Referenced by AdornedRulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnAutoScroll()

void AdornedRulerPanel::OnAutoScroll ( wxCommandEvent & evt )

private

Definition at line 2392 of file AdornedRulerPanel.cpp.

{
   if (mViewInfo->bUpdateTrackIndicator)
      gPrefs->Write(wxT("/GUI/AutoScroll"), false);
   else
      gPrefs->Write(wxT("/GUI/AutoScroll"), true);
 
   gPrefs->Flush();
 
   PrefsListener::Broadcast(ViewInfo::UpdateScrollPrefsID());
}

References PrefsListener::Broadcast(), ViewInfo::bUpdateTrackIndicator, audacity::BasicSettings::Flush(), gPrefs, CellularPanel::mViewInfo, ViewInfo::UpdateScrollPrefsID(), audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

◆ OnClearPlayRegion()

void AdornedRulerPanel::OnClearPlayRegion ( wxCommandEvent & evt )

private

Definition at line 2410 of file AdornedRulerPanel.cpp.

{
   SelectUtilities::ClearPlayRegion(*mProject);
}

References SelectUtilities::ClearPlayRegion(), and mProject.

Here is the call graph for this function:

◆ OnIdle()

void AdornedRulerPanel::OnIdle ( wxIdleEvent & evt )

private

Definition at line 1537 of file AdornedRulerPanel.cpp.

{
   evt.Skip();
   DoIdle();
}

References DoIdle().

Here is the call graph for this function:

◆ OnLeave()

void AdornedRulerPanel::OnLeave ( wxMouseEvent & evt )

private

Definition at line 1657 of file AdornedRulerPanel.cpp.

{
   evt.Skip();
   CallAfter([this]{
      DrawBothOverlays();
   });
}

References BasicUI::CallAfter(), and DrawBothOverlays().

Here is the call graph for this function:

◆ OnPaint()

void AdornedRulerPanel::OnPaint ( wxPaintEvent & evt )

private

Definition at line 1591 of file AdornedRulerPanel.cpp.

{
   const auto &viewInfo = ViewInfo::Get( *GetProject() );
   const auto &playRegion = viewInfo.playRegion;
   const auto playRegionBounds = std::pair{
      playRegion.GetLastActiveStart(), playRegion.GetLastActiveEnd() };
   mLastDrawnH = viewInfo.h;
   mLastDrawnZoom = viewInfo.GetZoom();
   mLastDrawnPlayRegion = playRegionBounds;
   mLastDrawnSelectedRegion = viewInfo.selectedRegion;
   // To do, note other fisheye state when we have that
 
   wxPaintDC dc(this);
 
   auto &backDC = GetBackingDCForRepaint();
 
   DoDrawBackground(&backDC);
 
   // Find play region rectangle, selected rectangle, and their overlap
   const auto rectP = PlayRegionRectangle(),
      rectS = SelectedRegionRectangle(),
      rectO = rectP.Intersect(rectS);
 
   // What's left and right of the overlap?  Assume same tops and bottoms
   const auto top = rectP.GetTop(),
      bottom = rectP.GetBottom();
   wxRect rectL{
      wxPoint{ 0, top }, wxPoint{ this->GetSize().GetWidth() - 1, bottom } };
   wxRect rectR = {};
   if (!rectO.IsEmpty()) {
      rectR = { wxPoint{ rectO.GetRight() + 1, top }, rectL.GetBottomRight() };
      rectL = { rectL.GetTopLeft(), wxPoint{ rectO.GetLeft() - 1, bottom } };
   }
 
   DoDrawPlayRegion(&backDC, rectP, rectL, rectR);
   DoDrawOverlap(&backDC, rectO);
   DoDrawSelection(&backDC, rectS, rectL, rectR);
 
   DoDrawPlayRegionLimits(&backDC, rectP);
 
   DoDrawMarks(&backDC, true);
 
   DoDrawEdge(&backDC);
 
   DisplayBitmap(dc);
 
   // Stroke extras direct to the client area,
   // maybe outside of the damaged area
   // As with TrackPanel, do not make a NEW wxClientDC or else Mac flashes badly!
   dc.DestroyClippingRegion();
   DrawOverlays(true, &dc);
}

References BackedPanel::DisplayBitmap(), DoDrawBackground(), DoDrawEdge(), DoDrawMarks(), DoDrawOverlap(), DoDrawPlayRegion(), DoDrawPlayRegionLimits(), DoDrawSelection(), OverlayPanel::DrawOverlays(), ViewInfo::Get(), BackedPanel::GetBackingDCForRepaint(), GetProject(), mLastDrawnH, mLastDrawnPlayRegion, mLastDrawnSelectedRegion, mLastDrawnZoom, PlayRegionRectangle(), and SelectedRegionRectangle().

Here is the call graph for this function:

◆ OnPinnedButton()

void AdornedRulerPanel::OnPinnedButton ( wxCommandEvent & event )

private

Definition at line 2235 of file AdornedRulerPanel.cpp.

{
   ShowContextMenu(MenuChoice::QuickPlay, NULL);
}

References QuickPlay, and ShowContextMenu().

Here is the call graph for this function:

◆ OnSelectionChange()

void AdornedRulerPanel::OnSelectionChange ( Observer::Message )

private

Definition at line 1672 of file AdornedRulerPanel.cpp.

{
   auto &selectedRegion = mViewInfo->selectedRegion;
   DoSelectionChange( selectedRegion );
}

References DoSelectionChange(), CellularPanel::mViewInfo, and ViewInfo::selectedRegion.

Referenced by AdornedRulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSetPlayRegionToSelection()

void AdornedRulerPanel::OnSetPlayRegionToSelection ( wxCommandEvent & evt )

private

Definition at line 2415 of file AdornedRulerPanel.cpp.

{
   SelectUtilities::SetPlayRegionToSelection(*mProject);
}

References mProject, and SelectUtilities::SetPlayRegionToSelection().

Here is the call graph for this function:

◆ OnSize()

void AdornedRulerPanel::OnSize ( wxSizeEvent & evt )

private

Definition at line 1644 of file AdornedRulerPanel.cpp.

{
   mOuter = GetClientRect();
   if (mOuter.GetWidth() == 0 || mOuter.GetHeight() == 0)
   {
      return;
   }
 
   UpdateRects();
 
   OverlayPanel::OnSize(evt);
}

References mOuter, BackedPanel::OnSize(), and UpdateRects().

Here is the call graph for this function:

◆ OnSyncSelToQuickPlay()

void AdornedRulerPanel::OnSyncSelToQuickPlay ( wxCommandEvent & evt )

private

Definition at line 2375 of file AdornedRulerPanel.cpp.

{
   mPlayRegionDragsSelection = (mPlayRegionDragsSelection) ? false : true;
   gPrefs->Write(wxT("/QuickPlay/DragSelection"), mPlayRegionDragsSelection);
   gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), gPrefs, mPlayRegionDragsSelection, audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

◆ OnThemeChange()

void AdornedRulerPanel::OnThemeChange ( struct ThemeChangeMessage message )

private

Definition at line 1665 of file AdornedRulerPanel.cpp.

{
   if (message.appearance)
      return;
   ReCreateButtons();
}

References ThemeChangeMessage::appearance, and ReCreateButtons().

Referenced by AdornedRulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTimelineFormatChange()

void AdornedRulerPanel::OnTimelineFormatChange ( wxCommandEvent & evt )

private

Definition at line 2361 of file AdornedRulerPanel.cpp.

{
   int id = event.GetId();
   TimeDisplayMode changeFlag = mTimeDisplayMode;
   wxASSERT(id == OnMinutesAndSecondsID || id == OnBeatsAndMeasuresID);
   mTimeDisplayMode = id == OnBeatsAndMeasuresID ? TimeDisplayMode::BeatsAndMeasures :
                                             TimeDisplayMode::MinutesAndSeconds;
   
   TimeDisplayModePreference.WriteEnum(mTimeDisplayMode);
 
   if (changeFlag != mTimeDisplayMode)
      Refresh();
}

References BeatsAndMeasures, MinutesAndSeconds, mTimeDisplayMode, OnBeatsAndMeasuresID, OnMinutesAndSecondsID, Refresh(), TimeDisplayModePreference, and TimeDisplayModeSetting::WriteEnum().

Here is the call graph for this function:

◆ OnTogglePinnedState()

void AdornedRulerPanel::OnTogglePinnedState ( wxCommandEvent & event )

private

Definition at line 2240 of file AdornedRulerPanel.cpp.

{
   TogglePinnedHead();
   UpdateButtonStates();
}

References TogglePinnedHead(), and UpdateButtonStates().

Here is the call graph for this function:

◆ OnTogglePlayRegion()

void AdornedRulerPanel::OnTogglePlayRegion ( wxCommandEvent & evt )

private

Definition at line 2405 of file AdornedRulerPanel.cpp.

{
   SelectUtilities::TogglePlayRegion(*mProject);
}

References mProject, and SelectUtilities::TogglePlayRegion().

Here is the call graph for this function:

◆ PlayRegionRectangle()

wxRect AdornedRulerPanel::PlayRegionRectangle ( ) const

private

Definition at line 2541 of file AdornedRulerPanel.cpp.

{
   const auto &viewInfo = ViewInfo::Get(*mProject);
   const auto &playRegion = viewInfo.playRegion;
   const auto t0 = playRegion.GetLastActiveStart(),
      t1 = playRegion.GetLastActiveEnd();
   return RegionRectangle(t0, t1);
}

References ViewInfo::Get(), mProject, and RegionRectangle().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Pos2Time()

double AdornedRulerPanel::Pos2Time	(	int	p,
		bool	ignoreFisheye = `false`
	)		const

private

Definition at line 1742 of file AdornedRulerPanel.cpp.

{
   return mViewInfo->PositionToTime(p, mLeftOffset
      , ignoreFisheye
   );
}

References mLeftOffset, CellularPanel::mViewInfo, and ZoomInfo::PositionToTime().

Referenced by DoDrawMarks(), and UpdateQuickPlayPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessUIHandleResult()

void AdornedRulerPanel::ProcessUIHandleResult	(	TrackPanelCell *	pClickedTrack,
		TrackPanelCell *	pLatestCell,
		unsigned	refreshResult
	)

overrideprivatevirtual

Implements CellularPanel.

Definition at line 2846 of file AdornedRulerPanel.cpp.

{
   if (refreshResult & RefreshCode::RefreshAll)
      Refresh(); // Overlays will be repainted too
   else if (refreshResult & RefreshCode::DrawOverlays)
      DrawBothOverlays(); // cheaper redrawing of guidelines only
}

References DrawBothOverlays(), RefreshCode::DrawOverlays, Refresh(), and RefreshCode::RefreshAll.

Here is the call graph for this function:

◆ ReCreateButtons()

void AdornedRulerPanel::ReCreateButtons ( )

Definition at line 1391 of file AdornedRulerPanel.cpp.

{
   // TODO: Should we do this to destroy the grabber??
   // Get rid of any children we may have
   // DestroyChildren();
 
   ToolBar::MakeButtonBackgroundsSmall();
   SetBackgroundColour(theTheme.Colour( clrMedium ));
 
   for (auto & button : mButtons) {
      if (button)
         button->Destroy();
      button = nullptr;
   }
 
   size_t iButton = 0;
   // Make the short row of time ruler push buttons.
   // Don't bother with sizers.  Their sizes and positions are fixed.
   // Add a grabber converted to a spacer.
   // This makes it visually clearer that the button is a button.
 
   wxPoint position( 1, 0 );
 
   Grabber * pGrabber = safenew Grabber(this, {});
   pGrabber->SetAsSpacer( true );
   //pGrabber->SetSize( 10, 27 ); // default is 10,27
   pGrabber->SetPosition( position );
 
   position.x = 12;
 
   auto size = theTheme.ImageSize( bmpRecoloredUpSmall );
   size.y = std::min(size.y, GetRulerHeight(false));
 
   auto buttonMaker = [&]
   (wxWindowID id, teBmps bitmap, bool toggle)
   {
      const auto button =
      ToolBar::MakeButton(
         this,
         bmpRecoloredUpSmall, bmpRecoloredDownSmall, 
         bmpRecoloredUpHiliteSmall, bmpRecoloredHiliteSmall, 
         bitmap, bitmap, bitmap,
         id, position, toggle, size
      );
 
      position.x += size.GetWidth();
      mButtons[iButton++] = button;
      return button;
   };
   auto button = buttonMaker(OnTogglePinnedStateID, bmpPlayPointerPinned, true);
   ToolBar::MakeAlternateImages(
      *button, 3,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall,
      bmpRecoloredUpHiliteSmall, bmpRecoloredHiliteSmall,
      //bmpUnpinnedPlayHead, bmpUnpinnedPlayHead, bmpUnpinnedPlayHead,
      bmpRecordPointer, bmpRecordPointer, bmpRecordPointer,
      size);
   ToolBar::MakeAlternateImages(
      *button, 2,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall,
      bmpRecoloredUpHiliteSmall, bmpRecoloredHiliteSmall,
      //bmpUnpinnedPlayHead, bmpUnpinnedPlayHead, bmpUnpinnedPlayHead,
      bmpRecordPointerPinned, bmpRecordPointerPinned, bmpRecordPointerPinned,
      size);
   ToolBar::MakeAlternateImages(
      *button, 1,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall, 
      bmpRecoloredUpHiliteSmall, bmpRecoloredHiliteSmall, 
      //bmpUnpinnedPlayHead, bmpUnpinnedPlayHead, bmpUnpinnedPlayHead,
      bmpPlayPointer, bmpPlayPointer, bmpPlayPointer,
      size);
 
   UpdateButtonStates();
}

References ThemeBase::Colour(), GetRulerHeight(), id, ThemeBase::ImageSize(), ToolBar::MakeAlternateImages(), ToolBar::MakeButton(), ToolBar::MakeButtonBackgroundsSmall(), mButtons, min(), OnTogglePinnedStateID, safenew, Grabber::SetAsSpacer(), size, theTheme, and UpdateButtonStates().

Referenced by OnThemeChange(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Refresh()

void AdornedRulerPanel::Refresh	(	bool	eraseBackground = `true`,
		const wxRect *	rect = `(const wxRect *) NULL`
	)

override

Definition at line 1356 of file AdornedRulerPanel.cpp.

{
   CellularPanel::Refresh( eraseBackground, rect );
   CallAfter([this]{ CellularPanel::HandleCursorForPresentMouseState(); } );
}

References BasicUI::CallAfter(), and CellularPanel::HandleCursorForPresentMouseState().

Referenced by AdornedRulerPanel(), ClearPlayRegion(), DoIdle(), DrawSelection(), OnTimelineFormatChange(), ProcessUIHandleResult(), SetPlayRegion(), SetTimeDisplayMode(), UpdatePrefs(), and TrackPanel::UpdateVRulerSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegionRectangle()

wxRect AdornedRulerPanel::RegionRectangle	(	double	t0,
		double	t1
	)		const

private

Definition at line 2558 of file AdornedRulerPanel.cpp.

{
   int p0 = -1, p1 = -1;
   if (t0 == t1)
      // Make the rectangle off-screen horizontally, but set the height
      ;
   else {
      p0 = max(1, Time2Pos(t0));
      p1 = min(mInner.width, Time2Pos(t1));
   }
 
   const int left = p0, top = mInner.y, right = p1, bottom = mInner.GetBottom();
   return { wxPoint{left, top}, wxPoint{right, bottom} };
}

References min(), mInner, and Time2Pos().

Referenced by PlayRegionRectangle(), and SelectedRegionRectangle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Root()

std::shared_ptr< TrackPanelNode > AdornedRulerPanel::Root ( )

overrideprivatevirtual

Implements CellularPanel.

Definition at line 2822 of file AdornedRulerPanel.cpp.

{
   // Root is a throwaway object
   return std::make_shared< MainGroup >( *this );
}

◆ SelectedRegionRectangle()

wxRect AdornedRulerPanel::SelectedRegionRectangle ( ) const

private

Definition at line 2550 of file AdornedRulerPanel.cpp.

{
   const auto &viewInfo = ViewInfo::Get(*mProject);
   const auto &selectedRegion = viewInfo.selectedRegion;
   const auto t0 = selectedRegion.t0(), t1 = selectedRegion.t1();
   return RegionRectangle(t0, t1);
}

References ViewInfo::Get(), mProject, and RegionRectangle().

Referenced by OnPaint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFocusedCell()

void AdornedRulerPanel::SetFocusedCell ( )

overrideprivatevirtual

Implements CellularPanel.

Definition at line 2841 of file AdornedRulerPanel.cpp.

2842{

2843}

◆ SetFocusFromKbd()

void AdornedRulerPanel::SetFocusFromKbd ( )

override

Definition at line 2776 of file AdornedRulerPanel.cpp.

{
   auto temp = TemporarilyAllowFocus();
   SetFocus();
}

References BasicUI::SetFocus(), and TemporarilyAllowFocus().

Here is the call graph for this function:

◆ SetLeftOffset()

void AdornedRulerPanel::SetLeftOffset ( int offset )

Definition at line 2655 of file AdornedRulerPanel.cpp.

{
   if (mLeftOffset != offset) {
      mLeftOffset = offset;
      mUpdater.SetData(mViewInfo, offset);
      mRuler.Invalidate();
   }
}

References Ruler::Invalidate(), mLeftOffset, mRuler, mUpdater, CellularPanel::mViewInfo, and LinearUpdater::SetData().

Referenced by TrackPanel::UpdateVRulerSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetNumGuides()

void AdornedRulerPanel::SetNumGuides ( size_t nn )

Definition at line 2763 of file AdornedRulerPanel.cpp.

{
   nn = std::min(nn, MAX_GUIDES);
   // If increasing the number of guides, reinitialize newer ones
   for (size_t ii = mNumGuides; ii < nn; ++ii) {
      mQuickPlayOffset[ii] = 0;
      mQuickPlayPosUnsnapped[ii] = 0;
      mQuickPlayPos[ii] = 0;
      mIsSnapped[ii] = false;
   }
   mNumGuides = nn;
}

References MAX_GUIDES, min(), mIsSnapped, mNumGuides, mQuickPlayOffset, mQuickPlayPos, and mQuickPlayPosUnsnapped.

Here is the call graph for this function:

◆ SetPanelSize()

bool AdornedRulerPanel::SetPanelSize ( )

Definition at line 2179 of file AdornedRulerPanel.cpp.

{
   const auto oldSize = GetSize();
   wxSize size { oldSize.GetWidth(), GetRulerHeight(ShowingScrubRuler()) };
   if ( size != oldSize ) {
      SetSize(size);
      SetMinSize(size);
      PostSizeEventToParent();
      return true;
   }
   else
      return false;
}

References GetRulerHeight(), ShowingScrubRuler(), and size.

Referenced by DoIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPlayRegion()

void AdornedRulerPanel::SetPlayRegion	(	double	playRegionStart,
		double	playRegionEnd
	)

Definition at line 2724 of file AdornedRulerPanel.cpp.

{
   // This is called by AudacityProject to make the play region follow
   // the current selection. But while the user is selecting a play region
   // with the mouse directly in the ruler, changes from outside are blocked.
   if (mMouseEventState != mesNone)
      return;
 
   auto &viewInfo = ViewInfo::Get( *GetProject() );
   auto &playRegion = viewInfo.playRegion;
   playRegion.SetTimes( playRegionStart, playRegionEnd );
 
   Refresh();
}

References ViewInfo::Get(), GetProject(), mesNone, mMouseEventState, and Refresh().

Referenced by DoSelectionChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTimeDisplayMode()

void AdornedRulerPanel::SetTimeDisplayMode ( TimeDisplayMode rulerType )

Definition at line 2896 of file AdornedRulerPanel.cpp.

{
   if (mTimeDisplayMode == type)
      return;
 
   mTimeDisplayMode = type;
   TimeDisplayModePreference.WriteEnum(mTimeDisplayMode);
   Refresh();
}

References mTimeDisplayMode, Refresh(), TimeDisplayModePreference, and TimeDisplayModeSetting::WriteEnum().

Here is the call graph for this function:

◆ ShowContextMenu()

void AdornedRulerPanel::ShowContextMenu	(	MenuChoice	choice,
		const wxPoint *	pPosition
	)

private

Definition at line 2421 of file AdornedRulerPanel.cpp.

{
   wxPoint position;
   if(pPosition)
      position = *pPosition;
   else
   {
      auto rect = GetRect();
      //Old code put menu too low down.  y position applied twice.
      //position = { rect.GetLeft() + 1, rect.GetBottom() + 1 };
 
      // The cell does not pass in the mouse or button position.
      // We happen to know this is the pin/unpin button
      // so these magic values 'fix a bug' - but really the cell should
      // pass more information to work with in.
      position = { rect.GetLeft() + 38, rect.GetHeight()/2 + 1 };
   }
 
   switch (choice) {
      case MenuChoice::QuickPlay:
         ShowMenu(position); 
         UpdateButtonStates();
         break;
      case MenuChoice::Scrub:
         ShowScrubMenu(position); break;
      default:
         return;
   }
}

References QuickPlay, Scrub, ShowMenu(), ShowScrubMenu(), and UpdateButtonStates().

Referenced by OnPinnedButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowingScrubRuler()

bool AdornedRulerPanel::ShowingScrubRuler ( ) const

Definition at line 2815 of file AdornedRulerPanel.cpp.

{
   auto &scrubber = Scrubber::Get( *GetProject() );
   return scrubber.ShowsBar();
}

References Scrubber::Get(), and GetProject().

Referenced by AdornedRulerPanel::Subgroup::Children(), DoDrawBackground(), DoDrawScrubIndicator(), ScrubbingToolBar::DoRegenerateTooltips(), ScrubbingToolBar::EnableDisableButtons(), SetPanelSize(), and UpdateRects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowMenu()

void AdornedRulerPanel::ShowMenu ( const wxPoint & pos )

private

Definition at line 2268 of file AdornedRulerPanel.cpp.

{
   const auto &viewInfo = ViewInfo::Get( *GetProject() );
   const auto &playRegion = viewInfo.playRegion;
   wxMenu rulerMenu;
 
   {
      auto item = rulerMenu.AppendRadioItem(OnMinutesAndSecondsID,
         _("Minutes and Seconds"));
      item->Check(mTimeDisplayMode == TimeDisplayMode::MinutesAndSeconds);
   }
 
   {
      auto item = rulerMenu.AppendRadioItem(OnBeatsAndMeasuresID,
         _("Beats and Measures"));
      item->Check(mTimeDisplayMode == TimeDisplayMode::BeatsAndMeasures);
   }
 
   rulerMenu.AppendSeparator();
 
   auto pDrag = rulerMenu.AppendCheckItem(OnSyncQuickPlaySelID, _("Setting a loop region also makes an audio selection"));
   pDrag->Check(mPlayRegionDragsSelection && playRegion.Active());
   pDrag->Enable(playRegion.Active());
 
   rulerMenu.AppendCheckItem(OnAutoScrollID, _("Update display while playing"))->
      Check(mViewInfo->bUpdateTrackIndicator);
 
   {
      auto item = rulerMenu.AppendCheckItem(OnTogglePlayRegionID,
         LoopToggleText.Stripped().Translation());
      item->Check(playRegion.Active());
   }
 
   {
      auto item = rulerMenu.Append(OnClearPlayRegionID,
         /* i18n-hint Clear is a verb */
         _("Clear Loop"));
   }
 
   {
      auto item = rulerMenu.Append(OnSetPlayRegionToSelectionID,
         _("Set Loop To Selection"));
   }
 
   rulerMenu.AppendSeparator();
   rulerMenu.AppendCheckItem(OnTogglePinnedStateID, _("Pinned Play Head"))->
      Check(TracksPrefs::GetPinnedHeadPreference());
 
   BasicMenu::Handle{ &rulerMenu }.Popup(
      wxWidgetsWindowPlacement{ this },
      { pos.x, pos.y }
   );
}

References _, BeatsAndMeasures, ViewInfo::bUpdateTrackIndicator, ViewInfo::Get(), TracksPrefs::GetPinnedHeadPreference(), GetProject(), LoopToggleText, MinutesAndSeconds, mPlayRegionDragsSelection, mTimeDisplayMode, CellularPanel::mViewInfo, OnAutoScrollID, OnBeatsAndMeasuresID, OnClearPlayRegionID, OnMinutesAndSecondsID, OnSetPlayRegionToSelectionID, OnSyncQuickPlaySelID, OnTogglePinnedStateID, OnTogglePlayRegionID, BasicMenu::Handle::Popup(), TranslatableString::Stripped(), and TranslatableString::Translation().

Referenced by ShowContextMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ShowScrubMenu()

void AdornedRulerPanel::ShowScrubMenu ( const wxPoint & pos )

private

Definition at line 2322 of file AdornedRulerPanel.cpp.

{
   auto &scrubber = Scrubber::Get( *mProject );
   PushEventHandler(&scrubber);
   auto cleanup = finally([this]{ PopEventHandler(); });
 
   wxMenu rulerMenu;
   scrubber.PopulatePopupMenu(rulerMenu);
   BasicMenu::Handle{ &rulerMenu }.Popup(
      wxWidgetsWindowPlacement{ this },
      { pos.x, pos.y }
   );
}

References Scrubber::Get(), mProject, and BasicMenu::Handle::Popup().

Referenced by ShowContextMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartQPPlay()

void AdornedRulerPanel::StartQPPlay	(	bool	newDefault,
		bool	cutPreview,
		const double *	pStartTime = `nullptr`
	)

private

Definition at line 2097 of file AdornedRulerPanel.cpp.

{
   const double t0 = mTracks->GetStartTime();
   const double t1 = mTracks->GetEndTime();
   auto &viewInfo = ViewInfo::Get( *mProject );
   const auto &playRegion = viewInfo.playRegion;
   const auto &selectedRegion = viewInfo.selectedRegion;
   const double sel0 = selectedRegion.t0();
   const double sel1 = selectedRegion.t1();
 
   // Start / Restart playback on left click.
   bool startPlaying = true; // = (playRegion.GetStart() >= 0);
 
   if (startPlaying) {
      bool loopEnabled = true;
      auto oldStart = std::max(0.0, playRegion.GetStart());
      double start = oldStart, end = 0;
 
      if (playRegion.Empty()) {
         // Play either a selection or the project.
         if (oldStart > sel0 && oldStart < sel1) {
            // we are in a selection, so use the selection
            start = sel0;
            end = sel1;
         } // not in a selection, so use the project
         else {
            start = t0;
            end = t1;
         }
      }
      else
         end = std::max(start, playRegion.GetEnd());
 
      // Looping a tiny selection may freeze, so just play it once.
      loopEnabled = ((end - start) > 0.001)? true : false;
 
      newDefault = (loopEnabled && newDefault);
      if (newDefault)
         cutPreview = false;
      auto options = ProjectAudioIO::GetDefaultOptions(*mProject, newDefault);
 
      if (!cutPreview) {
         if (pStartTime)
            options.pStartTime.emplace(*pStartTime);
      }
      else
         options.envelope = nullptr;
 
      auto mode =
         cutPreview ? PlayMode::cutPreviewPlay
         : newDefault ? PlayMode::loopedPlay
         : PlayMode::normalPlay;
 
      // Stop only after deciding where to start again, because an event
      // callback may change the play region back to the selection
      auto &projectAudioManager = ProjectAudioManager::Get( *mProject );
      projectAudioManager.Stop();
 
      // Don't change play region, assume caller set it as needed
      // playRegion.SetTimes( start, end );
      // Refresh();
 
      projectAudioManager.PlayPlayRegion((SelectedRegion(start, end)),
                          options, mode,
                          false);
 
   }
}

References cutPreviewPlay, PackedArray::end(), ViewInfo::Get(), ProjectAudioManager::Get(), ProjectAudioIO::GetDefaultOptions(), TrackList::GetEndTime(), TrackList::GetStartTime(), loopedPlay, mProject, mTracks, and normalPlay.

Here is the call graph for this function:

◆ TemporarilyAllowFocus()

auto AdornedRulerPanel::TemporarilyAllowFocus ( )

static

Definition at line 2758 of file AdornedRulerPanel.cpp.

                                                                {
   s_AcceptsFocus = true;
   return TempAllowFocus{ &s_AcceptsFocus };
}

Referenced by SetFocusFromKbd().

Here is the caller graph for this function:

◆ Time2Pos()

int AdornedRulerPanel::Time2Pos	(	double	t,
		bool	ignoreFisheye = `false`
	)		const

private

Definition at line 1749 of file AdornedRulerPanel.cpp.

{
   return mViewInfo->TimeToPosition(t, mLeftOffset
      , ignoreFisheye
   );
}

References mLeftOffset, CellularPanel::mViewInfo, and ZoomInfo::TimeToPosition().

Referenced by IsWithinMarker(), and RegionRectangle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TogglePinnedHead()

void AdornedRulerPanel::TogglePinnedHead ( )

Definition at line 2876 of file AdornedRulerPanel.cpp.

{
   bool value = !TracksPrefs::GetPinnedHeadPreference();
   TracksPrefs::SetPinnedHeadPreference(value, true);
   ToolManager::ModifyAllProjectToolbarMenus();
 
   auto &project = *mProject;
   // Update button image
   UpdateButtonStates();
 
   auto &scrubber = Scrubber::Get( project );
   if (scrubber.HasMark())
      scrubber.SetScrollScrubbing(value);
}

References Scrubber::Get(), TracksPrefs::GetPinnedHeadPreference(), ToolManager::ModifyAllProjectToolbarMenus(), mProject, project, TracksPrefs::SetPinnedHeadPreference(), and UpdateButtonStates().

Referenced by anonymous_namespace{AdornedRulerPanel.cpp}::OnTogglePinnedHead(), and OnTogglePinnedState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateButtonStates()

void AdornedRulerPanel::UpdateButtonStates ( )

Definition at line 2205 of file AdornedRulerPanel.cpp.

{
   auto common = [this](
      AButton &button, const CommandID &commandName, const TranslatableString &label) {
      ComponentInterfaceSymbol command{ commandName, label };
      ToolBar::SetButtonToolTip( *mProject, button, &command, 1u );
      button.SetLabel( Verbatim( button.GetToolTipText() ) );
 
      button.UpdateStatus();
   };
 
   {
      // The button always reflects the pinned head preference, even though
      // there is also a Playback preference that may overrule it for scrubbing
      bool state = TracksPrefs::GetPinnedHeadPreference();
      auto pinButton = static_cast<AButton*>(FindWindow(OnTogglePinnedStateID));
      if( !state )
         pinButton->PopUp();
      else
         pinButton->PushDown();
      auto gAudioIO = AudioIO::Get();
      pinButton->SetAlternateIdx(
         (gAudioIO->IsCapturing() ? 2 : 0) + (state ? 0 : 1));
      // Bug 1584: Tooltip now shows what clicking will do.
      // Bug 2357: Action of button (and hence tooltip wording) updated.
      const auto label = XO("Timeline Options");
      common(*pinButton, wxT("PinnedHead"), label);
   }
}

References AudioIO::Get(), TracksPrefs::GetPinnedHeadPreference(), label, mProject, OnTogglePinnedStateID, AButton::PopUp(), ToolBar::SetButtonToolTip(), AButton::SetLabel(), AButton::UpdateStatus(), Verbatim(), wxT(), and XO().

Referenced by OnAudioStartStop(), OnTogglePinnedState(), ReCreateButtons(), ShowContextMenu(), TogglePinnedHead(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePrefs()

void AdornedRulerPanel::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 1362 of file AdornedRulerPanel.cpp.

{
   if (mNeedButtonUpdate) {
      // Visit this block once only in the lifetime of this panel
      mNeedButtonUpdate = false;
      // Do this first time setting of button status texts
      // when we are sure the CommandManager is initialized.
      ReCreateButtons();
   }
 
   // Update button texts for language change
   UpdateButtonStates();
 
   mTimelineToolTip = !!gPrefs->Read(wxT("/QuickPlay/ToolTips"), 1L);
 
#ifdef EXPERIMENTAL_SCROLLING_LIMITS
#ifdef EXPERIMENTAL_TWO_TONE_TIME_RULER
   {
      auto scrollBeyondZero = ScrollingPreference.Read();
      mRuler.SetTwoTone(scrollBeyondZero);
   }
#endif
#endif
 
   mTimeDisplayMode = TimeDisplayModePreference.ReadEnum();
   Refresh();
   // Update();
}

References gPrefs, mNeedButtonUpdate, mRuler, mTimeDisplayMode, mTimelineToolTip, audacity::BasicSettings::Read(), Setting< T >::Read(), EnumSetting< Enum >::ReadEnum(), ReCreateButtons(), Refresh(), ScrollingPreference, Ruler::SetTwoTone(), TimeDisplayModePreference, UpdateButtonStates(), and wxT().

Referenced by AdornedRulerPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateQuickPlayPos()

void AdornedRulerPanel::UpdateQuickPlayPos ( wxCoord & mousePosX )

Definition at line 2246 of file AdornedRulerPanel.cpp.

{
   // Invoked for mouse-over preview events, or dragging, or scrub position
   // polling updates.  Remember x coordinates, converted to times, for
   // drawing of guides.
 
   // Keep Quick-Play within usable track area.  (Dependent on zoom)
   const auto &viewInfo = ViewInfo::Get( *mProject );
   auto width = viewInfo.GetTracksUsableWidth();
   mousePosX = std::max(mousePosX, viewInfo.GetLeftOffset());
   mousePosX = std::min(mousePosX, viewInfo.GetLeftOffset() + width - 1);
   const auto time = Pos2Time(mousePosX);
 
   for (size_t ii = 0; ii < mNumGuides; ++ii) {
      mQuickPlayPosUnsnapped[ii] = mQuickPlayPos[ii] =
         time + mQuickPlayOffset[ii];
      HandleSnapping(ii);
   }
}

References ViewInfo::Get(), HandleSnapping(), min(), mNumGuides, mProject, mQuickPlayOffset, mQuickPlayPos, mQuickPlayPosUnsnapped, and Pos2Time().

Here is the call graph for this function:

◆ UpdateRects()

bool AdornedRulerPanel::UpdateRects ( )

private

Definition at line 1689 of file AdornedRulerPanel.cpp.

{
   auto inner = mOuter;
   wxRect scrubZone;
   inner.x += LeftMargin;
   inner.width -= (LeftMargin + RightMargin);
 
   auto top = &inner;
   auto bottom = &inner;
 
   if (ShowingScrubRuler()) {
      scrubZone = inner;
      auto scrubHeight = std::min(scrubZone.height, (int)(ScrubHeight));
 
      int topHeight;
#ifdef SCRUB_ABOVE
      top = &scrubZone, topHeight = scrubHeight;
#else
      auto qpHeight = scrubZone.height - scrubHeight;
      bottom = &scrubZone, topHeight = qpHeight;
      // Increase scrub zone height so that hit testing finds it and
      // not QP region, when on bottom 'edge'.
      scrubZone.height+=BottomMargin;
#endif
 
      top->height = topHeight;
      bottom->height -= topHeight;
      bottom->y += topHeight;
   }
 
   top->y += TopMargin;
   top->height -= TopMargin;
 
   bottom->height -= BottomMargin;
 
   if (!ShowingScrubRuler())
      scrubZone = inner;
 
   if ( inner == mInner && scrubZone == mScrubZone )
      // no changes
      return false;
 
   mInner = inner;
   mScrubZone = scrubZone;
 
   mRuler.SetBounds(mInner.GetLeft(),
                    mInner.GetTop(),
                    mInner.GetRight(),
                    mInner.GetBottom());
 
   return true;
}

References BottomMargin, LeftMargin, min(), mInner, mOuter, mRuler, mScrubZone, RightMargin, ScrubHeight, Ruler::SetBounds(), ShowingScrubRuler(), and TopMargin.

Referenced by DoIdle(), and OnSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateStatusMessage()

void AdornedRulerPanel::UpdateStatusMessage ( const TranslatableString & message )

overrideprivatevirtual

Implements CellularPanel.

Definition at line 2855 of file AdornedRulerPanel.cpp.

{
   ProjectStatus::Get( *GetProject() ).Set(message);
}

References ProjectStatus::Get(), GetProject(), and ProjectStatus::Set().

Here is the call graph for this function:

Member Data Documentation

◆ mAudioIOSubscription

Observer::Subscription AdornedRulerPanel::mAudioIOSubscription

private

Definition at line 247 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ MAX_GUIDES

constexpr size_t AdornedRulerPanel::MAX_GUIDES = 2

staticconstexprprivate

Definition at line 154 of file AdornedRulerPanel.h.

Referenced by SetNumGuides().

◆ mButtons

wxWindow* AdornedRulerPanel::mButtons[3]

private

Definition at line 201 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), and ReCreateButtons().

◆ mIndTime

double AdornedRulerPanel::mIndTime

private

Definition at line 152 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ mInner

wxRect AdornedRulerPanel::mInner

private

Definition at line 147 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel::Subgroup::Children(), AdornedRulerPanel::MainGroup::Children(), DoDrawBackground(), DoDrawMarks(), DoDrawScrubIndicator(), RegionRectangle(), and UpdateRects().

◆ mIsDragging

bool AdornedRulerPanel::mIsDragging

private

Definition at line 197 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ mIsRecording

bool AdornedRulerPanel::mIsRecording

private

Definition at line 163 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), and OnAudioStartStop().

◆ mIsSnapped

bool AdornedRulerPanel::mIsSnapped[MAX_GUIDES] {}

private

Definition at line 158 of file AdornedRulerPanel.h.

Referenced by HandleSnapping(), and SetNumGuides().

◆ mLastDrawnH

double AdornedRulerPanel::mLastDrawnH {}

private

Definition at line 259 of file AdornedRulerPanel.h.

Referenced by DoIdle(), and OnPaint().

◆ mLastDrawnPlayRegion

std::pair<double, double> AdornedRulerPanel::mLastDrawnPlayRegion {}

private

Definition at line 257 of file AdornedRulerPanel.h.

Referenced by DoIdle(), and OnPaint().

◆ mLastDrawnSelectedRegion

SelectedRegion AdornedRulerPanel::mLastDrawnSelectedRegion

private

Definition at line 256 of file AdornedRulerPanel.h.

Referenced by DoIdle(), and OnPaint().

◆ mLastDrawnZoom

double AdornedRulerPanel::mLastDrawnZoom {}

private

Definition at line 260 of file AdornedRulerPanel.h.

Referenced by DoIdle(), and OnPaint().

◆ mLastPlayRegionActive

bool AdornedRulerPanel::mLastPlayRegionActive = false

private

Definition at line 258 of file AdornedRulerPanel.h.

Referenced by DoDrawOverlap(), DoDrawPlayRegion(), and DoIdle().

◆ mLeftDownClick

double AdornedRulerPanel::mLeftDownClick

private

Definition at line 196 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ mLeftDownClickUnsnapped

double AdornedRulerPanel::mLeftDownClickUnsnapped

private

Definition at line 195 of file AdornedRulerPanel.h.

◆ mLeftOffset

int AdornedRulerPanel::mLeftOffset

private

Definition at line 149 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), Pos2Time(), SetLeftOffset(), and Time2Pos().

◆ mMouseEventState

MouseEventState AdornedRulerPanel::mMouseEventState

private

Definition at line 194 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), and SetPlayRegion().

◆ mNeedButtonUpdate

bool AdornedRulerPanel::mNeedButtonUpdate { true }

private

Definition at line 202 of file AdornedRulerPanel.h.

Referenced by UpdatePrefs().

◆ mNumGuides

size_t AdornedRulerPanel::mNumGuides { 1 }

private

Definition at line 159 of file AdornedRulerPanel.h.

Referenced by SetNumGuides(), and UpdateQuickPlayPos().

◆ mOldPlayRegion

PlayRegion AdornedRulerPanel::mOldPlayRegion

private

Definition at line 161 of file AdornedRulerPanel.h.

◆ mOuter

wxRect AdornedRulerPanel::mOuter

private

Definition at line 145 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), DoDrawEdge(), OnSize(), and UpdateRects().

◆ mOverlay

std::shared_ptr<TrackPanelGuidelineOverlay> AdornedRulerPanel::mOverlay

private

Definition at line 226 of file AdornedRulerPanel.h.

Referenced by CreateOverlays().

◆ mPlayRegionDragsSelection

bool AdornedRulerPanel::mPlayRegionDragsSelection

private

Definition at line 183 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), AdornedRulerPanel::PlayRegionAdjustingHandle::Drag(), HandleSnapping(), OnSyncSelToQuickPlay(), and ShowMenu().

◆ mPlayRegionSubscription

Observer::Subscription AdornedRulerPanel::mPlayRegionSubscription

private

Definition at line 248 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ mProject

AudacityProject* const AdornedRulerPanel::mProject

private

Definition at line 138 of file AdornedRulerPanel.h.

Referenced by CreateOverlays(), DoDrawPlayRegion(), DoIdle(), AdornedRulerPanel::TrackPanelGuidelineOverlay::Draw(), GetProject(), HandleSnapping(), OnClearPlayRegion(), OnSetPlayRegionToSelection(), OnTogglePlayRegion(), PlayRegionRectangle(), SelectedRegionRectangle(), ShowScrubMenu(), StartQPPlay(), TogglePinnedHead(), AdornedRulerPanel::TrackPanelGuidelineOverlay::Update(), UpdateButtonStates(), and UpdateQuickPlayPos().

◆ mQPCell

std::shared_ptr<QPCell> AdornedRulerPanel::mQPCell

private

Definition at line 242 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), AdornedRulerPanel::Subgroup::Children(), AdornedRulerPanel::QPCell::ContextMenuDelegate(), and GetFocusedCell().

◆ mQuickPlayOffset

double AdornedRulerPanel::mQuickPlayOffset[MAX_GUIDES] {}

private

Definition at line 155 of file AdornedRulerPanel.h.

Referenced by SetNumGuides(), and UpdateQuickPlayPos().

◆ mQuickPlayPos

double AdornedRulerPanel::mQuickPlayPos[MAX_GUIDES] {}

private

Definition at line 157 of file AdornedRulerPanel.h.

Referenced by HandleSnapping(), SetNumGuides(), and UpdateQuickPlayPos().

◆ mQuickPlayPosUnsnapped

double AdornedRulerPanel::mQuickPlayPosUnsnapped[MAX_GUIDES] {}

private

Definition at line 156 of file AdornedRulerPanel.h.

Referenced by SetNumGuides(), and UpdateQuickPlayPos().

◆ mRuler

Ruler& AdornedRulerPanel::mRuler

private

Definition at line 141 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), DoDrawMarks(), GetMaxSize(), InvalidateRuler(), SetLeftOffset(), UpdatePrefs(), and UpdateRects().

◆ mRulerInvalidatedSubscription

Observer::Subscription AdornedRulerPanel::mRulerInvalidatedSubscription

private

Definition at line 250 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ mScrubbingCell

std::shared_ptr<ScrubbingCell> AdornedRulerPanel::mScrubbingCell

private

Definition at line 245 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), AdornedRulerPanel::Subgroup::Children(), and AdornedRulerPanel::ScrubbingCell::ContextMenuDelegate().

◆ mScrubZone

wxRect AdornedRulerPanel::mScrubZone

private

Definition at line 146 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel::Subgroup::Children(), DoDrawBackground(), DoDrawScrubIndicator(), and UpdateRects().

◆ mThemeChangeSubscription

Observer::Subscription AdornedRulerPanel::mThemeChangeSubscription

private

Definition at line 249 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel().

◆ mTimeDisplayMode

TimeDisplayMode AdornedRulerPanel::mTimeDisplayMode

private

Definition at line 268 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), DoDrawMarks(), GetTimeDisplayMode(), OnTimelineFormatChange(), SetTimeDisplayMode(), ShowMenu(), and UpdatePrefs().

◆ mTimelineToolTip

bool AdornedRulerPanel::mTimelineToolTip

private

Definition at line 184 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), and UpdatePrefs().

◆ mTracks

TrackList* AdornedRulerPanel::mTracks

private

Definition at line 143 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), HandleSnapping(), and StartQPPlay().

◆ mUpdater

LinearUpdater& AdornedRulerPanel::mUpdater

private

Definition at line 140 of file AdornedRulerPanel.h.

Referenced by AdornedRulerPanel(), and SetLeftOffset().

◆ s_AcceptsFocus

bool AdornedRulerPanel::s_AcceptsFocus { false }

staticprivate

Definition at line 119 of file AdornedRulerPanel.h.

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

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TempAllowFocus

Member Enumeration Documentation

◆ MenuChoice

◆ MouseEventState

Constructor & Destructor Documentation

◆ AdornedRulerPanel()

◆ ~AdornedRulerPanel()

Member Function Documentation

◆ AcceptsFocus()

◆ AcceptsFocusFromKeyboard()

◆ ClearPlayRegion()

◆ CreateOverlays()

◆ Destroy()

◆ DoDrawBackground()

◆ DoDrawEdge()

◆ DoDrawMarks()

◆ DoDrawOverlap()

◆ DoDrawPlayRegion()

◆ DoDrawPlayRegionLimits()

◆ DoDrawScrubIndicator()

◆ DoDrawSelection()

◆ DoIdle()

◆ DoSelectionChange()

◆ DragSelection()

◆ DrawBothOverlays()

◆ DrawSelection()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetFocusedCell()

◆ GetInnerRect()

◆ GetMaxSize()

◆ GetProject()

◆ GetRulerHeight() [1/2]

◆ GetRulerHeight() [2/2]

◆ GetTimeDisplayMode()

◆ HandleQPClick()

◆ HandleQPDrag()

◆ HandleQPRelease()

◆ HandleSnapping()

◆ InvalidateRuler()

◆ IsWithinMarker()

◆ OnAudioStartStop()

◆ OnAutoScroll()

◆ OnClearPlayRegion()

◆ OnIdle()

◆ OnLeave()

◆ OnPaint()

◆ OnPinnedButton()

◆ OnSelectionChange()

◆ OnSetPlayRegionToSelection()

◆ OnSize()

◆ OnSyncSelToQuickPlay()

◆ OnThemeChange()

◆ OnTimelineFormatChange()

◆ OnTogglePinnedState()

◆ OnTogglePlayRegion()

◆ PlayRegionRectangle()

◆ Pos2Time()

◆ ProcessUIHandleResult()

◆ ReCreateButtons()

◆ Refresh()

◆ RegionRectangle()

◆ Root()

◆ SelectedRegionRectangle()

◆ SetFocusedCell()

◆ SetFocusFromKbd()

◆ SetLeftOffset()

◆ SetNumGuides()

◆ SetPanelSize()