ProjectWindow Class Reference

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
struct	PlaybackScrollerMessage

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 *	GetTrackListWindow () noexcept
	Track list window is the parent container for TrackPanel. More...
wxSplitterWindow *	GetContainerWindow () noexcept
	Container is a parent window for both effects panel and track list windows. More...
wxPanel *	GetTopPanel () noexcept
	Top panel contains project-related controls and tools. More...
void	UpdateStatusWidths ()
PlaybackScroller &	GetPlaybackScroller ()
void	SetNormalizedWindowState (wxRect pSizeAndLocation)
wxRect	GetNormalizedWindowState () const
void	ApplyUpdatedTheme ()
wxScrollBar &	GetVerticalScrollBar ()
wxScrollBar &	GetHorizontalScrollBar ()
void	OnScrollLeftButton (wxScrollEvent &event)
void	OnScrollRightButton (wxScrollEvent &event)
std::pair< int, int >	ViewportSize () const
bool	MayScrollBeyondZero () const
unsigned	MinimumTrackHeight ()
bool	IsTrackMinimized (const Track &track)
void	SetMinimized (Track &track, bool minimized)
int	GetTrackHeight (const Track &track)
void	SetChannelHeights (Track &track, unsigned height)
int	GetTotalHeight (const TrackList &trackList)
int	GetHorizontalThumbPosition () const
int	GetHorizontalThumbSize () const
int	GetHorizontalRange () const
void	SetHorizontalThumbPosition (int viewStart)
void	SetHorizontalScrollbar (int position, int thumbSize, int range, int pageSize, bool refresh)
void	ShowHorizontalScrollbar (bool shown)
int	GetVerticalThumbPosition () const
int	GetVerticalThumbSize () const
int	GetVerticalRange () const
void	SetVerticalThumbPosition (int viewStart)
void	SetVerticalScrollbar (int position, int thumbSize, int range, int pageSize, bool refresh)
void	ShowVerticalScrollbar (bool shown)
void	SetToDefaultSize ()
wxSize	GetTPTracksUsableArea ()
void	RefreshTPTrack (Track *pTrk, bool refreshbacking=true)
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	UpdateLayout ()
void	OnShow (wxShowEvent &event)
void	OnMove (wxMoveEvent &event)
void	OnScroll (wxScrollEvent &event)
void	OnToolBarUpdate (wxCommandEvent &event)
void	OnProjectTitleChange (ProjectFileIOMessage)
Public Member Functions inherited from ProjectWindowBase
	ProjectWindowBase (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, AudacityProject &project)
	~ProjectWindowBase () override
std::shared_ptr< AudacityProject >	FindProject ()
std::shared_ptr< const AudacityProject >	FindProject () const
Public Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0
Public Member Functions inherited from Observer::Publisher< ProjectWindowDestroyedMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

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...

Private Member Functions
void	OnThemeChange (struct ThemeChangeMessage)
void	UpdatePrefs () override
void	OnViewportMessage (const ViewportMessage &message)

Private Attributes
wxRect	mNormalizedWindowState
wxPanel *	mTopPanel {}
wxSplitterWindow *	mContainerWindow
wxWindow *	mTrackListWindow {}
wxScrollBar *	mHsbar {}
wxScrollBar *	mVsbar {}
int	mNextWindowID {}
bool	mActive { true }
bool	mIconized { false }
bool	mShownOnce { false }
bool	mIsDeleting { false }
Observer::Subscription	mThemeChangeSubscription
Observer::Subscription	mTitleChangeSubscription
Observer::Subscription	mSnappingChangedSubscription
std::unique_ptr< PlaybackScroller >	mPlaybackScroller
const Observer::Subscription	mViewportSubscription

Additional Inherited Members
Public Types inherited from Observer::Publisher< ProjectWindowDestroyedMessage >
using	message_type = ProjectWindowDestroyedMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const ProjectWindowDestroyedMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< ProjectWindowDestroyedMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)
Protected Member Functions inherited from Observer::Publisher< ProjectWindowDestroyedMessage >
CallbackReturn	Publish (const ProjectWindowDestroyedMessage &message)
	Send a message to connected callbacks. More...
Protected Attributes inherited from ProjectWindowBase
std::weak_ptr< AudacityProject >	mwProject

Detailed Description

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

Definition at line 33 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 527 of file ProjectWindow.cpp.

   : ProjectWindowBase{ parent, id, pos, size, project }
   , mViewportSubscription{
      Viewport::Get(project)
         .Subscribe(*this, &ProjectWindow::OnViewportMessage) }
{
   Viewport::Get(project).SetCallbacks(std::make_unique<Adapter>(*this));
 
   mNextWindowID = NextID;
   
   constexpr auto EffectsPanelMaxWidth { 500 };
   constexpr auto TrackPanelMinWidth { 250 };
 
   // 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
 
   auto container = safenew wxSplitterWindow(this, wxID_ANY,
      wxDefaultPosition,
      wxDefaultSize,
      wxNO_BORDER | wxSP_LIVE_UPDATE | wxSP_THIN_SASH);
   container->Bind(wxEVT_SPLITTER_DOUBLECLICKED, [](wxSplitterEvent& event){
      //"The default behaviour is to unsplit the window"
      event.Veto();//do noting instead
   });
   container->Bind(wxEVT_SPLITTER_SASH_POS_CHANGING, [=](wxSplitterEvent& event){
      if(event.GetSashPosition() > EffectsPanelMaxWidth)
         //Prevents left panel from expanding further
         event.SetSashPosition(-1);
   });
   mContainerWindow = container;
 
   mTrackListWindow = safenew wxPanelWrapper(mContainerWindow, wxID_ANY,
      wxDefaultPosition,
      wxDefaultSize,
      wxNO_BORDER);
   mTrackListWindow->SetMinSize({TrackPanelMinWidth, -1});
   mTrackListWindow->SetSizer( safenew wxBoxSizer(wxVERTICAL) );
   mTrackListWindow->SetLabel("Main Panel");// Not localized.
   mTrackListWindow->SetLayoutDirection(wxLayout_LeftToRight);
 
   mContainerWindow->Initialize(mTrackListWindow);
 
#ifdef EXPERIMENTAL_DA2
   mTrackListWindow->SetBackgroundColour(theTheme.Colour( clrMedium ));
#endif
 
   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(mTrackListWindow, HSBarID, wxSB_HORIZONTAL);
   mVsbar = safenew ScrollBar(mTrackListWindow, 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"));
 
   mThemeChangeSubscription =
      theTheme.Subscribe(*this, &ProjectWindow::OnThemeChange);
 
   // Subscribe to title changes published by ProjectFileIO
   mTitleChangeSubscription = ProjectFileIO::Get(project)
      .Subscribe(*this, &ProjectWindow::OnProjectTitleChange);
 
   // And also establish my initial consistency with it
   this->OnProjectTitleChange(ProjectFileIOMessage::ProjectTitleChange);
}

References _, ThemeBase::Colour(), ProjectFileIO::Get(), Viewport::Get(), HSBarID, mContainerWindow, mHsbar, mNextWindowID, mPlaybackScroller, mThemeChangeSubscription, mTitleChangeSubscription, mTopPanel, mTrackListWindow, mVsbar, NextID, OnProjectTitleChange(), OnThemeChange(), project, ProjectTitleChange, safenew, Viewport::SetCallbacks(), Observer::Publisher< Message, NotifyAll >::Subscribe(), theTheme, and VSBarID.

Here is the call graph for this function:

~ProjectWindow()

ProjectWindow::~ProjectWindow ( )

override

Definition at line 626 of file ProjectWindow.cpp.

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

Member Function Documentation

ApplyUpdatedTheme()

void ProjectWindow::ApplyUpdatedTheme

(

)

Definition at line 652 of file ProjectWindow.cpp.

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

Find() [1/2]

ProjectWindow * ProjectWindow::Find ( AudacityProject *  pProject )

static

Definition at line 419 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 Find(), ProjectManager::OnStatusChange(), and ProjectManager::SetStatusText().

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 426 of file ProjectWindow.cpp.

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

References Find().

Here is the call graph for this function:

Get() [1/2]

ProjectWindow & ProjectWindow::Get ( AudacityProject &  project )

static

Definition at line 409 of file ProjectWindow.cpp.

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

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

Referenced by Get(), GetNextWindowPlacement(), RealtimeEffectPanel::HidePanel(), cloud::ShareAudioToolbar::MakeShareAudioButton(), MixerBoard::MixerBoard(), ProjectManager::New(), anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame(), ProjectManager::OnCloseWindow(), ProjectManager::OnReconnectionFailure(), ProjectWindow::PlaybackScroller::OnTimer(), PlayIndicatorOverlay::OnTimer(), TrackPanel::OnTimer(), PlayIndicatorOverlay::PlayIndicatorOverlay(), ProjectManager::ProjectManager(), ProjectManager::SaveWindowSize(), ScrubbingOverlay::ScrubbingOverlay(), ScrubForwarder::ScrubForwarder(), RealtimeEffectStateUI::Show(), RealtimeEffectPanel::ShowPanel(), ControlToolBar::StartScrolling(), ControlToolBar::StartScrollingIfPreferred(), ControlToolBar::StopScrolling(), SelectHandle::TimerHandler::TimerHandler(), and TrackPanel::TrackPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [2/2]

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

static

Definition at line 414 of file ProjectWindow.cpp.

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

References Get(), and project.

Here is the call graph for this function:

GetContainerWindow()

wxSplitterWindow * ProjectWindow::GetContainerWindow ( )

noexcept

Container is a parent window for both effects panel and track list windows.

Returns

Pointer to a container window (not null)

Definition at line 891 of file ProjectWindow.cpp.

{
   return mContainerWindow;
}

References mContainerWindow.

Referenced by InitProjectWindow().

Here is the caller graph for this function:

GetHorizontalRange()

int ProjectWindow::GetHorizontalRange

(

)

const

Definition at line 777 of file ProjectWindow.cpp.

{
   return mHsbar->GetRange();
}

References mHsbar.

GetHorizontalScrollBar()

wxScrollBar & ProjectWindow::GetHorizontalScrollBar ( )

inline

Definition at line 122 of file ProjectWindow.h.

{ return *mHsbar; }

Referenced by InitProjectWindow().

Here is the caller graph for this function:

GetHorizontalThumbPosition()

int ProjectWindow::GetHorizontalThumbPosition

(

)

const

Definition at line 767 of file ProjectWindow.cpp.

{
   return mHsbar->GetThumbPosition();
}

References mHsbar.

GetHorizontalThumbSize()

int ProjectWindow::GetHorizontalThumbSize

(

)

const

Definition at line 772 of file ProjectWindow.cpp.

{
   return mHsbar->GetThumbSize();
}

References mHsbar.

GetNormalizedWindowState()

wxRect ProjectWindow::GetNormalizedWindowState ( ) const

inline

Definition at line 114 of file ProjectWindow.h.

{ return mNormalizedWindowState;   }

Referenced by ProjectManager::SaveWindowSize().

Here is the caller graph for this function:

GetPlaybackScroller()

PlaybackScroller & ProjectWindow::GetPlaybackScroller ( )

inline

Definition at line 111 of file ProjectWindow.h.

{ return *mPlaybackScroller; }

Referenced by MixerBoard::MixerBoard(), PlayIndicatorOverlay::PlayIndicatorOverlay(), ScrubbingOverlay::ScrubbingOverlay(), ControlToolBar::StartScrolling(), ControlToolBar::StartScrollingIfPreferred(), ControlToolBar::StopScrolling(), and SelectHandle::TimerHandler::TimerHandler().

Here is the caller graph for this function:

GetTopPanel()

wxPanel * ProjectWindow::GetTopPanel ( )

noexcept

Top panel contains project-related controls and tools.

Returns

Pointer to a top panel window (not null)

Definition at line 896 of file ProjectWindow.cpp.

{
   return mTopPanel;
}

References mTopPanel.

Referenced by InitProjectWindow().

Here is the caller graph for this function:

GetTotalHeight()

int ProjectWindow::GetTotalHeight

(

const TrackList &

trackList

)

Definition at line 756 of file ProjectWindow.cpp.

{
   return ChannelView::GetTotalHeight(trackList);
}

References ChannelView::GetTotalHeight().

Here is the call graph for this function:

GetTPTracksUsableArea()

wxSize ProjectWindow::GetTPTracksUsableArea

(

)

GetTrackHeight()

int ProjectWindow::GetTrackHeight

(

const Track &

track

)

Definition at line 751 of file ProjectWindow.cpp.

{
   return ChannelView::GetChannelGroupHeight(&track);
}

References ChannelView::GetChannelGroupHeight().

Here is the call graph for this function:

GetTrackListWindow()

wxWindow * ProjectWindow::GetTrackListWindow ( )

noexcept

Track list window is the parent container for TrackPanel.

Returns

Pointer to a track list window (not null)

Definition at line 886 of file ProjectWindow.cpp.

{
   return mTrackListWindow;
}

References mTrackListWindow.

Referenced by InitProjectWindow().

Here is the caller graph for this function:

GetVerticalRange()

int ProjectWindow::GetVerticalRange

(

)

const

Definition at line 812 of file ProjectWindow.cpp.

{
   return mVsbar->GetRange();
}

References mVsbar.

GetVerticalScrollBar()

wxScrollBar & ProjectWindow::GetVerticalScrollBar ( )

inline

Definition at line 121 of file ProjectWindow.h.

{ return *mVsbar; }

Referenced by InitProjectWindow().

Here is the caller graph for this function:

GetVerticalThumbPosition()

int ProjectWindow::GetVerticalThumbPosition

(

)

const

Definition at line 802 of file ProjectWindow.cpp.

{
   return mVsbar->GetThumbPosition();
}

References mVsbar.

GetVerticalThumbSize()

int ProjectWindow::GetVerticalThumbSize

(

)

const

Definition at line 807 of file ProjectWindow.cpp.

{
   return mVsbar->GetThumbSize();
}

References mVsbar.

IsActive()

bool ProjectWindow::IsActive ( )

override

Definition at line 1185 of file ProjectWindow.cpp.

{
   return mActive;
}

References mActive.

IsBeingDeleted()

bool ProjectWindow::IsBeingDeleted ( ) const

inline

Definition at line 56 of file ProjectWindow.h.

{ return mIsDeleting; }

Referenced by OnActivate().

Here is the caller graph for this function:

IsIconized()

bool ProjectWindow::IsIconized ( ) const

override

Definition at line 881 of file ProjectWindow.cpp.

{
   return mIconized;
}

References mIconized.

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

Here is the caller graph for this function:

IsTrackMinimized()

bool ProjectWindow::IsTrackMinimized

(

const Track &

track

)

Definition at line 740 of file ProjectWindow.cpp.

{
   return ChannelView::Get(*track.GetChannel(0)).GetMinimized();
}

References ChannelView::Get(), ChannelGroup::GetChannel(), and ChannelView::GetMinimized().

Here is the call graph for this function:

MacShowUndockedToolbars()

void ProjectWindow::MacShowUndockedToolbars

(

bool

show

)

Definition at line 940 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
}

References BasicUI::FindFocus().

Referenced by OnIconize().

Here is the call graph for this function:

Here is the caller graph for this function:

MayScrollBeyondZero()

bool ProjectWindow::MayScrollBeyondZero

(

)

const

Definition at line 711 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return false;
   auto &project = *pProject;
   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 ProjectWindowBase::FindProject(), ProjectAudioIO::Get(), ViewInfo::Get(), Scrubber::Get(), ProjectAudioIO::IsAudioActive(), mPlaybackScroller, ProjectWindow::PlaybackScroller::Pinned, project, and ProjectWindow::PlaybackScroller::Right.

Referenced by ProjectWindow::PlaybackScroller::OnTimer().

Here is the call graph for this function:

Here is the caller graph for this function:

MinimumTrackHeight()

unsigned ProjectWindow::MinimumTrackHeight

(

)

Definition at line 735 of file ProjectWindow.cpp.

{
   return CommonTrackInfo::MinimumTrackHeight();
}

References CommonTrackInfo::MinimumTrackHeight().

Here is the call graph for this function:

NextWindowID()

int ProjectWindow::NextWindowID

(

)

Definition at line 431 of file ProjectWindow.cpp.

{
   return mNextWindowID++;
}

References mNextWindowID.

OnActivate()

void ProjectWindow::OnActivate

(

wxActivateEvent &

event

)

Definition at line 1150 of file ProjectWindow.cpp.

{
   // Activate events can fire during window teardown, so just
   // ignore them.
   if (IsBeingDeleted()) {
      return;
   }
 
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
 
   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 ProjectWindowBase::FindProject(), ToolManager::Get(), GetProjectPanel(), IsBeingDeleted(), mActive, project, and SetActiveProject().

Here is the call graph for this function:

OnIconize()

void ProjectWindow::OnIconize

(

wxIconizeEvent &

event

)

Definition at line 972 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 1109 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 pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
   auto &commandManager = CommandManager::Get( project );
   bool handled = commandManager.HandleMenuID(
      event.GetId(), CommandManager::Get( project ).GetUpdateFlags(),
      false);
 
   if (handled)
      event.Skip(false);
   else{
      event.ResumePropagation( 999 );
      event.Skip(true);
   }
}

References ProjectWindowBase::FindProject(), CommandManager::Get(), CommandManager::GetUpdateFlags(), and project.

Here is the call graph for this function:

OnMouseEvent()

void ProjectWindow::OnMouseEvent

(

wxMouseEvent &

event

)

Definition at line 1190 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
   if (event.ButtonDown())
      SetActiveProject( &project );
}

References ProjectWindowBase::FindProject(), project, and SetActiveProject().

Here is the call graph for this function:

OnMove()

void ProjectWindow::OnMove

(

wxMoveEvent &

event

)

Definition at line 1011 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:

OnProjectTitleChange()

void ProjectWindow::OnProjectTitleChange

(

ProjectFileIOMessage

message

)

Definition at line 1086 of file ProjectWindow.cpp.

{
   if (message == ProjectFileIOMessage::ProjectTitleChange) {
      auto pProject = FindProject();
      if (!pProject)
         return;
      auto &project = *pProject;
      const auto &name = ProjectFileIO::Get(project).GetProjectTitle();
      if (name != GetTitle()) {
         SetTitle(name);
         SetName(name); // to make the nvda screen reader read the correct title
      }
   }
}

References ProjectWindowBase::FindProject(), ProjectFileIO::Get(), ProjectFileIO::GetProjectTitle(), name, project, and ProjectTitleChange.

Referenced by ProjectWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

OnScroll()

void ProjectWindow::OnScroll

(

wxScrollEvent &

event

)

Definition at line 1101 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   Viewport::Get(*pProject).OnScroll();
}

References ProjectWindowBase::FindProject(), Viewport::Get(), and Viewport::OnScroll().

Here is the call graph for this function:

OnScrollLeftButton()

void ProjectWindow::OnScrollLeftButton

(

wxScrollEvent &

event

)

Definition at line 683 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   Viewport::Get(*pProject).OnScrollLeftButton();
}

References ProjectWindowBase::FindProject(), Viewport::Get(), and Viewport::OnScrollLeftButton().

Here is the call graph for this function:

OnScrollRightButton()

void ProjectWindow::OnScrollRightButton

(

wxScrollEvent &

event

)

Definition at line 691 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   Viewport::Get(*pProject).OnScrollRightButton();
}

References ProjectWindowBase::FindProject(), Viewport::Get(), and Viewport::OnScrollRightButton().

Here is the call graph for this function:

OnShow()

void ProjectWindow::OnShow

(

wxShowEvent &

event

)

Definition at line 1038 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 1018 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) {
      auto pProject = FindProject();
      if (pProject)
         Viewport::Get(*pProject).HandleResize();
      if (!this->IsMaximized() && !this->IsIconized())
         SetNormalizedWindowState(this->GetRect());
   }
   event.Skip();
}

References ProjectWindowBase::FindProject(), Viewport::Get(), Viewport::HandleResize(), IsIconized(), mShownOnce, and SetNormalizedWindowState().

Here is the call graph for this function:

OnThemeChange()

void ProjectWindow::OnThemeChange ( struct ThemeChangeMessage  message )

private

Definition at line 658 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
 
   if (message.appearance)
      return;
   this->ApplyUpdatedTheme();
   auto &toolManager = ToolManager::Get( project );
   toolManager.ForEach([](auto pToolBar){
      if( pToolBar )
         pToolBar->ReCreateButtons();
   });
}

References ThemeChangeMessage::appearance, ApplyUpdatedTheme(), ProjectWindowBase::FindProject(), ToolManager::Get(), and project.

Referenced by ProjectWindow().

Here is the call graph for this function:

Here is the caller 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 1078 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (pProject)
      Viewport::Get(*pProject).HandleResize();
   event.Skip(false);             /* No need to propagate any further */
}

References ProjectWindowBase::FindProject(), Viewport::Get(), and Viewport::HandleResize().

Here is the call graph for this function:

OnUpdateUI()

void ProjectWindow::OnUpdateUI

(

wxUpdateUIEvent &

event

)

Definition at line 1141 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
   CommandManager::Get(project).UpdateMenus();
}

References ProjectWindowBase::FindProject(), CommandManager::Get(), project, and CommandManager::UpdateMenus().

Here is the call graph for this function:

OnViewportMessage()

void ProjectWindow::OnViewportMessage ( const ViewportMessage &  message )

private

Definition at line 1256 of file ProjectWindow.cpp.

{
   // Activate events can fire during window teardown, so just
   // ignore them.
   if (mIsDeleting)
      return;
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
   auto &viewInfo = ViewInfo::Get(project);
   auto &trackPanel = GetProjectPanel(project);
 
   auto [rescroll, scrollbarVisibilityChanged, resize] = message;
 
   if (rescroll)
      trackPanel.Refresh(false);
 
   // why?  Is there a menu item whose availability depends on scroll position
   // or zoom level?
   CommandManager::Get(project).UpdateMenus();
 
   if (scrollbarVisibilityChanged || resize)
      UpdateLayout();
}

References ProjectWindowBase::FindProject(), CommandManager::Get(), ViewInfo::Get(), GetProjectPanel(), mIsDeleting, project, UpdateLayout(), and CommandManager::UpdateMenus().

Here is the call graph for this function:

RefreshTPTrack()

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

SetChannelHeights()

void ProjectWindow::SetChannelHeights	(	Track &	track,
		unsigned	height
	)

Definition at line 761 of file ProjectWindow.cpp.

{
   for (auto pChannel : track.Channels())
      ChannelView::Get(*pChannel).SetExpandedHeight(height);
}

References ChannelGroup::Channels(), ChannelView::Get(), and ChannelView::SetExpandedHeight().

Here is the call graph for this function:

SetHorizontalScrollbar()

void ProjectWindow::SetHorizontalScrollbar	(	int	position,
		int	thumbSize,
		int	range,
		int	pageSize,
		bool	refresh
	)

Definition at line 787 of file ProjectWindow.cpp.

{
   mHsbar->SetScrollbar(position, thumbSize, range, pageSize, refresh);
}

References mHsbar.

SetHorizontalThumbPosition()

void ProjectWindow::SetHorizontalThumbPosition

(

int

viewStart

)

Definition at line 782 of file ProjectWindow.cpp.

{
   mHsbar->SetThumbPosition(viewStart);
}

References mHsbar.

SetIsBeingDeleted()

void ProjectWindow::SetIsBeingDeleted ( )

inline

Definition at line 57 of file ProjectWindow.h.

{ mIsDeleting = true; }

SetMinimized()

void ProjectWindow::SetMinimized	(	Track &	track,
		bool	minimized
	)

Definition at line 745 of file ProjectWindow.cpp.

{
   for (auto pChannel : track.Channels())
      ChannelView::Get(*pChannel).SetMinimized(minimized);
}

References ChannelGroup::Channels(), ChannelView::Get(), and ChannelView::SetMinimized().

Here is the call graph for this function:

SetNormalizedWindowState()

void ProjectWindow::SetNormalizedWindowState ( wxRect  pSizeAndLocation )

inline

Definition at line 113 of file ProjectWindow.h.

{  mNormalizedWindowState = pSizeAndLocation;   }

Referenced by OnMove(), and OnSize().

Here is the caller graph for this function:

SetToDefaultSize()

void ProjectWindow::SetToDefaultSize

(

)

Definition at line 901 of file ProjectWindow.cpp.

{
   wxRect defaultRect;
   GetDefaultWindowRect(&defaultRect);
 
   SetSize(defaultRect.width, defaultRect.height);
}

References GetDefaultWindowRect().

Here is the call graph for this function:

SetVerticalScrollbar()

void ProjectWindow::SetVerticalScrollbar	(	int	position,
		int	thumbSize,
		int	range,
		int	pageSize,
		bool	refresh
	)

Definition at line 822 of file ProjectWindow.cpp.

{
   mVsbar->SetScrollbar(position, thumbSize, range, pageSize, refresh);
}

References mVsbar.

SetVerticalThumbPosition()

void ProjectWindow::SetVerticalThumbPosition

(

int

viewStart

)

Definition at line 817 of file ProjectWindow.cpp.

{
   mVsbar->SetThumbPosition(viewStart);
}

References mVsbar.

ShowHorizontalScrollbar()

void ProjectWindow::ShowHorizontalScrollbar

(

bool

shown

)

Definition at line 793 of file ProjectWindow.cpp.

{
#ifdef __WXGTK__
   mHsbar->Show(shown);
#else
   mHsbar->Enable(shown);
#endif
}

References mHsbar.

ShowVerticalScrollbar()

void ProjectWindow::ShowVerticalScrollbar

(

bool

shown

)

Definition at line 828 of file ProjectWindow.cpp.

{
#ifdef __WXGTK__
   mVsbar->Show(shown);
#else
   mVsbar->Enable(shown);
#endif
}

References mVsbar.

UpdateLayout()

void ProjectWindow::UpdateLayout

(

)

Definition at line 837 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
   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 ProjectWindowBase::FindProject(), ToolManager::Get(), GetProjectPanel(), and project.

Referenced by OnViewportMessage().

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 675 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 909 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return;
   auto &project = *pProject;
   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( project, 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 ProjectWindowBase::FindProject(), ProjectStatus::GetStatusWidthFunctions(), mainStatusBarField, nStatusBarFields, project, and rateStatusBarField.

Referenced by InitProjectWindow(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

ViewportSize()

std::pair< int, int > ProjectWindow::ViewportSize

(

)

const

Definition at line 699 of file ProjectWindow.cpp.

{
   auto pProject = FindProject();
   if (!pProject)
      return { 0, 0 };
   auto &project = *pProject;
   auto &trackPanel = TrackPanel::Get(project);
   int width, height;
   trackPanel.GetSize(&width, &height);
   return { width, height };
}

References ProjectWindowBase::FindProject(), TrackPanel::Get(), and project.

Here is the call graph for this function:

Member Data Documentation

mActive

bool ProjectWindow::mActive { true }

private

Definition at line 195 of file ProjectWindow.h.

Referenced by IsActive(), and OnActivate().

mContainerWindow

wxSplitterWindow* ProjectWindow::mContainerWindow

private

Definition at line 187 of file ProjectWindow.h.

Referenced by GetContainerWindow(), and ProjectWindow().

mHsbar

wxScrollBar* ProjectWindow::mHsbar {}

private

Definition at line 190 of file ProjectWindow.h.

Referenced by GetHorizontalRange(), GetHorizontalThumbPosition(), GetHorizontalThumbSize(), ProjectWindow(), SetHorizontalScrollbar(), SetHorizontalThumbPosition(), and ShowHorizontalScrollbar().

mIconized

bool ProjectWindow::mIconized { false }

private

Definition at line 196 of file ProjectWindow.h.

Referenced by IsIconized(), and OnIconize().

mIsDeleting

bool ProjectWindow::mIsDeleting { false }

private

Definition at line 201 of file ProjectWindow.h.

Referenced by OnViewportMessage().

mNextWindowID

int ProjectWindow::mNextWindowID {}

private

Definition at line 193 of file ProjectWindow.h.

Referenced by NextWindowID(), and ProjectWindow().

mNormalizedWindowState

wxRect ProjectWindow::mNormalizedWindowState

private

Definition at line 184 of file ProjectWindow.h.

mPlaybackScroller

std::unique_ptr<PlaybackScroller> ProjectWindow::mPlaybackScroller

private

Definition at line 211 of file ProjectWindow.h.

Referenced by MayScrollBeyondZero(), and ProjectWindow().

mShownOnce

bool ProjectWindow::mShownOnce { false }

private

Definition at line 197 of file ProjectWindow.h.

Referenced by OnShow(), and OnSize().

mSnappingChangedSubscription

Observer::Subscription ProjectWindow::mSnappingChangedSubscription

private

Definition at line 209 of file ProjectWindow.h.

mThemeChangeSubscription

Observer::Subscription ProjectWindow::mThemeChangeSubscription

private

Definition at line 207 of file ProjectWindow.h.

Referenced by ProjectWindow().

mTitleChangeSubscription

Observer::Subscription ProjectWindow::mTitleChangeSubscription

private

Definition at line 208 of file ProjectWindow.h.

Referenced by ProjectWindow().

mTopPanel

wxPanel* ProjectWindow::mTopPanel {}

private

Definition at line 186 of file ProjectWindow.h.

Referenced by GetTopPanel(), and ProjectWindow().

mTrackListWindow

wxWindow* ProjectWindow::mTrackListWindow {}

private

Definition at line 188 of file ProjectWindow.h.

Referenced by GetTrackListWindow(), and ProjectWindow().

mViewportSubscription

const Observer::Subscription ProjectWindow::mViewportSubscription

private

Definition at line 212 of file ProjectWindow.h.

mVsbar

wxScrollBar* ProjectWindow::mVsbar {}

private

Definition at line 191 of file ProjectWindow.h.

Referenced by GetVerticalRange(), GetVerticalThumbPosition(), GetVerticalThumbSize(), ProjectWindow(), SetVerticalScrollbar(), SetVerticalThumbPosition(), and ShowVerticalScrollbar().

---

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

• ProjectWindow.h
• ProjectWindow.cpp