ProjectWindows.h

Go to the documentation of this file.

/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file ProjectWindows.h
  @brief accessors for certain important windows associated with each project
 
  Paul Licameli split from Project.h
 
**********************************************************************/
 
#ifndef __AUDACITY_PROJECT_WINDOWS__
#define __AUDACITY_PROJECT_WINDOWS__
 
#include "ClientData.h"
 
class AudacityProject;
class wxFrame;
class wxWindow;
namespace BasicUI { class WindowPlacement; }
 
AUDACITY_DLL_API wxFrame &GetProjectFrame( AudacityProject &project );
AUDACITY_DLL_API const wxFrame &GetProjectFrame( const AudacityProject &project );
 
AUDACITY_DLL_API wxFrame *FindProjectFrame( AudacityProject *project );
 
AUDACITY_DLL_API const wxFrame *FindProjectFrame( const AudacityProject *project );
 
// (as a wxWindow only, when you do not need to use the subclass TrackPanel)
AUDACITY_DLL_API wxWindow &GetProjectPanel( AudacityProject &project );
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 );
 
// Container of pointers to various windows associated with the project, which
// is not responsible for destroying them -- wxWidgets handles that instead
class AttachedWindows : public ClientData::Site<
   AttachedWindows, wxWindow, ClientData::SkipCopying, ClientData::BarePtr
>
{
public:
   explicit AttachedWindows(AudacityProject &project)
      : mProject{project} {}
   operator AudacityProject & () const { return mProject; }
private:
   AudacityProject &mProject;
};
 
AUDACITY_DLL_API AttachedWindows &GetAttachedWindows(AudacityProject &project);
 
#endif