ProjectWindows.cpp File Reference

#include "ProjectWindows.h"
#include "Project.h"
#include "widgets/wxWidgetsWindowPlacement.h"
#include <wx/frame.h>

Include dependency graph for ProjectWindows.cpp:

Go to the source code of this file.

Classes
struct	anonymous_namespace{ProjectWindows.cpp}::ProjectWindows

Namespaces
	anonymous_namespace{ProjectWindows.cpp}

Functions
AUDACITY_DLL_API wxWindow &	GetProjectPanel (AudacityProject &project)
	Get the main sub-window of the project frame that displays track data. More...
AUDACITY_DLL_API const wxWindow &	GetProjectPanel (const AudacityProject &project)
AUDACITY_DLL_API void	SetProjectPanel (AudacityProject &project, wxWindow &panel)
AUDACITY_DLL_API wxFrame &	GetProjectFrame (AudacityProject &project)
	Get the top-level window associated with the project (as a wxFrame only, when you do not need to use the subclass ProjectWindow) More...
AUDACITY_DLL_API const wxFrame &	GetProjectFrame (const AudacityProject &project)
wxFrame *	FindProjectFrame (AudacityProject *project)
	Get a pointer to the window associated with a project, or null if the given pointer is null, or the window was not yet set. More...
const wxFrame *	FindProjectFrame (const AudacityProject *project)
	Get a pointer to the window associated with a project, or null if the given pointer is null, or the window was not yet set. More...
std::unique_ptr< const BasicUI::WindowPlacement >	ProjectFramePlacement (AudacityProject *project)
	Make a WindowPlacement object suitable for project (which may be null) More...
void	SetProjectFrame (AudacityProject &project, wxFrame &frame)
AUDACITY_DLL_API AttachedWindows &	GetAttachedWindows (AudacityProject &project)

Variables
const AudacityProject::AttachedObjects::RegisteredFactory	anonymous_namespace{ProjectWindows.cpp}::key

Detailed Description

---

Audacity: A Digital Audio Editor

Paul Licameli split from Project.cpp

Definition in file ProjectWindows.cpp.

Function Documentation

FindProjectFrame() [1/2]

wxFrame* FindProjectFrame

(

AudacityProject *

project

)

Get a pointer to the window associated with a project, or null if the given pointer is null, or the window was not yet set.

Definition at line 88 of file ProjectWindows.cpp.

                                                      {
   if (!project)
      return nullptr;
   return ProjectWindows::Get(*project).mFrame;
}

References BasicUI::Get().

Referenced by Exporter::DisplayOptions(), ToolManager::FilterEvent(), CommandManager::FilterKeyEvent(), anonymous_namespace{WaveTrackControls.cpp}::GainSliderDrawFunction(), AudacityApp::InitPart2(), NotMinimizedFlag(), Exporter::OnHelp(), MeterPanel::OnPreferences(), anonymous_namespace{WaveTrackControls.cpp}::PanSliderDrawFunction(), SetActiveProject(), ProjectFileIO::SetProjectTitle(), and ShowDependencyDialogIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

FindProjectFrame() [2/2]

const wxFrame* FindProjectFrame

(

const AudacityProject *

project

)

Get a pointer to the window associated with a project, or null if the given pointer is null, or the window was not yet set.

Definition at line 94 of file ProjectWindows.cpp.

                                                                  {
   if (!project)
      return nullptr;
   return ProjectWindows::Get(*project).mFrame;
}

References BasicUI::Get().

Here is the call graph for this function:

GetAttachedWindows()

AUDACITY_DLL_API AttachedWindows& GetAttachedWindows

(

AudacityProject &

project

)

Definition at line 114 of file ProjectWindows.cpp.

{
   return ProjectWindows::Get(project).mAttachedWindows;
}

References BasicUI::Get().

Referenced by AdornedRulerPanel::Destroy(), TrackPanel::Destroy(), ProjectWindow::Find(), AdornedRulerPanel::Get(), ProjectWindow::Get(), TrackPanel::Get(), PluginActions::Handler::OnApplyMacrosPalette(), anonymous_namespace{Contrast.cpp}::Handler::OnContrast(), anonymous_namespace{HistoryWindow.cpp}::Handler::OnHistory(), anonymous_namespace{LyricsWindow.cpp}::Handler::OnKaraoke(), PluginActions::Handler::OnManageMacros(), anonymous_namespace{MixerBoard.cpp}::Handler::OnMixerBoard(), and anonymous_namespace{FreqWindow.cpp}::Handler::OnPlotSpectrum().

Here is the call graph for this function:

Here is the caller graph for this function:

GetProjectFrame() [1/2]

AUDACITY_DLL_API wxFrame& GetProjectFrame

(

AudacityProject &

project

)

Get the top-level window associated with the project (as a wxFrame only, when you do not need to use the subclass ProjectWindow)

Definition at line 72 of file ProjectWindows.cpp.

{
   auto ptr = ProjectWindows::Get(project).mFrame;
   if ( !ptr )
      THROW_INCONSISTENCY_EXCEPTION;
   return *ptr;
}

References BasicUI::Get(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by DragCommand::Apply(), SetProjectCommand::Apply(), CloseAllProjects(), MenuCreator::CreateMenusAndCommands(), ToolManager::CreateWindows(), LabelTrackView::DialogForLabelName(), Exporter::DoEditMetadata(), SplashDialog::DoHelpWelcome(), DoImportMIDIProject(), SelectUtilities::DoListSelection(), anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), ToolManager::DoneDragging(), DoReloadPreferences(), ProjectFileManager::DoSave(), anonymous_namespace{ExtraMenus.cpp}::ExtraMiscItems(), GetNextWindowPlacement(), MenuManager::GetUpdateFlags(), AUPImportFileHandle::HandleNoteTrack(), AUPImportFileHandle::HandleProject(), AUPImportFileHandle::HandleTimeTrack(), AUPImportFileHandle::Import(), InstallHandlers::InstallHandlers(), HelpActions::Handler::OnAbout(), ProjectAudioManager::OnAudioIOStopRecording(), PluginActions::Handler::OnBenchmark(), FileActions::Handler::OnExportLabels(), FileActions::Handler::OnExportMIDI(), ExtraActions::Handler::OnFullScreen(), ToolManager::OnGrabber(), ProjectWindow::OnIconize(), TrackPanel::OnIdle(), FileActions::Handler::OnImportMIDI(), HelpActions::Handler::OnManual(), ToolManager::OnMouse(), NavigationActions::Handler::OnNextWindow(), ProjectManager::OnOpenAudioFile(), FileActions::Handler::OnPageSetup(), EditActions::Handler::OnPreferences(), NavigationActions::Handler::OnPrevWindow(), FileActions::Handler::OnPrint(), HelpActions::Handler::OnQuickFix(), HelpActions::Handler::OnQuickHelp(), TrackMenuTable::OnSetName(), SelectUtilities::OnSetRegion(), TransportActions::Handler::OnSoundActivated(), AudacityApp::OnTimer(), AUPImportFileHandle::Open(), ProjectAudioManager::PlayPlayRegion(), ScreenshotBigDialog::PopulateOrExchange(), ProjectFramePlacement(), ProjectFileManager::ReadProjectFile(), MenuCreator::RebuildAllMenuBars(), MenuCreator::RebuildMenuBar(), RefreshAllTitles(), ProjectFileManager::SaveAs(), ProjectFileManager::SaveCopy(), GetInfoCommand::SendBoxes(), GetInfoCommand::SendMenus(), GetInfoCommand::SendPreferences(), LabelTrackView::ShowContextMenu(), anonymous_namespace{HelpMenus.cpp}::ShowDiagnostics(), ScreenshotBigDialog::SizeMainWindow(), WaveTrackAffordanceControls::StartEditClipName(), ToolManager::Updated(), and ProjectManager::ProjectChooser::~ProjectChooser().

Here is the call graph for this function:

GetProjectFrame() [2/2]

AUDACITY_DLL_API const wxFrame& GetProjectFrame

(

const AudacityProject &

project

)

Definition at line 80 of file ProjectWindows.cpp.

{
   auto ptr = ProjectWindows::Get(project).mFrame;
   if ( !ptr )
      THROW_INCONSISTENCY_EXCEPTION;
   return *ptr;
}

References BasicUI::Get(), and THROW_INCONSISTENCY_EXCEPTION.

Here is the call graph for this function:

GetProjectPanel() [1/2]

AUDACITY_DLL_API wxWindow& GetProjectPanel

(

AudacityProject &

project

)

Get the main sub-window of the project frame that displays track data.

Definition at line 49 of file ProjectWindows.cpp.

{
   auto ptr = ProjectWindows::Get(project).mPanel;
   if ( !ptr )
      THROW_INCONSISTENCY_EXCEPTION;
   return *ptr;
}

References BasicUI::Get(), and THROW_INCONSISTENCY_EXCEPTION.

Referenced by AdornedRulerPanel::CreateOverlays(), ProjectWindow::DoScroll(), AdornedRulerPanel::DrawBothOverlays(), ProjectWindow::FixScrollbars(), ProjectWindow::OnActivate(), ProjectWindow::PlaybackScroller::OnTimer(), ScrubbingOverlay::OnTimer(), ProjectWindow::RedrawProject(), ProjectWindow::ScrollIntoView(), ProjectWindow::UpdateLayout(), and ProjectWindow::ZoomAfterImport().

Here is the call graph for this function:

Here is the caller graph for this function:

GetProjectPanel() [2/2]

AUDACITY_DLL_API const wxWindow& GetProjectPanel

(

const AudacityProject &

project

)

Definition at line 57 of file ProjectWindows.cpp.

{
   auto ptr = ProjectWindows::Get(project).mPanel;
   if ( !ptr )
      THROW_INCONSISTENCY_EXCEPTION;
   return *ptr;
}

References BasicUI::Get(), and THROW_INCONSISTENCY_EXCEPTION.

Here is the call graph for this function:

ProjectFramePlacement()

std::unique_ptr<const BasicUI::WindowPlacement> ProjectFramePlacement

(

AudacityProject *

project

)

Make a WindowPlacement object suitable for project (which may be null)

Postcondition

return value is not null

Definition at line 101 of file ProjectWindows.cpp.

{
   if (!project)
      return std::make_unique<BasicUI::WindowPlacement>();
   return std::make_unique<wxWidgetsWindowPlacement>(
      &GetProjectFrame(*project));
}

References GetProjectFrame().

Referenced by ProjectAudioManager::DoRecord(), ProjectFileManager::DoSave(), ProjectFileIO::HandleXMLTag(), ProjectFileManager::Import(), ProjectFileManager::OpenProjectFile(), ProjectAudioManager::PlayPlayRegion(), ProjectFileIO::RenameOrWarn(), ProjectFileManager::SaveCopy(), and AudioIO::StartMonitoring().

Here is the call graph for this function:

Here is the caller graph for this function:

SetProjectFrame()

void SetProjectFrame	(	AudacityProject &	project,
		wxFrame &	frame
	)

Definition at line 109 of file ProjectWindows.cpp.

{
   ProjectWindows::Get(project).mFrame = &frame;
}

References BasicUI::Get().

Here is the call graph for this function:

SetProjectPanel()

AUDACITY_DLL_API void SetProjectPanel	(	AudacityProject &	project,
		wxWindow &	panel
	)

Definition at line 66 of file ProjectWindows.cpp.

{
   ProjectWindows::Get(project).mPanel = &panel;
}

References BasicUI::Get().

Here is the call graph for this function: