ProjectWindows.h File Reference

accessors for certain important windows associated with each project More...

#include "ClientData.h"

Include dependency graph for ProjectWindows.h:

Go to the source code of this file.

Classes
class	AttachedWindows

Namespaces
namespace	BasicUI

Functions
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)
AUDACITY_DLL_API 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...
AUDACITY_DLL_API 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...
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 void	SetProjectFrame (AudacityProject &project, wxFrame &frame)
AUDACITY_DLL_API AttachedWindows &	GetAttachedWindows (AudacityProject &project)

Detailed Description

accessors for certain important windows associated with each project

---

Audacity: A Digital Audio Editor

Paul Licameli split from Project.h

Definition in file ProjectWindows.h.

Function Documentation

FindProjectFrame() [1/2]

AUDACITY_DLL_API 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 87 of file ProjectWindows.cpp.

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

References BasicUI::Get(), and project.

Referenced by ToolManager::FilterEvent(), MenuCreator::FilterKeyEvent(), anonymous_namespace{WaveTrackControls.cpp}::GainSliderDrawFunction(), MP3ExportProcessor::Initialize(), AudacityApp::InitPart2(), NotMinimizedFlag(), MeterPanel::OnPreferences(), anonymous_namespace{WaveTrackControls.cpp}::PanSliderDrawFunction(), SetActiveProject(), ShowDependencyDialogIfNeeded(), and anonymous_namespace{NoteTrackControls.cpp}::VelocitySliderDrawFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

FindProjectFrame() [2/2]

AUDACITY_DLL_API 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 93 of file ProjectWindows.cpp.

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

References BasicUI::Get(), and project.

Here is the call graph for this function:

GetAttachedWindows()

AUDACITY_DLL_API AttachedWindows & GetAttachedWindows

(

AudacityProject &

project

)

Definition at line 104 of file ProjectWindows.cpp.

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

References BasicUI::Get(), and project.

Referenced by AdornedRulerPanel::Destroy(), TrackPanel::Destroy(), PitchAndSpeedDialog::Destroy(), ProjectWindow::Find(), AdornedRulerPanel::Get(), ProjectWindow::Get(), RealtimeEffectPanel::Get(), TrackPanel::Get(), PitchAndSpeedDialog::Get(), anonymous_namespace{BatchProcessDialog.cpp}::OnApplyMacrosPalette(), anonymous_namespace{Contrast.cpp}::anonymous_namespace{Contrast.cpp}::OnContrast(), anonymous_namespace{HistoryWindow.cpp}::OnHistory(), anonymous_namespace{BatchProcessDialog.cpp}::OnManageMacros(), anonymous_namespace{MixerBoard.cpp}::OnMixerBoard(), and anonymous_namespace{FreqWindow.cpp}::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 71 of file ProjectWindows.cpp.

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

References BasicUI::Get(), project, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by DragCommand::Apply(), SetProjectCommand::Apply(), CloseAllProjects(), AudioSetupToolBar::CommonMenuItemSteps(), ToolManager::CreateWindows(), LabelTrackView::DialogForLabelName(), CommandDispatch::DoAudacityCommand(), LabelTrackView::DoEditLabels(), EffectUI::DoEffect(), SplashDialog::DoHelpWelcome(), anonymous_namespace{FileMenus.cpp}::DoImport(), SelectUtilities::DoListSelection(), anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), ToolManager::DoneDragging(), DoReloadPreferences(), ProjectFileManager::DoSave(), anonymous_namespace{DropoutDetector.cpp}::DropoutSubscription::DropoutSubscription(), TagsEditorDialog::EditProjectMetadata(), anonymous_namespace{ExtraMenus.cpp}::ExtraMiscItems(), anonymous_namespace{EditMenus.cpp}::FindSourceTracks(), GetNextWindowPlacement(), AUPImportFileHandle::HandleProject(), anonymous_namespace{HelpMenus.cpp}::OnAbout(), anonymous_namespace{BatchProcessDialog.cpp}::OnApplyMacroDirectlyByName(), anonymous_namespace{PluginMenus.cpp}::OnBenchmark(), anonymous_namespace{FileMenus.cpp}::OnClose(), anonymous_namespace{FileMenus.cpp}::OnExportLabels(), anonymous_namespace{ExportMIDI.cpp}::OnExportMIDI(), anonymous_namespace{ExtraMenus.cpp}::OnFullScreen(), ToolManager::OnGrabber(), ProjectWindow::OnIconize(), TrackPanel::OnIdle(), anonymous_namespace{FileMenus.cpp}::OnImportLabels(), anonymous_namespace{ImportMIDI.cpp}::OnImportMIDI(), anonymous_namespace{ProjectFileManager.cpp}::ImportProgress::OnImportResult(), AudacityApp::OnInit0(), anonymous_namespace{HelpMenus.cpp}::OnManual(), ToolManager::OnMouse(), NavigationActions::Handler::OnNextWindow(), anonymous_namespace{EditMenus.cpp}::OnPreferences(), NavigationActions::Handler::OnPrevWindow(), anonymous_namespace{HelpMenus.cpp}::OnQuickFix(), anonymous_namespace{HelpMenus.cpp}::OnQuickHelp(), anonymous_namespace{TrackMenus.cpp}::OnResample(), TrackMenuTable::OnSetName(), SelectUtilities::OnSetRegion(), anonymous_namespace{TransportMenus.cpp}::OnSoundActivated(), AudacityApp::OnTimer(), anonymous_namespace{TimerRecordDialog.cpp}::OnTimerRecord(), ProjectAudioManager::PlayPlayRegion(), ProjectFileManager::ReadProjectFile(), MenuCreator::ReallyDoQuickCheck(), MenuCreator::RebuildAllMenuBars(), MenuCreator::RebuildMenuBar(), RefreshAllTitles(), ProjectFileManager::SaveAs(), ProjectFileManager::SaveCopy(), GetInfoCommand::SendBoxes(), GetInfoCommand::SendMenus(), GetInfoCommand::SendPreferences(), LabelTrackView::ShowContextMenu(), ShowDiagnostics(), 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 79 of file ProjectWindows.cpp.

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

References BasicUI::Get(), project, 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 48 of file ProjectWindows.cpp.

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

References BasicUI::Get(), project, and THROW_INCONSISTENCY_EXCEPTION.

Referenced by Scrubber::ContinueScrubbingPoll(), AdornedRulerPanel::CreateOverlays(), Scrubber::DoScrub(), AdornedRulerPanel::DrawBothOverlays(), ProjectWindow::OnActivate(), ProjectWindow::PlaybackScroller::OnTimer(), ScrubbingOverlay::OnTimer(), ProjectWindow::OnViewportMessage(), AudacityMirProject::ShouldBeReconfigured(), and ProjectWindow::UpdateLayout().

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 56 of file ProjectWindows.cpp.

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

References BasicUI::Get(), project, and THROW_INCONSISTENCY_EXCEPTION.

Here is the call graph for this function:

SetProjectFrame()

AUDACITY_DLL_API void SetProjectFrame	(	AudacityProject &	project,
		wxFrame &	frame
	)

Definition at line 99 of file ProjectWindows.cpp.

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

References BasicUI::Get(), and project.

Referenced by ProjectWindowBase::ProjectWindowBase().

Here is the call graph for this function:

Here is the caller graph for this function:

SetProjectPanel()

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

Definition at line 65 of file ProjectWindows.cpp.

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

References BasicUI::Get(), and project.

Here is the call graph for this function: