A top-level window associated with a project, and handling scrollbars and zooming. More...

#include <ProjectWindow.h>

Inheritance diagram for ProjectWindow:

Collaboration diagram for ProjectWindow:

Classes
class	PlaybackScroller

Public Member Functions
	ProjectWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, AudacityProject &project)

	~ProjectWindow () override

int	NextWindowID ()

bool	IsActive () override

bool	IsIconized () const override

bool	IsBeingDeleted () const

void	SetIsBeingDeleted ()

wxWindow *	GetMainPage ()

wxPanel *	GetMainPanel ()

wxPanel *	GetTopPanel ()

void	UpdateStatusWidths ()

PlaybackScroller &	GetPlaybackScroller ()

void	SetNormalizedWindowState (wxRect pSizeAndLocation)

wxRect	GetNormalizedWindowState () const

void	RedrawProject (const bool bForceWaveTracks=false)

void	Zoom (double level)

void	ZoomInByFactor (double ZoomFactor)

void	ZoomOutByFactor (double ZoomFactor)

void	ZoomBy (double multiplier)

void	ZoomAfterImport (Track *pTrack)

double	GetZoomOfToFit () const

void	DoZoomFit ()

void	ApplyUpdatedTheme ()

wxScrollBar &	GetVerticalScrollBar ()

wxScrollBar &	GetHorizontalScrollBar ()

void	ScrollIntoView (double pos)

void	ScrollIntoView (int x)

void	OnScrollLeft ()

void	OnScrollRight ()

void	Rewind (bool shift)

void	SkipEnd (bool shift)

void	OnScrollLeftButton (wxScrollEvent &event)

void	OnScrollRightButton (wxScrollEvent &event)

void	FinishAutoScroll ()

void	FixScrollbars ()

bool	MayScrollBeyondZero () const

double	ScrollingLowerBoundTime () const

double	PixelWidthBeforeTime (double scrollto) const

void	SetHorizontalThumb (double scrollto)

wxSize	GetTPTracksUsableArea ()

void	RefreshTPTrack (Track *pTrk, bool refreshbacking=true)

void	TP_RedrawScrollbars () override

void	TP_ScrollLeft () override

void	TP_ScrollRight () override

void	TP_ScrollWindow (double scrollto) override

bool	TP_ScrollUpDown (int delta) override

void	TP_HandleResize () override

void	OnMenu (wxCommandEvent &event)

void	OnUpdateUI (wxUpdateUIEvent &event)

void	MacShowUndockedToolbars (bool show)

void	OnActivate (wxActivateEvent &event)

void	OnMouseEvent (wxMouseEvent &event)

void	OnIconize (wxIconizeEvent &event)

void	OnSize (wxSizeEvent &event)

void	HandleResize ()

void	UpdateLayout ()

void	OnShow (wxShowEvent &event)

void	OnMove (wxMoveEvent &event)

void	DoScroll ()

void	OnScroll (wxScrollEvent &event)

void	OnToolBarUpdate (wxCommandEvent &event)

void	OnUndoPushedModified (wxCommandEvent &)

void	OnUndoRedo (wxCommandEvent &)

void	OnUndoReset (wxCommandEvent &)

Public Member Functions inherited from ProjectWindowBase
	ProjectWindowBase (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, AudacityProject &project)

	~ProjectWindowBase () override

AudacityProject &	GetProject ()

const AudacityProject &	GetProject () const

Public Member Functions inherited from TrackPanelListener
	TrackPanelListener ()

virtual	~TrackPanelListener ()

Public Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

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

static const ProjectWindow &	Get (const AudacityProject &project)

static ProjectWindow *	Find (AudacityProject *pProject)

static const ProjectWindow *	Find (const AudacityProject *pProject)

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

Public Attributes
bool	mbInitializingScrollbar { false }

Private Member Functions
void	OnThemeChange (wxCommandEvent &evt)

void	UpdatePrefs () override

Private Attributes
wxRect	mNormalizedWindowState

wxPanel *	mTopPanel {}

wxWindow *	mMainPage {}

wxPanel *	mMainPanel {}

wxScrollBar *	mHsbar {}

wxScrollBar *	mVsbar {}

int	mNextWindowID {}

bool	mAutoScrolling { false }

bool	mActive { true }

bool	mIconized { false }

bool	mShownOnce { false }

bool	mIsDeleting { false }

std::unique_ptr< PlaybackScroller >	mPlaybackScroller

Additional Inherited Members
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Protected Attributes inherited from ProjectWindowBase
AudacityProject &	mProject

Detailed Description

A top-level window associated with a project, and handling scrollbars and zooming.

Definition at line 29 of file ProjectWindow.h.

Constructor & Destructor Documentation

◆ ProjectWindow()

ProjectWindow::ProjectWindow	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		AudacityProject &	project
	)

explicit

Definition at line 580 of file ProjectWindow.cpp.

    : ProjectWindowBase{ parent, id, pos, size, project }
 {
    mNextWindowID = NextID;
  
    // Two sub-windows need to be made before Init(),
    // so that this constructor can complete, and then TrackPanel and
    // AdornedRulerPanel can retrieve those windows from this in their
    // factory functions
  
    // PRL:  this panel groups the top tool dock and the ruler into one
    // tab cycle.
    // Must create it with non-default width equal to the main window width,
    // or else the device toolbar doesn't make initial widths of the choice
    // controls correct.
    mTopPanel = safenew wxPanelWrapper {
       this, wxID_ANY, wxDefaultPosition,
       wxSize{ this->GetSize().GetWidth(), -1 }
    };
    mTopPanel->SetLabel( "Top Panel" );// Not localised
    mTopPanel->SetLayoutDirection(wxLayout_LeftToRight);
    mTopPanel->SetAutoLayout(true);
 #ifdef EXPERIMENTAL_DA2
    mTopPanel->SetBackgroundColour(theTheme.Colour( clrMedium ));
 #endif
  
    wxWindow    * pPage;
  
 #ifdef EXPERIMENTAL_NOTEBOOK
    // We are using a notebook (tabbed panel), so we create the notebook and add pages.
    GuiFactory Factory;
    wxNotebook  * pNotebook;
    mMainPanel = Factory.AddPanel(
       this, wxPoint( left, top ), wxSize( width, height ) );
    pNotebook  = Factory.AddNotebook( mMainPanel );
    /* i18n-hint: This is an experimental feature where the main panel in
       Audacity is put on a notebook tab, and this is the name on that tab.
       Other tabs in that notebook may have instruments, patch panels etc.*/
    pPage = Factory.AddPage( pNotebook, _("Main Mix"));
 #else
    // Not using a notebook, so we place the track panel inside another panel,
    // this keeps the notebook code and normal code consistent and also
    // paves the way for adding additional windows inside the track panel.
    mMainPanel = safenew wxPanelWrapper(this, -1,
       wxDefaultPosition,
       wxDefaultSize,
       wxNO_BORDER);
    mMainPanel->SetSizer( safenew wxBoxSizer(wxVERTICAL) );
    mMainPanel->SetLabel("Main Panel");// Not localised.
    pPage = mMainPanel;
    // Set the colour here to the track panel background to avoid
    // flicker when Audacity starts up.
    // However, that leads to areas next to the horizontal scroller
    // being painted in background colour and not scroller background
    // colour, so suppress this for now.
    //pPage->SetBackgroundColour( theTheme.Colour( clrDark ));
 #endif
    pPage->SetLayoutDirection(wxLayout_LeftToRight);
  
 #ifdef EXPERIMENTAL_DA2
    pPage->SetBackgroundColour(theTheme.Colour( clrMedium ));
 #endif
  
    mMainPage = pPage;
  
    mPlaybackScroller = std::make_unique<PlaybackScroller>( &project );
  
    // PRL: Old comments below.  No longer observing the ordering that it
    //      recommends.  ProjectWindow::OnActivate puts the focus directly into
    //      the TrackPanel, which avoids the problems.
    // LLL: When Audacity starts or becomes active after returning from
    //      another application, the first window that can accept focus
    //      will be given the focus even if we try to SetFocus().  By
    //      creating the scrollbars after the TrackPanel, we resolve
    //      several focus problems.
  
    mHsbar = safenew ScrollBar(pPage, HSBarID, wxSB_HORIZONTAL);
    mVsbar = safenew ScrollBar(pPage, VSBarID, wxSB_VERTICAL);
 #if wxUSE_ACCESSIBILITY
    // so that name can be set on a standard control
    mHsbar->SetAccessible(safenew WindowAccessible(mHsbar));
    mVsbar->SetAccessible(safenew WindowAccessible(mVsbar));
 #endif
    mHsbar->SetLayoutDirection(wxLayout_LeftToRight);
    mHsbar->SetName(_("Horizontal Scrollbar"));
    mVsbar->SetName(_("Vertical Scrollbar"));
  
    project.Bind( EVT_UNDO_MODIFIED, &ProjectWindow::OnUndoPushedModified, this );
    project.Bind( EVT_UNDO_PUSHED, &ProjectWindow::OnUndoPushedModified, this );
    project.Bind( EVT_UNDO_OR_REDO, &ProjectWindow::OnUndoRedo, this );
    project.Bind( EVT_UNDO_RESET, &ProjectWindow::OnUndoReset, this );
  
    wxTheApp->Bind(EVT_THEME_CHANGE, &ProjectWindow::OnThemeChange, this);
 }

References id, and size.

◆ ~ProjectWindow()

ProjectWindow::~ProjectWindow ( )

override

Definition at line 677 of file ProjectWindow.cpp.

 {
    // Tool manager gives us capture sometimes
    if(HasCapture())
       ReleaseMouse();
 }

Member Function Documentation

◆ ApplyUpdatedTheme()

void ProjectWindow::ApplyUpdatedTheme ( )

Definition at line 703 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    SetBackgroundColour(theTheme.Colour( clrMedium ));
    ClearBackground();// For wxGTK.
 }

References ThemeBase::Colour(), and theTheme.

Referenced by OnThemeChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoScroll()

void ProjectWindow::DoScroll ( )

Definition at line 1439 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &trackPanel = GetProjectPanel( project );
    auto &viewInfo = ViewInfo::Get( project );
    const double lowerBound = ScrollingLowerBoundTime();
  
    auto width = viewInfo.GetTracksUsableWidth();
    viewInfo.SetBeforeScreenWidth(viewInfo.sbarH, width, lowerBound);
  
  
    if (MayScrollBeyondZero()) {
       enum { SCROLL_PIXEL_TOLERANCE = 10 };
       if (std::abs(viewInfo.TimeToPosition(0.0, 0
                                    )) < SCROLL_PIXEL_TOLERANCE) {
          // Snap the scrollbar to 0
          viewInfo.h = 0;
          SetHorizontalThumb(0.0);
       }
    }
  
    viewInfo.vpos = mVsbar->GetThumbPosition() * viewInfo.scrollStep;
  
    //mchinen: do not always set this project to be the active one.
    //a project may autoscroll while playing in the background
    //I think this is okay since OnMouseEvent has one of these.
    //SetActiveProject(this);
  
    if (!mAutoScrolling) {
       trackPanel.Refresh(false);
    }
 }

References ViewInfo::Get(), GetProjectPanel(), mAutoScrolling, MayScrollBeyondZero(), ProjectWindowBase::mProject, mVsbar, ScrollingLowerBoundTime(), and SetHorizontalThumb().

Referenced by FinishAutoScroll(), OnScroll(), OnScrollLeftButton(), OnScrollRightButton(), TP_ScrollUpDown(), and TP_ScrollWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoZoomFit()

void ProjectWindow::DoZoomFit ( )

Definition at line 1843 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    auto &tracks = TrackList::Get( project );
    auto &window = *this;
  
    const double start = viewInfo.bScrollBeyondZero
       ? std::min(tracks.GetStartTime(), 0.0)
       : 0;
  
    window.Zoom( window.GetZoomOfToFit() );
    window.TP_ScrollWindow(start);
 }

References ViewInfo::Get(), TrackList::Get(), min(), and ProjectWindowBase::mProject.

Referenced by ZoomAfterImport().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Find() [1/2]

ProjectWindow * ProjectWindow::Find ( AudacityProject * pProject )

static

Definition at line 545 of file ProjectWindow.cpp.

 {
    return pProject
       ? GetAttachedWindows(*pProject).Find< ProjectWindow >(sProjectWindowKey)
       : nullptr;
 }

References ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Find(), GetAttachedWindows(), and anonymous_namespace{ProjectWindow.cpp}::sProjectWindowKey.

Referenced by Exporter::CheckMix(), ExportMP3::Export(), ExportMultipleDialog::ExportMultipleByLabel(), ExportMultipleDialog::ExportMultipleByTrack(), Find(), Exporter::GetFilename(), ScreenshotCommand::GetFrontWindow(), ProjectManager::OnStatusChange(), ProjectManager::SetStatusText(), and ScreenshotCommand::WindowFileName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Find() [2/2]

const ProjectWindow * ProjectWindow::Find ( const AudacityProject * pProject )

static

Definition at line 552 of file ProjectWindow.cpp.

 {
    return Find( const_cast< AudacityProject * >( pProject ) );
 }

References Find().

Here is the call graph for this function:

◆ FinishAutoScroll()

void ProjectWindow::FinishAutoScroll ( )

Definition at line 755 of file ProjectWindow.cpp.

 {
    // Set a flag so we don't have to generate two update events
    mAutoScrolling = true;
  
    // Call our Scroll method which updates our ViewInfo variables
    // to reflect the positions of the scrollbars
    DoScroll();
  
    mAutoScrolling = false;
 }

References DoScroll(), and mAutoScrolling.

Referenced by OnScrollLeft(), and OnScrollRight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FixScrollbars()

void ProjectWindow::FixScrollbars ( )

Definition at line 1009 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &tracks = TrackList::Get( project );
    auto &trackPanel = GetProjectPanel( project );
    auto &viewInfo = ViewInfo::Get( project );
  
    bool refresh = false;
    bool rescroll = false;
  
    int totalHeight = TrackView::GetTotalHeight( tracks ) + 32;
  
    auto panelWidth = viewInfo.GetTracksUsableWidth();
    auto panelHeight = viewInfo.GetHeight();
  
    // (From Debian...at least I think this is the change corresponding
    // to this comment)
    //
    // (2.) GTK critical warning "IA__gtk_range_set_range: assertion
    // 'min < max' failed" because of negative numbers as result of window
    // size checking. Added a sanity check that straightens up the numbers
    // in edge cases.
    if (panelWidth < 0) {
       panelWidth = 0;
    }
    if (panelHeight < 0) {
       panelHeight = 0;
    }
  
    auto LastTime = std::numeric_limits<double>::lowest();
    for (const Track *track : tracks) {
       // Iterate over pending changed tracks if present.
       track = track->SubstitutePendingChangedTrack().get();
       LastTime = std::max( LastTime, track->GetEndTime() );
    }
    LastTime =
       std::max(LastTime, viewInfo.selectedRegion.t1());
  
    const double screen =
       viewInfo.GetScreenEndTime() - viewInfo.h;
    const double halfScreen = screen / 2.0;
  
    // If we can scroll beyond zero,
    // Add 1/2 of a screen of blank space to the end
    // and another 1/2 screen before the beginning
    // so that any point within the union of the selection and the track duration
    // may be scrolled to the midline.
    // May add even more to the end, so that you can always scroll the starting time to zero.
    const double lowerBound = ScrollingLowerBoundTime();
    const double additional = MayScrollBeyondZero()
       ? -lowerBound + std::max(halfScreen, screen - LastTime)
       : screen / 4.0;
  
    viewInfo.total = LastTime + additional;
  
    // Don't remove time from total that's still on the screen
    viewInfo.total = std::max(viewInfo.total, viewInfo.h + screen);
  
    if (viewInfo.h < lowerBound) {
       viewInfo.h = lowerBound;
       rescroll = true;
    }
  
    viewInfo.sbarTotal = (wxInt64) (viewInfo.GetTotalWidth());
    viewInfo.sbarScreen = (wxInt64)(panelWidth);
    viewInfo.sbarH = (wxInt64) (viewInfo.GetBeforeScreenWidth());
  
    // PRL:  Can someone else find a more elegant solution to bug 812, than
    // introducing this boolean member variable?
    // Setting mVSbar earlier, int HandlXMLTag, didn't succeed in restoring
    // the vertical scrollbar to its saved position.  So defer that till now.
    // mbInitializingScrollbar should be true only at the start of the life
    // of an AudacityProject reopened from disk.
    if (!mbInitializingScrollbar) {
       viewInfo.vpos = mVsbar->GetThumbPosition() * viewInfo.scrollStep;
    }
    mbInitializingScrollbar = false;
  
    if (viewInfo.vpos >= totalHeight)
       viewInfo.vpos = totalHeight - 1;
    if (viewInfo.vpos < 0)
       viewInfo.vpos = 0;
  
    bool oldhstate;
    bool oldvstate;
    bool newhstate =
       (viewInfo.GetScreenEndTime() - viewInfo.h) < viewInfo.total;
    bool newvstate = panelHeight < totalHeight;
  
 #ifdef __WXGTK__
    oldhstate = mHsbar->IsShown();
    oldvstate = mVsbar->IsShown();
    mHsbar->Show(newhstate);
    mVsbar->Show(panelHeight < totalHeight);
 #else
    oldhstate = mHsbar->IsEnabled();
    oldvstate = mVsbar->IsEnabled();
    mHsbar->Enable(newhstate);
    mVsbar->Enable(panelHeight < totalHeight);
 #endif
  
    if (panelHeight >= totalHeight && viewInfo.vpos != 0) {
       viewInfo.vpos = 0;
  
       refresh = true;
       rescroll = false;
    }
    if (!newhstate && viewInfo.sbarH != 0) {
       viewInfo.sbarH = 0;
  
       refresh = true;
       rescroll = false;
    }
  
    // wxScrollbar only supports int values but we need a greater range, so
    // we scale the scrollbar coordinates on demand. We only do this if we
    // would exceed the int range, so we can always use the maximum resolution
    // available.
  
    // Don't use the full 2^31 max int range but a bit less, so rounding
    // errors in calculations do not overflow max int
    wxInt64 maxScrollbarRange = (wxInt64)(2147483647 * 0.999);
    if (viewInfo.sbarTotal > maxScrollbarRange)
       viewInfo.sbarScale = ((double)maxScrollbarRange) / viewInfo.sbarTotal;
    else
       viewInfo.sbarScale = 1.0; // use maximum resolution
  
    {
       int scaledSbarH = (int)(viewInfo.sbarH * viewInfo.sbarScale);
       int scaledSbarScreen = (int)(viewInfo.sbarScreen * viewInfo.sbarScale);
       int scaledSbarTotal = (int)(viewInfo.sbarTotal * viewInfo.sbarScale);
       const int offset =
          (int)(floor(0.5 + viewInfo.sbarScale * PixelWidthBeforeTime(0.0)));
  
       mHsbar->SetScrollbar(scaledSbarH + offset, scaledSbarScreen, scaledSbarTotal,
          scaledSbarScreen, TRUE);
    }
  
    // Vertical scrollbar
    mVsbar->SetScrollbar(viewInfo.vpos / viewInfo.scrollStep,
                         panelHeight / viewInfo.scrollStep,
                         totalHeight / viewInfo.scrollStep,
                         panelHeight / viewInfo.scrollStep, TRUE);
  
    if (refresh || (rescroll &&
        (viewInfo.GetScreenEndTime() - viewInfo.h) < viewInfo.total)) {
       trackPanel.Refresh(false);
    }
  
    MenuManager::Get( project ).UpdateMenus();
  
    if (oldhstate != newhstate || oldvstate != newvstate) {
       UpdateLayout();
    }
 }

References ViewInfo::Get(), MenuManager::Get(), TrackList::Get(), GetProjectPanel(), TrackView::GetTotalHeight(), MayScrollBeyondZero(), mbInitializingScrollbar, mHsbar, ProjectWindowBase::mProject, mVsbar, PixelWidthBeforeTime(), ScrollingLowerBoundTime(), UpdateLayout(), and MenuManager::UpdateMenus().

Referenced by HandleResize(), InitProjectWindow(), TP_RedrawScrollbars(), Zoom(), and ZoomBy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

ProjectWindow & ProjectWindow::Get ( AudacityProject & project )

static

Definition at line 535 of file ProjectWindow.cpp.

 {
    return GetAttachedWindows(project).Get< ProjectWindow >(sProjectWindowKey);
 }

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

Here is the call graph for this function:

◆ Get() [2/2]

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

static

Definition at line 540 of file ProjectWindow.cpp.

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

References Get().

Here is the call graph for this function:

◆ GetHorizontalScrollBar()

wxScrollBar& ProjectWindow::GetHorizontalScrollBar ( )

inline

Definition at line 110 of file ProjectWindow.h.

110 { return *mHsbar; }

Referenced by InitProjectWindow().

Here is the caller graph for this function:

◆ GetMainPage()

wxWindow* ProjectWindow::GetMainPage ( )

inline

Definition at line 54 of file ProjectWindow.h.

54 { return mMainPage; }

Referenced by InitProjectWindow().

Here is the caller graph for this function:

◆ GetMainPanel()

wxPanel* ProjectWindow::GetMainPanel ( )

inline

Definition at line 55 of file ProjectWindow.h.

55 { return mMainPanel; }

Referenced by InitProjectWindow().

Here is the caller graph for this function:

◆ GetNormalizedWindowState()

wxRect ProjectWindow::GetNormalizedWindowState ( ) const

inline

Definition at line 93 of file ProjectWindow.h.

93 { return mNormalizedWindowState; }

Referenced by ProjectManager::SaveWindowSize().

Here is the caller graph for this function:

◆ GetPlaybackScroller()

PlaybackScroller& ProjectWindow::GetPlaybackScroller ( )

inline

Definition at line 90 of file ProjectWindow.h.

90 { return *mPlaybackScroller; }

Referenced by PlayIndicatorOverlay::PlayIndicatorOverlay(), ControlToolBar::StartScrolling(), ControlToolBar::StartScrollingIfPreferred(), and ControlToolBar::StopScrolling().

Here is the caller graph for this function:

◆ GetTopPanel()

wxPanel* ProjectWindow::GetTopPanel ( )

inline

Definition at line 56 of file ProjectWindow.h.

56 { return mTopPanel; }

Referenced by InitProjectWindow(), InstallTopPanelHook::InstallTopPanelHook(), and anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame().

Here is the caller graph for this function:

◆ GetTPTracksUsableArea()

wxSize ProjectWindow::GetTPTracksUsableArea ( )

◆ GetVerticalScrollBar()

wxScrollBar& ProjectWindow::GetVerticalScrollBar ( )

inline

Definition at line 109 of file ProjectWindow.h.

109 { return *mVsbar; }

Referenced by InitProjectWindow().

Here is the caller graph for this function:

◆ GetZoomOfToFit()

double ProjectWindow::GetZoomOfToFit ( ) const

Definition at line 1823 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &tracks = TrackList::Get( project );
    auto &viewInfo = ViewInfo::Get( project );
  
    const double end = tracks.GetEndTime();
    const double start = viewInfo.bScrollBeyondZero
       ? std::min( tracks.GetStartTime(), 0.0)
       : 0;
    const double len = end - start;
  
    if (len <= 0.0)
       return viewInfo.GetZoom();
  
    auto w = viewInfo.GetTracksUsableWidth();
    w -= 10;
    return w/len;
 }

References ViewInfo::Get(), TrackList::Get(), min(), and ProjectWindowBase::mProject.

Here is the call graph for this function:

◆ HandleResize()

void ProjectWindow::HandleResize ( )

Definition at line 1206 of file ProjectWindow.cpp.

 {
    // Activate events can fire during window teardown, so just
    // ignore them.
    if (mIsDeleting) {
       return;
    }
  
    CallAfter( [this]{
  
    if (mIsDeleting)
       return;
  
    FixScrollbars();
    UpdateLayout();
  
    });
 }

References BasicUI::CallAfter(), FixScrollbars(), mIsDeleting, and UpdateLayout().

Referenced by OnSize(), OnToolBarUpdate(), OnUndoRedo(), OnUndoReset(), and TP_HandleResize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsActive()

bool ProjectWindow::IsActive ( )

override

Definition at line 1539 of file ProjectWindow.cpp.

 {
    return mActive;
 }

References mActive.

◆ IsBeingDeleted()

bool ProjectWindow::IsBeingDeleted ( ) const

inline

Definition at line 51 of file ProjectWindow.h.

51 { return mIsDeleting; }

Referenced by OnActivate().

Here is the caller graph for this function:

◆ IsIconized()

bool ProjectWindow::IsIconized ( ) const

override

Definition at line 1226 of file ProjectWindow.cpp.

 {
    return mIconized;
 }

References mIconized.

Referenced by GetNextWindowPlacement(), OnMove(), and OnSize().

Here is the caller graph for this function:

◆ MacShowUndockedToolbars()

void ProjectWindow::MacShowUndockedToolbars ( bool show )

Definition at line 1258 of file ProjectWindow.cpp.

 {
    (void)show;//compiler food
 #ifdef __WXMAC__
    // Save the focus so we can restore it to whatever had it before since
    // showing a previously hidden toolbar will cause the focus to be set to
    // its frame.  If this is not done it will appear that activation events
    // aren't being sent to the project window since they are actually being
    // delivered to the last tool frame shown.
    wxWindow *focused = FindFocus();
  
    // Find all the floating toolbars, and show or hide them
    const auto &children = GetChildren();
    for(const auto &child : children) {
       if (auto frame = dynamic_cast<ToolFrame*>(child)) {
          if (!show) {
             frame->Hide();
          }
          else if (frame->GetBar() &&
                   frame->GetBar()->IsVisible() ) {
             frame->Show();
          }
       }
    }
  
    // Restore the focus if needed
    if (focused) {
       focused->SetFocus();
    }
 #endif
 }

Referenced by OnIconize().

Here is the caller graph for this function:

◆ MayScrollBeyondZero()

bool ProjectWindow::MayScrollBeyondZero ( ) const

Definition at line 902 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &scrubber = Scrubber::Get( project );
    auto &viewInfo = ViewInfo::Get( project );
    if (viewInfo.bScrollBeyondZero)
       return true;
  
    if (scrubber.HasMark() ||
        ProjectAudioIO::Get( project ).IsAudioActive()) {
       if (mPlaybackScroller) {
          auto mode = mPlaybackScroller->GetMode();
          if (mode == PlaybackScroller::Mode::Pinned ||
              mode == PlaybackScroller::Mode::Right)
             return true;
       }
    }
  
    return false;
 }

References ViewInfo::Get(), ProjectAudioIO::Get(), Scrubber::Get(), ProjectAudioIO::IsAudioActive(), mPlaybackScroller, ProjectWindowBase::mProject, ProjectWindow::PlaybackScroller::Pinned, and ProjectWindow::PlaybackScroller::Right.

Referenced by DoScroll(), FixScrollbars(), ProjectWindow::PlaybackScroller::OnTimer(), and ScrollingLowerBoundTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NextWindowID()

int ProjectWindow::NextWindowID ( )

Definition at line 557 of file ProjectWindow.cpp.

 {
    return mNextWindowID++;
 }

References mNextWindowID.

◆ OnActivate()

void ProjectWindow::OnActivate ( wxActivateEvent & event )

Definition at line 1507 of file ProjectWindow.cpp.

 {
    // Activate events can fire during window teardown, so just
    // ignore them.
    if (IsBeingDeleted()) {
       return;
    }
  
    auto &project = mProject;
  
    mActive = event.GetActive();
  
    // Under Windows, focus can be "lost" when returning to
    // Audacity from a different application.
    //
    // This was observed by minimizing all windows using WINDOWS+M and
    // then ALT+TAB to return to Audacity.  Focus will be given to the
    // project window frame which is not at all useful.
    //
    // So, we use ToolManager's observation of focus changes in a wxEventFilter.
    // Then, when we receive the
    // activate event, we restore that focus to the child or the track
    // panel if no child had the focus (which probably should never happen).
    if (mActive) {
       auto &toolManager = ToolManager::Get( project );
       SetActiveProject( &project );
       if ( ! toolManager.RestoreFocus() )
          GetProjectPanel( project ).SetFocus();
    }
    event.Skip();
 }

References ToolManager::Get(), GetProjectPanel(), IsBeingDeleted(), mActive, ProjectWindowBase::mProject, and SetActiveProject().

Here is the call graph for this function:

◆ OnIconize()

void ProjectWindow::OnIconize ( wxIconizeEvent & event )

Definition at line 1290 of file ProjectWindow.cpp.

 {
    //JKC: On Iconizing we get called twice.  Don't know
    // why but it does no harm.
    // Should we be returning true/false rather than
    // void return?  I don't know.
    mIconized = event.IsIconized();
  
 #if defined(__WXMAC__)
    // Readdresses bug 1431 since a crash could occur when restoring iconized
    // floating toolbars due to recursion (bug 2411).
    MacShowUndockedToolbars(!mIconized);
    if( !mIconized )
    {
       Raise();
    }
 #endif
  
    // VisibileProjectCount seems to be just a counter for debugging.
    // It's not used outside this function.
    auto VisibleProjectCount = std::count_if(
       AllProjects{}.begin(), AllProjects{}.end(),
       []( const AllProjects::value_type &ptr ){
          return !GetProjectFrame( *ptr ).IsIconized();
       }
    );
    event.Skip();
  
    // This step is to fix part of Bug 2040, where the BackingPanel
    // size was not restored after we leave Iconized state.
  
    // Queue up a resize event using OnShow so that we 
    // refresh the track panel.  But skip this, if we're iconized.
    if( mIconized )
       return;
    wxShowEvent Evt;
    OnShow( Evt );
 }

References AllProjects::begin(), AllProjects::end(), GetProjectFrame(), MacShowUndockedToolbars(), mIconized, and OnShow().

Here is the call graph for this function:

◆ OnMenu()

void ProjectWindow::OnMenu ( wxCommandEvent & event )

Definition at line 1472 of file ProjectWindow.cpp.

 {
 #ifdef __WXMSW__
    // Bug 1642: We can arrive here with bogus menu IDs, which we
    // proceed to process.  So if bogus, don't.
    // The bogus menu IDs are probably generated by controls on the TrackPanel, 
    // such as the Project Rate.
    // 17000 is the magic number at which we start our menu.
    // This code would probably NOT be OK on Mac, since we assign
    // some specific ID numbers.
    if( event.GetId() < 17000){
       event.Skip();
       return;
    }
 #endif
    auto &project = mProject;
    auto &commandManager = CommandManager::Get( project );
    bool handled = commandManager.HandleMenuID( GetProject(),
       event.GetId(), MenuManager::Get( project ).GetUpdateFlags(),
       false);
  
    if (handled)
       event.Skip(false);
    else{
       event.ResumePropagation( 999 );
       event.Skip(true);
    }
 }

References CommandManager::Get(), MenuManager::Get(), ProjectWindowBase::GetProject(), MenuManager::GetUpdateFlags(), and ProjectWindowBase::mProject.

Here is the call graph for this function:

◆ OnMouseEvent()

void ProjectWindow::OnMouseEvent ( wxMouseEvent & event )

Definition at line 1544 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    if (event.ButtonDown())
       SetActiveProject( &project );
 }

References ProjectWindowBase::mProject, and SetActiveProject().

Here is the call graph for this function:

◆ OnMove()

void ProjectWindow::OnMove ( wxMoveEvent & event )

Definition at line 1329 of file ProjectWindow.cpp.

 {
    if (!this->IsMaximized() && !this->IsIconized())
       SetNormalizedWindowState(this->GetRect());
    event.Skip();
 }

References IsIconized(), and SetNormalizedWindowState().

Here is the call graph for this function:

◆ OnScroll()

void ProjectWindow::OnScroll ( wxScrollEvent & event )

Definition at line 1421 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    const wxInt64 offset = PixelWidthBeforeTime(0.0);
    viewInfo.sbarH =
       (wxInt64)(mHsbar->GetThumbPosition() / viewInfo.sbarScale) - offset;
    DoScroll();
  
 #ifndef __WXMAC__
    // Bug2179
    // This keeps the time ruler in sync with horizontal scrolling, without
    // making an undesirable compilation dependency of this source file on
    // the ruler
    wxTheApp->ProcessIdle();
 #endif
 }

References DoScroll(), ViewInfo::Get(), mHsbar, ProjectWindowBase::mProject, and PixelWidthBeforeTime().

Here is the call graph for this function:

◆ OnScrollLeft()

void ProjectWindow::OnScrollLeft ( )

This method handles general left-scrolling, either for drag-scrolling or when the scrollbar is clicked to the left of the thumb

Definition at line 811 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    wxInt64 pos = mHsbar->GetThumbPosition();
    // move at least one scroll increment
    pos -= wxMax((wxInt64)(sbarHjump * viewInfo.sbarScale), 1);
    pos = wxMax(pos, 0);
    viewInfo.sbarH -= sbarHjump;
    viewInfo.sbarH = std::max(viewInfo.sbarH,
       -(wxInt64) PixelWidthBeforeTime(0.0));
  
  
    if (pos != mHsbar->GetThumbPosition()) {
       mHsbar->SetThumbPosition((int)pos);
       FinishAutoScroll();
    }
 }

References FinishAutoScroll(), ViewInfo::Get(), mHsbar, ProjectWindowBase::mProject, PixelWidthBeforeTime(), and sbarHjump.

Referenced by TP_ScrollLeft().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnScrollLeftButton()

void ProjectWindow::OnScrollLeftButton ( wxScrollEvent & event )

This handles the event when the left direction button on the scrollbar is depressed

Definition at line 859 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    wxInt64 pos = mHsbar->GetThumbPosition();
    // move at least one scroll increment
    pos -= wxMax((wxInt64)(sbarHjump * viewInfo.sbarScale), 1);
    pos = wxMax(pos, 0);
    viewInfo.sbarH -= sbarHjump;
    viewInfo.sbarH = std::max(viewInfo.sbarH,
       - (wxInt64) PixelWidthBeforeTime(0.0));
  
    if (pos != mHsbar->GetThumbPosition()) {
       mHsbar->SetThumbPosition((int)pos);
       DoScroll();
    }
 }

References DoScroll(), ViewInfo::Get(), mHsbar, ProjectWindowBase::mProject, PixelWidthBeforeTime(), and sbarHjump.

Here is the call graph for this function:

◆ OnScrollRight()

void ProjectWindow::OnScrollRight ( )

This method handles general right-scrolling, either for drag-scrolling or when the scrollbar is clicked to the right of the thumb

Definition at line 834 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    wxInt64 pos = mHsbar->GetThumbPosition();
    // move at least one scroll increment
    // use wxInt64 for calculation to prevent temporary overflow
    pos += wxMax((wxInt64)(sbarHjump * viewInfo.sbarScale), 1);
    wxInt64 max = mHsbar->GetRange() - mHsbar->GetThumbSize();
    pos = wxMin(pos, max);
    viewInfo.sbarH += sbarHjump;
    viewInfo.sbarH = std::min(viewInfo.sbarH,
       viewInfo.sbarTotal
          - (wxInt64) PixelWidthBeforeTime(0.0) - viewInfo.sbarScreen);
  
    if (pos != mHsbar->GetThumbPosition()) {
       mHsbar->SetThumbPosition((int)pos);
       FinishAutoScroll();
    }
 }

References FinishAutoScroll(), ViewInfo::Get(), mHsbar, min(), ProjectWindowBase::mProject, PixelWidthBeforeTime(), and sbarHjump.

Referenced by TP_ScrollRight().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnScrollRightButton()

void ProjectWindow::OnScrollRightButton ( wxScrollEvent & event )

This handles the event when the right direction button on the scrollbar is depressed

Definition at line 880 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    wxInt64 pos = mHsbar->GetThumbPosition();
    // move at least one scroll increment
    // use wxInt64 for calculation to prevent temporary overflow
    pos += wxMax((wxInt64)(sbarHjump * viewInfo.sbarScale), 1);
    wxInt64 max = mHsbar->GetRange() - mHsbar->GetThumbSize();
    pos = wxMin(pos, max);
    viewInfo.sbarH += sbarHjump;
    viewInfo.sbarH = std::min(viewInfo.sbarH,
       viewInfo.sbarTotal
          - (wxInt64) PixelWidthBeforeTime(0.0) - viewInfo.sbarScreen);
  
    if (pos != mHsbar->GetThumbPosition()) {
       mHsbar->SetThumbPosition((int)pos);
       DoScroll();
    }
 }

References DoScroll(), ViewInfo::Get(), mHsbar, min(), ProjectWindowBase::mProject, PixelWidthBeforeTime(), and sbarHjump.

Here is the call graph for this function:

◆ OnShow()

void ProjectWindow::OnShow ( wxShowEvent & event )

Definition at line 1354 of file ProjectWindow.cpp.

 {
    // Remember that the window has been shown at least once
    mShownOnce = true;
  
    // (From Debian...see also TrackPanel::OnTimer and AudacityTimer::Notify)
    //
    // Description: Workaround for wxWidgets bug: Reentry in clipboard
    //  The wxWidgets bug http://trac.wxwidgets.org/ticket/16636 prevents
    //  us from doing clipboard operations in wxShowEvent and wxTimerEvent
    //  processing because those event could possibly be processed during
    //  the (not sufficiently protected) Yield() of a first clipboard
    //  operation, causing reentry. Audacity had a workaround in place
    //  for this problem (the class "CaptureEvents"), which however isn't
    //  applicable with wxWidgets 3.0 because it's based on changing the
    //  gdk event handler, a change that would be overridden by wxWidgets's
    //  own gdk event handler change.
    //  Instead, as a NEW workaround, specifically protect those processings
    //  of wxShowEvent and wxTimerEvent that try to do clipboard operations
    //  from being executed within Yield(). This is done by delaying their
    //  execution by posting pure wxWidgets events - which are never executed
    //  during Yield().
    // Author: Martin Stegh  fer <[email protected]>
    //  Bug-Debian: https://bugs.debian.org/765341
  
    // the actual creation/showing of the window).
    // Post the event instead of calling OnSize(..) directly. This ensures that
    // this is a pure wxWidgets event (no GDK event behind it) and that it
    // therefore isn't processed within the YieldFor(..) of the clipboard
    // operations (workaround for Debian bug #765341).
    // QueueEvent() will take ownership of the event
    GetEventHandler()->QueueEvent(safenew wxSizeEvent(GetSize()));
  
    // Further processing by default handlers
    event.Skip();
 }

References mShownOnce, and safenew.

Referenced by OnIconize().

Here is the caller graph for this function:

◆ OnSize()

void ProjectWindow::OnSize ( wxSizeEvent & event )

Definition at line 1336 of file ProjectWindow.cpp.

 {
    // (From Debian)
    //
    // (3.) GTK critical warning "IA__gdk_window_get_origin: assertion
    // 'GDK_IS_WINDOW (window)' failed": Received events of type wxSizeEvent
    // on the main project window cause calls to "ClientToScreen" - which is
    // not available until the window is first shown. So the class has to
    // keep track of wxShowEvent events and inhibit those actions until the
    // window is first shown.
    if (mShownOnce) {
       HandleResize();
       if (!this->IsMaximized() && !this->IsIconized())
          SetNormalizedWindowState(this->GetRect());
    }
    event.Skip();
 }

References HandleResize(), IsIconized(), mShownOnce, and SetNormalizedWindowState().

Here is the call graph for this function:

◆ OnThemeChange()

void ProjectWindow::OnThemeChange ( wxCommandEvent & evt )

private

Definition at line 735 of file ProjectWindow.cpp.

 {
    evt.Skip();
    auto &project = mProject;
    this->ApplyUpdatedTheme();
    auto &toolManager = ToolManager::Get( project );
    for( int ii = 0; ii < ToolBarCount; ++ii )
    {
       ToolBar *pToolBar = toolManager.GetToolBar(ii);
       if( pToolBar )
          pToolBar->ReCreateButtons();
    }
 }

References ApplyUpdatedTheme(), ToolManager::Get(), ProjectWindowBase::mProject, ToolBar::ReCreateButtons(), and ToolBarCount.

Here is the call graph for this function:

◆ OnToolBarUpdate()

void ProjectWindow::OnToolBarUpdate ( wxCommandEvent & event )

A toolbar has been updated, so handle it like a sizing event.

Definition at line 1394 of file ProjectWindow.cpp.

 {
    HandleResize();
  
    event.Skip(false);             /* No need to propagate any further */
 }

References HandleResize().

Here is the call graph for this function:

◆ OnUndoPushedModified()

void ProjectWindow::OnUndoPushedModified ( wxCommandEvent & evt )

Definition at line 1401 of file ProjectWindow.cpp.

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

References RedrawProject().

Here is the call graph for this function:

◆ OnUndoRedo()

void ProjectWindow::OnUndoRedo ( wxCommandEvent & evt )

Definition at line 1407 of file ProjectWindow.cpp.

 {
    evt.Skip();
    HandleResize();
    RedrawProject();
 }

References HandleResize(), and RedrawProject().

Here is the call graph for this function:

◆ OnUndoReset()

void ProjectWindow::OnUndoReset ( wxCommandEvent & evt )

Definition at line 1414 of file ProjectWindow.cpp.

 {
    evt.Skip();
    HandleResize();
    // RedrawProject();  // Should we do this here too?
 }

References HandleResize().

Here is the call graph for this function:

◆ OnUpdateUI()

void ProjectWindow::OnUpdateUI ( wxUpdateUIEvent & event )

Definition at line 1501 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    MenuManager::Get( project ).UpdateMenus();
 }

References MenuManager::Get(), ProjectWindowBase::mProject, and MenuManager::UpdateMenus().

Here is the call graph for this function:

◆ PixelWidthBeforeTime()

double ProjectWindow::PixelWidthBeforeTime ( double scrollto ) const

Definition at line 936 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    const double lowerBound = ScrollingLowerBoundTime();
    return
       // Ignoring fisheye is correct here
       viewInfo.TimeRangeToPixelWidth(scrollto - lowerBound);
 }

References ViewInfo::Get(), ProjectWindowBase::mProject, and ScrollingLowerBoundTime().

Referenced by FixScrollbars(), OnScroll(), OnScrollLeft(), OnScrollLeftButton(), OnScrollRight(), OnScrollRightButton(), and SetHorizontalThumb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RedrawProject()

void ProjectWindow::RedrawProject ( const bool bForceWaveTracks = false )

Definition at line 710 of file ProjectWindow.cpp.

 {
    auto pThis = wxWeakRef<ProjectWindow>(this);
    CallAfter( [pThis, bForceWaveTracks]{
  
    if (!pThis)
       return;
    if (pThis->IsBeingDeleted())
       return;
  
    auto &project = pThis->mProject ;
    auto &tracks = TrackList::Get( project );
    auto &trackPanel = GetProjectPanel( project );
    pThis->FixScrollbars();
    if (bForceWaveTracks)
    {
       for ( auto pWaveTrack : tracks.Any< WaveTrack >() )
          for (const auto &clip: pWaveTrack->GetClips())
             clip->MarkChanged();
    }
    trackPanel.Refresh(false);
  
    });
 }

References BasicUI::CallAfter(), for(), TrackList::Get(), and GetProjectPanel().

Referenced by MixerTrackCluster::OnButton_Mute(), MixerTrackCluster::OnButton_Solo(), AudacityApp::OnExceptionInMainLoop(), CommandHandler::OnReceiveCommand(), LabelDialog::OnSelectCell(), ScreenshotBigDialog::OnShortTracks(), ToolsToolBar::OnToolChanged(), OnUndoPushedModified(), OnUndoRedo(), and ScreenshotBigDialog::SizeTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RefreshTPTrack()

void ProjectWindow::RefreshTPTrack	(	Track *	pTrk,
		bool	refreshbacking = `true`
	)

◆ Rewind()

void ProjectWindow::Rewind ( bool shift )

Definition at line 1606 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    viewInfo.selectedRegion.setT0(0, false);
    if (!shift)
       viewInfo.selectedRegion.setT1(0);
  
    TP_ScrollWindow(0);
 }

References ViewInfo::Get(), ProjectWindowBase::mProject, and TP_ScrollWindow().

Referenced by ControlToolBar::OnRewind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollingLowerBoundTime()

double ProjectWindow::ScrollingLowerBoundTime ( ) const

Definition at line 923 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &tracks = TrackList::Get( project );
    auto &viewInfo = ViewInfo::Get( project );
    if (!MayScrollBeyondZero())
       return 0;
    const double screen = viewInfo.GetScreenEndTime() - viewInfo.h;
    return std::min(tracks.GetStartTime(), -screen);
 }

References ViewInfo::Get(), TrackList::Get(), MayScrollBeyondZero(), min(), and ProjectWindowBase::mProject.

Referenced by DoScroll(), FixScrollbars(), and PixelWidthBeforeTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollIntoView() [1/2]

void ProjectWindow::ScrollIntoView ( double pos )

Definition at line 786 of file ProjectWindow.cpp.

 {
    auto &trackPanel = GetProjectPanel( mProject );
    auto &viewInfo = ViewInfo::Get( mProject );
    auto w = viewInfo.GetTracksUsableWidth();
  
    int pixel = viewInfo.TimeToPosition(pos);
    if (pixel < 0 || pixel >= w)
    {
       TP_ScrollWindow
          (viewInfo.OffsetTimeByPixels(pos, -(w / 2)));
       trackPanel.Refresh(false);
    }
 }

References ViewInfo::Get(), GetProjectPanel(), ProjectWindowBase::mProject, and TP_ScrollWindow().

Referenced by LabelTrackView::KeyDown(), ScrollIntoView(), SkipEnd(), and ZoomInByFactor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollIntoView() [2/2]

void ProjectWindow::ScrollIntoView ( int x )

Definition at line 801 of file ProjectWindow.cpp.

 {
    auto &viewInfo = ViewInfo::Get( mProject );
    ScrollIntoView(viewInfo.PositionToTime(x, viewInfo.GetLeftOffset()));
 }

References ViewInfo::Get(), ProjectWindowBase::mProject, and ScrollIntoView().

Here is the call graph for this function:

◆ SetHorizontalThumb()

void ProjectWindow::SetHorizontalThumb ( double scrollto )

Definition at line 946 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    const auto unscaled = PixelWidthBeforeTime(scrollto);
    const int max = mHsbar->GetRange() - mHsbar->GetThumbSize();
    const int pos =
       std::min(max,
          std::max(0,
             (int)(floor(0.5 + unscaled * viewInfo.sbarScale))));
    mHsbar->SetThumbPosition(pos);
    viewInfo.sbarH = floor(0.5 + unscaled - PixelWidthBeforeTime(0.0));
    viewInfo.sbarH = std::max(viewInfo.sbarH,
       - (wxInt64) PixelWidthBeforeTime(0.0));
    viewInfo.sbarH = std::min(viewInfo.sbarH,
       viewInfo.sbarTotal
          - (wxInt64) PixelWidthBeforeTime(0.0) - viewInfo.sbarScreen);
 }

References ViewInfo::Get(), mHsbar, min(), ProjectWindowBase::mProject, and PixelWidthBeforeTime().

Referenced by DoScroll(), and TP_ScrollWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetIsBeingDeleted()

void ProjectWindow::SetIsBeingDeleted ( )

inline

Definition at line 52 of file ProjectWindow.h.

52 { mIsDeleting = true; }

◆ SetNormalizedWindowState()

void ProjectWindow::SetNormalizedWindowState ( wxRect pSizeAndLocation )

inline

Definition at line 92 of file ProjectWindow.h.

92 { mNormalizedWindowState = pSizeAndLocation; }

Referenced by OnMove(), and OnSize().

Here is the caller graph for this function:

◆ SkipEnd()

void ProjectWindow::SkipEnd ( bool shift )

Definition at line 1626 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &tracks = TrackList::Get( project );
    auto &viewInfo = ViewInfo::Get( project );
    double len = tracks.GetEndTime();
  
    viewInfo.selectedRegion.setT1(len, false);
    if (!shift)
       viewInfo.selectedRegion.setT0(len);
  
    // Make sure the end of the track is visible
    ScrollIntoView(len);
 }

References ViewInfo::Get(), TrackList::Get(), ProjectWindowBase::mProject, and ScrollIntoView().

Referenced by ControlToolBar::OnFF().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TP_HandleResize()

void ProjectWindow::TP_HandleResize ( )

overridevirtual

Implements TrackPanelListener.

Definition at line 1659 of file ProjectWindow.cpp.

 {
    HandleResize();
 }

References HandleResize().

Here is the call graph for this function:

◆ TP_RedrawScrollbars()

void ProjectWindow::TP_RedrawScrollbars ( )

overridevirtual

Implements TrackPanelListener.

Definition at line 1654 of file ProjectWindow.cpp.

 {
    FixScrollbars();
 }

References FixScrollbars().

Here is the call graph for this function:

◆ TP_ScrollLeft()

void ProjectWindow::TP_ScrollLeft ( )

overridevirtual

Implements TrackPanelListener.

Definition at line 1642 of file ProjectWindow.cpp.

 {
    OnScrollLeft();
 }

References OnScrollLeft().

Here is the call graph for this function:

◆ TP_ScrollRight()

void ProjectWindow::TP_ScrollRight ( )

overridevirtual

Implements TrackPanelListener.

Definition at line 1648 of file ProjectWindow.cpp.

 {
    OnScrollRight();
 }

References OnScrollRight().

Here is the call graph for this function:

◆ TP_ScrollUpDown()

bool ProjectWindow::TP_ScrollUpDown ( int delta )

overridevirtual

Implements TrackPanelListener.

Definition at line 983 of file ProjectWindow.cpp.

 {
    int oldPos = mVsbar->GetThumbPosition();
    int pos = oldPos + delta;
    int max = mVsbar->GetRange() - mVsbar->GetThumbSize();
  
    // Can be negative in case of only one track
    if (max < 0)
       max = 0;
  
    if (pos > max)
       pos = max;
    else if (pos < 0)
       pos = 0;
  
    if (pos != oldPos)
    {
       mVsbar->SetThumbPosition(pos);
  
       DoScroll();
       return true;
    }
    else
       return false;
 }

References DoScroll(), and mVsbar.

Here is the call graph for this function:

◆ TP_ScrollWindow()

void ProjectWindow::TP_ScrollWindow ( double scrollto )

overridevirtual

Implements TrackPanelListener.

Definition at line 969 of file ProjectWindow.cpp.

 {
    SetHorizontalThumb(scrollto);
  
    // Call our Scroll method which updates our ViewInfo variables
    // to reflect the positions of the scrollbars
    DoScroll();
 }

References DoScroll(), and SetHorizontalThumb().

Referenced by LOFImportFileHandle::doDurationAndScrollOffset(), Rewind(), ScrollIntoView(), Zoom(), ZoomInByFactor(), and ZoomOutByFactor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateLayout()

void ProjectWindow::UpdateLayout ( )

Definition at line 1165 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &trackPanel = GetProjectPanel( project );
    auto &toolManager = ToolManager::Get( project );
  
    // 1. Layout panel, to get widths of the docks.
    Layout();
    // 2. Layout toolbars to pack the toolbars correctly in docks which 
    // are now the correct width.
    toolManager.LayoutToolBars();
    // 3. Layout panel, to resize docks, in particular reducing the height 
    // of any empty docks, or increasing the height of docks that need it.
    Layout();
  
    // Bug 2455
    // The commented out code below is to calculate a nice minimum size for 
    // the window.  However on Ubuntu when the window is minimised it leads to 
    // an insanely tall window.
    // Using a fixed min size fixes that.
    // However there is still something strange when minimised, as once 
    // UpdateLayout is called once, when minimised, it gets called repeatedly.
 #if 0
    // Retrieve size of this projects window
    wxSize mainsz = GetSize();
  
    // Retrieve position of the track panel to use as the size of the top
    // third of the window
    wxPoint tppos = ClientToScreen(trackPanel.GetParent()->GetPosition());
  
    // Retrieve position of bottom dock to use as the size of the bottom
    // third of the window
    wxPoint sbpos = ClientToScreen(toolManager.GetBotDock()->GetPosition());
  
    // The "+ 50" is the minimum height of the TrackPanel
    SetMinSize( wxSize(250, (mainsz.y - sbpos.y) + tppos.y + 50));
 #endif
    SetMinSize( wxSize(250, 250));
    SetMaxSize( wxSize(20000, 20000));
 }

References ToolManager::Get(), GetProjectPanel(), and ProjectWindowBase::mProject.

Referenced by FixScrollbars(), and HandleResize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePrefs()

void ProjectWindow::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 749 of file ProjectWindow.cpp.

 {
    // Update status bar widths in case of language change
    UpdateStatusWidths();
 }

References UpdateStatusWidths().

Here is the call graph for this function:

◆ UpdateStatusWidths()

void ProjectWindow::UpdateStatusWidths ( )

Definition at line 1231 of file ProjectWindow.cpp.

 {
    enum { nWidths = nStatusBarFields + 1 };
    int widths[ nWidths ]{ 0 };
    widths[ rateStatusBarField ] = 150;
    const auto statusBar = GetStatusBar();
    const auto &functions = ProjectStatus::GetStatusWidthFunctions();
    // Start from 1 not 0
    // Specifying a first column always of width 0 was needed for reasons
    // I forget now
    for ( int ii = 1; ii <= nStatusBarFields; ++ii ) {
       int &width = widths[ ii ];
       for ( const auto &function : functions ) {
          auto results =
             function( mProject, static_cast< StatusBarField >( ii ) );
          for ( const auto &string : results.first ) {
             int w;
             statusBar->GetTextExtent(string.Translation(), &w, nullptr);
             width = std::max<int>( width, w + results.second );
          }
       }
    }
    // The main status field is not fixed width
    widths[ mainStatusBarField ] = -1;
    statusBar->SetStatusWidths( nWidths, widths );
 }

References ProjectStatus::GetStatusWidthFunctions(), mainStatusBarField, ProjectWindowBase::mProject, nStatusBarFields, and rateStatusBarField.

Referenced by InitProjectWindow(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Zoom()

void ProjectWindow::Zoom ( double level )

Definition at line 1571 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    viewInfo.SetZoom(level);
    FixScrollbars();
    // See if we can center the selection on screen, and have it actually fit.
    // tOnLeft is the amount of time we would need before the selection left edge to center it.
    float t0 = viewInfo.selectedRegion.t0();
    float t1 = viewInfo.selectedRegion.t1();
    float tAvailable = viewInfo.GetScreenEndTime() - viewInfo.h;
    float tOnLeft = (tAvailable - t0 + t1)/2.0;
    // Bug 1292 (Enh) is effectively a request to do this scrolling of  the selection into view.
    // If tOnLeft is positive, then we have room for the selection, so scroll to it.
    if( tOnLeft >=0 )
       TP_ScrollWindow( t0-tOnLeft);
 }

References FixScrollbars(), ViewInfo::Get(), ProjectWindowBase::mProject, and TP_ScrollWindow().

Here is the call graph for this function:

◆ ZoomAfterImport()

void ProjectWindow::ZoomAfterImport ( Track * pTrack )

Definition at line 1551 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &tracks = TrackList::Get( project );
    auto &trackPanel = GetProjectPanel( project );
  
    DoZoomFit();
  
    trackPanel.SetFocus();
    if (!pTrack)
       pTrack = *tracks.Selected().begin();
    if (!pTrack)
       pTrack = *tracks.Any().begin();
    if (pTrack) {
       TrackFocus::Get(project).Set(pTrack);
       pTrack->EnsureVisible();
    }
 }

References Track::Any(), DoZoomFit(), Track::EnsureVisible(), TrackFocus::Get(), TrackList::Get(), GetProjectPanel(), and ProjectWindowBase::mProject.

Referenced by DoImportMIDI(), ApplyMacroDialog::OnApplyToFiles(), and ProjectFileManager::OpenFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomBy()

void ProjectWindow::ZoomBy ( double multiplier )

Definition at line 1590 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
    viewInfo.ZoomBy(multiplier);
    FixScrollbars();
 }

References FixScrollbars(), ViewInfo::Get(), and ProjectWindowBase::mProject.

Referenced by LOFImportFileHandle::doDurationAndScrollOffset(), ZoomInByFactor(), and ZoomOutByFactor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomInByFactor()

void ProjectWindow::ZoomInByFactor ( double ZoomFactor )

Definition at line 1726 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
  
    auto gAudioIO = AudioIO::Get();
    // LLL: Handling positioning differently when audio is
    // actively playing.  Don't do this if paused.
    if (gAudioIO->IsStreamActive(
          ProjectAudioIO::Get( project ).GetAudioIOToken()) &&
        !gAudioIO->IsPaused()){
       ZoomBy(ZoomFactor);
       ScrollIntoView(gAudioIO->GetStreamTime());
       return;
    }
  
    // DMM: Here's my attempt to get logical zooming behavior
    // when there's a selection that's currently at least
    // partially on-screen
  
    const double endTime = viewInfo.GetScreenEndTime();
    const double duration = endTime - viewInfo.h;
  
    bool selectionIsOnscreen =
       (viewInfo.selectedRegion.t0() < endTime) &&
       (viewInfo.selectedRegion.t1() >= viewInfo.h);
  
    bool selectionFillsScreen =
       (viewInfo.selectedRegion.t0() < viewInfo.h) &&
       (viewInfo.selectedRegion.t1() > endTime);
  
    if (selectionIsOnscreen && !selectionFillsScreen) {
       // Start with the center of the selection
       double selCenter = (viewInfo.selectedRegion.t0() +
                           viewInfo.selectedRegion.t1()) / 2;
  
       // If the selection center is off-screen, pick the
       // center of the part that is on-screen.
       if (selCenter < viewInfo.h)
          selCenter = viewInfo.h +
                      (viewInfo.selectedRegion.t1() - viewInfo.h) / 2;
       if (selCenter > endTime)
          selCenter = endTime -
             (endTime - viewInfo.selectedRegion.t0()) / 2;
  
       // Zoom in
       ZoomBy(ZoomFactor);
       const double newDuration =
          viewInfo.GetScreenEndTime() - viewInfo.h;
  
       // Recenter on selCenter
       TP_ScrollWindow(selCenter - newDuration / 2);
       return;
    }
  
  
    double origLeft = viewInfo.h;
    double origWidth = duration;
    ZoomBy(ZoomFactor);
  
    const double newDuration =
       viewInfo.GetScreenEndTime() - viewInfo.h;
    double newh = origLeft + (origWidth - newDuration) / 2;
  
    // MM: Commented this out because it was confusing users
    /*
    // make sure that the *right-hand* end of the selection is
    // no further *left* than 1/3 of the way across the screen
    if (viewInfo.selectedRegion.t1() < newh + viewInfo.screen / 3)
       newh = viewInfo.selectedRegion.t1() - viewInfo.screen / 3;
  
    // make sure that the *left-hand* end of the selection is
    // no further *right* than 2/3 of the way across the screen
    if (viewInfo.selectedRegion.t0() > newh + viewInfo.screen * 2 / 3)
       newh = viewInfo.selectedRegion.t0() - viewInfo.screen * 2 / 3;
    */
  
    TP_ScrollWindow(newh);
 }

References AudioIO::Get(), ViewInfo::Get(), ProjectAudioIO::Get(), ProjectAudioIO::GetAudioIOToken(), ProjectWindowBase::mProject, ScrollIntoView(), TP_ScrollWindow(), and ZoomBy().

Here is the call graph for this function:

◆ ZoomOutByFactor()

void ProjectWindow::ZoomOutByFactor ( double ZoomFactor )

Definition at line 1806 of file ProjectWindow.cpp.

 {
    auto &project = mProject;
    auto &viewInfo = ViewInfo::Get( project );
  
    //Zoom() may change these, so record original values:
    const double origLeft = viewInfo.h;
    const double origWidth = viewInfo.GetScreenEndTime() - origLeft;
  
    ZoomBy(ZoomFactor);
    const double newWidth = viewInfo.GetScreenEndTime() - viewInfo.h;
  
    const double newh = origLeft + (origWidth - newWidth) / 2;
    // newh = (newh > 0) ? newh : 0;
    TP_ScrollWindow(newh);
 }

References ViewInfo::Get(), ProjectWindowBase::mProject, TP_ScrollWindow(), and ZoomBy().

Here is the call graph for this function:

Member Data Documentation

◆ mActive

bool ProjectWindow::mActive { true }

private

Definition at line 190 of file ProjectWindow.h.

Referenced by IsActive(), and OnActivate().

◆ mAutoScrolling

bool ProjectWindow::mAutoScrolling { false }

private

Definition at line 189 of file ProjectWindow.h.

Referenced by DoScroll(), and FinishAutoScroll().

◆ mbInitializingScrollbar

bool ProjectWindow::mbInitializingScrollbar { false }

Definition at line 176 of file ProjectWindow.h.

Referenced by FixScrollbars().

◆ mHsbar

wxScrollBar* ProjectWindow::mHsbar {}

private

Definition at line 184 of file ProjectWindow.h.

Referenced by FixScrollbars(), OnScroll(), OnScrollLeft(), OnScrollLeftButton(), OnScrollRight(), OnScrollRightButton(), and SetHorizontalThumb().

◆ mIconized

bool ProjectWindow::mIconized { false }

private

Definition at line 191 of file ProjectWindow.h.

Referenced by IsIconized(), and OnIconize().

◆ mIsDeleting

bool ProjectWindow::mIsDeleting { false }

private

Definition at line 196 of file ProjectWindow.h.

Referenced by HandleResize().

◆ mMainPage

wxWindow* ProjectWindow::mMainPage {}

private

Definition at line 182 of file ProjectWindow.h.

◆ mMainPanel

wxPanel* ProjectWindow::mMainPanel {}

private

Definition at line 183 of file ProjectWindow.h.

◆ mNextWindowID

int ProjectWindow::mNextWindowID {}

private

Definition at line 187 of file ProjectWindow.h.

Referenced by NextWindowID().

◆ mNormalizedWindowState

wxRect ProjectWindow::mNormalizedWindowState

private

Definition at line 179 of file ProjectWindow.h.

◆ mPlaybackScroller

std::unique_ptr<PlaybackScroller> ProjectWindow::mPlaybackScroller

private

Definition at line 200 of file ProjectWindow.h.

Referenced by MayScrollBeyondZero().

◆ mShownOnce

bool ProjectWindow::mShownOnce { false }

private

Definition at line 192 of file ProjectWindow.h.

Referenced by OnShow(), and OnSize().

◆ mTopPanel

wxPanel* ProjectWindow::mTopPanel {}

private

Definition at line 181 of file ProjectWindow.h.

◆ mVsbar

wxScrollBar* ProjectWindow::mVsbar {}

private

Definition at line 185 of file ProjectWindow.h.

Referenced by DoScroll(), FixScrollbars(), and TP_ScrollUpDown().

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

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProjectWindow()

◆ ~ProjectWindow()

Member Function Documentation

◆ ApplyUpdatedTheme()

◆ DoScroll()

◆ DoZoomFit()

◆ Find() [1/2]

◆ Find() [2/2]

◆ FinishAutoScroll()

◆ FixScrollbars()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetHorizontalScrollBar()

◆ GetMainPage()

◆ GetMainPanel()

◆ GetNormalizedWindowState()

◆ GetPlaybackScroller()

◆ GetTopPanel()

◆ GetTPTracksUsableArea()

◆ GetVerticalScrollBar()

◆ GetZoomOfToFit()

◆ HandleResize()

◆ IsActive()

◆ IsBeingDeleted()

◆ IsIconized()

◆ MacShowUndockedToolbars()

◆ MayScrollBeyondZero()

◆ NextWindowID()

◆ OnActivate()

◆ OnIconize()

◆ OnMenu()

◆ OnMouseEvent()

◆ OnMove()

◆ OnScroll()

◆ OnScrollLeft()

◆ OnScrollLeftButton()

◆ OnScrollRight()

◆ OnScrollRightButton()

◆ OnShow()

◆ OnSize()

◆ OnThemeChange()

◆ OnToolBarUpdate()

◆ OnUndoPushedModified()

◆ OnUndoRedo()

◆ OnUndoReset()

◆ OnUpdateUI()

◆ PixelWidthBeforeTime()

◆ RedrawProject()

◆ RefreshTPTrack()

◆ Rewind()

◆ ScrollingLowerBoundTime()

◆ ScrollIntoView() [1/2]

◆ ScrollIntoView() [2/2]

◆ SetHorizontalThumb()

◆ SetIsBeingDeleted()

◆ SetNormalizedWindowState()

◆ SkipEnd()

◆ TP_HandleResize()

◆ TP_RedrawScrollbars()

◆ TP_ScrollLeft()

◆ TP_ScrollRight()

◆ TP_ScrollUpDown()

◆ TP_ScrollWindow()

◆ UpdateLayout()

◆ UpdatePrefs()

◆ UpdateStatusWidths()

◆ Zoom()

◆ ZoomAfterImport()

◆ ZoomBy()

◆ ZoomInByFactor()

◆ ZoomOutByFactor()