Implements a command for capturing various areas of the screen or project window. It's one big if-elseif switch statement with lots of small calculations of rectangles. More...

#include <ScreenshotCommand.h>

Inheritance diagram for ScreenshotCommand:

[legend]

Collaboration diagram for ScreenshotCommand:

[legend]

Public Types
enum	kBackgrounds { kBlue , kWhite , kNone , nBackgrounds }

enum	kCaptureTypes { kwindow , kfullwindow , kwindowplus , kfullscreen , ktoolbars , keffects , kscriptables , kpreferences , ktrackpanel , kruler , ktracks , kfirsttrack , kfirsttwotracks , kfirstthreetracks , kfirstfourtracks , ksecondtrack , ktracksplus , kfirsttrackplus , kalltracks , kalltracksplus , nCaptureWhats }

Public Types inherited from AudacityCommand
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Public Member Functions
EnumValueSymbols	kCaptureWhatStrings ()

	ScreenshotCommand ()

ComponentInterfaceSymbol	GetSymbol () const override

TranslatableString	GetDescription () const override

template<bool Const>
bool	VisitSettings (SettingsVisitorBase< Const > &S)

bool	VisitSettings (SettingsVisitor &S) override

bool	VisitSettings (ConstSettingsVisitor &S) override

void	PopulateOrExchange (ShuttleGui &S) override

ManualPageID	ManualPage () override

bool	Apply (const CommandContext &context) override

void	GetDerivedParams ()

void	CaptureWindowOnIdle (const CommandContext &context, wxWindow *pWin)

wxTopLevelWindow *	GetFrontWindow (AudacityProject *project)

Public Member Functions inherited from AudacityCommand
	AudacityCommand ()

virtual	~AudacityCommand ()

PluginPath	GetPath () const override

VendorSymbol	GetVendor () const override

wxString	GetVersion () const override

ComponentInterfaceSymbol	GetSymbol () const override=0

virtual TranslatableString	GetDescription () const override

virtual ManualPageID	ManualPage ()

virtual bool	IsBatchProcessing () const

virtual void	SetBatchProcessing (bool start)

virtual bool	Apply (const CommandContext &WXUNUSED(context))

bool	ShowInterface (wxWindow *parent, bool forceModal=false)

wxDialog *	CreateUI (wxWindow parent, AudacityCommand client)

bool	SaveSettingsAsString (wxString &parms)

bool	LoadSettingsFromString (const wxString &parms)

bool	DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)

int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

virtual bool	Init ()

virtual bool	PromptUser (wxWindow *parent)

virtual bool	CheckWhetherSkipAudacityCommand ()

virtual void	End ()

virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))

virtual bool	TransferDataToWindow ()

virtual bool	TransferDataFromWindow ()

virtual bool	VisitSettings (SettingsVisitor &)

virtual bool	VisitSettings (ConstSettingsVisitor &)

Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()

virtual PluginPath	GetPath () const =0

virtual ComponentInterfaceSymbol	GetSymbol () const =0

virtual VendorSymbol	GetVendor () const =0

virtual wxString	GetVersion () const =0

virtual TranslatableString	GetDescription () const =0

TranslatableString	GetName () const

Static Public Member Functions
static void	SetIdleHandler (AudacityProject &project)

static bool	MayCapture (wxDialog *pDlg)

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Screenshot") }

static ScreenshotCommand *	mpShooter =NULL

static void(*	mIdleHandler )(wxIdleEvent &event) = NULL

Private Member Functions
wxString	MakeFileName (const wxString &path, const wxString &basename)

wxRect	GetBackgroundRect ()

bool	CaptureToolbar (const CommandContext &Context, ToolManager *man, Identifier type, const wxString &name)

bool	CaptureDock (const CommandContext &Context, wxWindow *win, const wxString &fileName)

void	CaptureCommands (const CommandContext &Context, const wxArrayStringEx &Commands)

void	CaptureEffects (const CommandContext &Context, AudacityProject *pProject, const wxString &fileName)

void	CaptureScriptables (const CommandContext &Context, AudacityProject *pProject, const wxString &fileName)

void	CapturePreferences (const CommandContext &Context, AudacityProject *pProject, const wxString &fileName)

bool	Capture (const CommandContext &Context, const wxString &basename, wxWindow *window, wxRect rect, bool bg=false)

wxRect	GetWindowRect (wxTopLevelWindow *w)

wxRect	GetFullWindowRect (wxTopLevelWindow *w)

wxRect	GetScreenRect ()

wxRect	GetPanelRect (TrackPanel *panel)

wxRect	GetRulerRect (AdornedRulerPanel *ruler)

wxRect	GetTracksRect (TrackPanel *panel)

wxRect	GetTrackRect (AudacityProject pProj, TrackPanel panel, int n)

wxString	WindowFileName (AudacityProject proj, wxTopLevelWindow w)

Private Attributes
int	mWhat

int	mBack

wxString	mPath

bool	mbBringToTop

bool	bHasBackground

bool	bHasBringToTop

EnumValueSymbols	mSymbols

wxWindow *	mIgnore

bool	mBackground

wxColour	mBackColor

wxString	mDirToWriteTo

wxString	mFilePath

wxString	mFileName

int	mCaptureMode

Friends
class	ScreenshotBigDialog

Additional Inherited Members
Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress

wxDialog *	mUIDialog

wxWindow *	mUIParent

Detailed Description

Implements a command for capturing various areas of the screen or project window. It's one big if-elseif switch statement with lots of small calculations of rectangles.

Definition at line 31 of file ScreenshotCommand.h.

Member Enumeration Documentation

◆ kBackgrounds

enum ScreenshotCommand::kBackgrounds

Enumerator
kBlue
kWhite
kNone
nBackgrounds

Definition at line 34 of file ScreenshotCommand.h.

   {
      kBlue,
      kWhite,
      kNone,
      nBackgrounds
   };

◆ kCaptureTypes

enum ScreenshotCommand::kCaptureTypes

Enumerator
kwindow
kfullwindow
kwindowplus
kfullscreen
ktoolbars
keffects
kscriptables
kpreferences
ktrackpanel
kruler
ktracks
kfirsttrack
kfirsttwotracks
kfirstthreetracks
kfirstfourtracks
ksecondtrack
ktracksplus
kfirsttrackplus
kalltracks
kalltracksplus
nCaptureWhats

Definition at line 42 of file ScreenshotCommand.h.

   {
      kwindow,
      kfullwindow,
      kwindowplus,
      kfullscreen,
      ktoolbars,
      keffects,
      kscriptables,
      kpreferences,
      ktrackpanel,
      kruler,
      ktracks,
      kfirsttrack,
      kfirsttwotracks,
      kfirstthreetracks,
      kfirstfourtracks,
      ksecondtrack,
      ktracksplus,
      kfirsttrackplus,
      kalltracks,
      kalltracksplus,
      nCaptureWhats
   };

Constructor & Destructor Documentation

◆ ScreenshotCommand()

ScreenshotCommand::ScreenshotCommand ( )

Definition at line 121 of file ScreenshotCommand.cpp.

{
   mbBringToTop=true;
   mIgnore=NULL;
   
   static VetoDialogHook::Scope scope{ MayCapture };
}

References MayCapture(), mbBringToTop, mIgnore, and anonymous_namespace{wxCommandTargets.cpp}::scope.

Here is the call graph for this function:

Member Function Documentation

◆ Apply()

bool ScreenshotCommand::Apply ( const CommandContext & context )

override

Definition at line 773 of file ScreenshotCommand.cpp.

{
   GetDerivedParams();
   //Don't reset the toolbars to a known state.
   //We will be capturing variations of them.
   //ToolManager::Get( context.project ).Reset();
 
   wxTopLevelWindow *w = GetFrontWindow(&context.project);
   if (!w)
      return false;
 
   TrackPanel *panel = &TrackPanel::Get( context.project );
   AdornedRulerPanel *ruler = panel->GetRuler();
 
   int nTracks = TrackList::Get(context.project).Size();
 
   int x1,y1,x2,y2;
   w->ClientToScreen(&x1, &y1);
   panel->ClientToScreen(&x2, &y2);
 
   wxPoint p( x2-x1, y2-y1);
 
   auto &toolManager = ToolManager::Get( context.project );
 
   if (mCaptureMode < nCaptureWhats) {
      switch (mCaptureMode) {
      case kwindow:
         return Capture(context,  WindowFileName( &context.project, w ) , w, GetWindowRect(w));
      case kfullwindow:
      case kwindowplus:
         return Capture(context,  WindowFileName( &context.project, w ) , w, GetFullWindowRect(w));
      case kfullscreen:
         return Capture(context, mFileName, w,GetScreenRect());
      case ktoolbars:
         return CaptureDock(context, toolManager.GetTopDock(), mFileName);
      case kscriptables:
         CaptureScriptables(context, &context.project, mFileName);
         return true;
      case keffects:
         CaptureEffects(context, &context.project, mFileName);
         return true;
      case kpreferences:
         CapturePreferences(context, &context.project, mFileName);
         return true;
      case ktrackpanel:
         return Capture(context, mFileName, panel, GetPanelRect(panel));
      case kruler:
         return Capture(context, mFileName, ruler, GetRulerRect(ruler) );
      case ktracks:
         return Capture(context, mFileName, panel, GetTracksRect(panel));
      case kfirsttrack:
         return Capture(context, mFileName, panel, GetTrackRect( &context.project, panel, 0 ) );
      case ksecondtrack:
         return Capture(context, mFileName, panel, GetTrackRect( &context.project, panel, 1 ) );
      case ktracksplus:
      {  wxRect r = GetTracksRect(panel);
         r.SetTop( r.GetTop() - ruler->GetRulerHeight() );
         r.SetHeight( r.GetHeight() + ruler->GetRulerHeight() );
         return Capture(context, mFileName, panel, r);
      }
      case kfirsttrackplus:
      {  wxRect r = GetTrackRect(&context.project, panel, 0 );
         r.SetTop( r.GetTop() - ruler->GetRulerHeight() );
         r.SetHeight( r.GetHeight() + ruler->GetRulerHeight() );
         return Capture(context, mFileName, panel, r );
      }
      case kfirsttwotracks:
      {  wxRect r = GetTrackRect( &context.project, panel, 0 );
         r = r.Union( GetTrackRect( &context.project, panel, 1 ));
         return Capture(context, mFileName, panel, r );
      }
      case kfirstthreetracks:
      {  wxRect r = GetTrackRect( &context.project, panel, 0 );
         r = r.Union( GetTrackRect( &context.project, panel, 2 ));
         return Capture(context, mFileName, panel, r );
      }
      case kfirstfourtracks:
      {  wxRect r = GetTrackRect( &context.project, panel, 0 );
         r = r.Union( GetTrackRect( &context.project, panel, 3 ));
         return Capture(context, mFileName, panel, r );
      }
      case kalltracks:
      {  wxRect r = GetTrackRect( &context.project, panel, 0 );
         r = r.Union( GetTrackRect( &context.project, panel, nTracks-1 ));
         return Capture(context, mFileName, panel, r );
      }
      case kalltracksplus:
      {  wxRect r = GetTrackRect( &context.project, panel, 0 );
         r.SetTop( r.GetTop() - ruler->GetRulerHeight() );
         r.SetHeight( r.GetHeight() + ruler->GetRulerHeight() );
         r = r.Union( GetTrackRect( &context.project, panel, nTracks-1 ));
         return Capture(context, mFileName, panel, r );
      }
      default:
         return false;
      }
   }
   else if (mCaptureMode < nCaptureWhats + toolManager.CountBars()) {
      auto id = kCaptureWhatStrings()[mCaptureMode].Internal();
      return CaptureToolbar(context, &toolManager, id, mFileName);
   }
   else
      return false;
}

References Capture(), CaptureDock(), CaptureEffects(), CapturePreferences(), CaptureScriptables(), CaptureToolbar(), TrackList::Get(), ToolManager::Get(), TrackPanel::Get(), GetDerivedParams(), GetFrontWindow(), GetFullWindowRect(), GetPanelRect(), TrackPanel::GetRuler(), GetRulerRect(), GetScreenRect(), GetTrackRect(), GetTracksRect(), GetWindowRect(), kalltracks, kalltracksplus, kCaptureWhatStrings(), keffects, kfirstfourtracks, kfirstthreetracks, kfirsttrack, kfirsttrackplus, kfirsttwotracks, kfullscreen, kfullwindow, kpreferences, kruler, kscriptables, ksecondtrack, ktoolbars, ktrackpanel, ktracks, ktracksplus, kwindow, kwindowplus, mCaptureMode, mFileName, nCaptureWhats, CommandContext::project, anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler(), TrackList::Size(), and WindowFileName().

Here is the call graph for this function:

◆ Capture()

bool ScreenshotCommand::Capture	(	const CommandContext &	Context,
		const wxString &	basename,
		wxWindow *	window,
		wxRect	rect,
		bool	bg = `false`
	)

private

Definition at line 233 of file ScreenshotCommand.cpp.

{
   int width = r.width;
   int height = r.height;
   if( r.width == 0 )
      return false;
   if (window ) {
      wxWindow * win = window;
      wxTopLevelWindow * top_win= nullptr;
      if( !window->IsTopLevel())
         win = wxGetTopLevelParent(window);
      top_win = dynamic_cast<wxTopLevelWindow*>( win );
      if( (!bHasBringToTop || mbBringToTop) && (!top_win || !top_win->IsActive()) ){
         win->Raise();
         Yield();
      }
   }
 
 
   int screenW, screenH;
   wxDisplaySize(&screenW, &screenH);
   // Bug 1378 workaround.
   // wx 3.0.2 has a bug in Blit from ScreenDC where in default mode 
   // much is drawn transparent - including for example black text!
   // Forcing 24 bit here is a workaround.
   wxBitmap full(screenW, screenH, 24);
 
   wxScreenDC screenDC;
   wxMemoryDC fullDC;
 
#if defined(__WXMAC__) && !wxCHECK_VERSION(3, 0, 0)
   full = DoGetAsBitmap(NULL);
#else
   // We grab the whole screen image since there seems to be a problem with
   // using non-zero source coordinates on OSX.  (as of wx2.8.9)
   fullDC.SelectObject(full);
   fullDC.Blit(0, 0, screenW, screenH, &screenDC, 0, 0);
   fullDC.SelectObject(wxNullBitmap);
#endif
 
   //wxRect r(x, y, width, height);
 
 
   // Convert to screen coordinates if needed
   if (window && window->GetParent() && !window->IsTopLevel()) {
      r.SetPosition(window->GetParent()->ClientToScreen(r.GetPosition()));
   }
 
   // Ensure within bounds (x/y are negative on Windows when maximized)
   r.Intersect(wxRect(0, 0, screenW, screenH));
 
   // Extract the actual image
   wxBitmap part = full.GetSubBitmap(r);
 
   // Add a background
   if (bg && mBackground) {
      wxRect b = GetBackgroundRect();
 
      wxBitmap back(width + b.width, height + b.height);
      fullDC.SelectObject(back);
 
      fullDC.SetBackground(wxBrush(mBackColor, wxBRUSHSTYLE_SOLID));
      fullDC.Clear();
 
      fullDC.DrawBitmap(part, b.x, b.y);
      fullDC.SelectObject(wxNullBitmap);
 
      part = back;
   }
 
   // Save the final image
   wxImage image = part.ConvertToImage();
   ::wxBell();
 
   if (image.SaveFile(filename)) {
      // flush
      context.Status( wxString::Format( _("Saved %s"), filename ), true );
   }
   else {
      context.Error(
         wxString::Format( _("Error trying to save file: %s"), filename ) );
      return false;
   }
   return true;
}

References _, bHasBringToTop, CommandContext::Error(), GetBackgroundRect(), mBackColor, mBackground, mbBringToTop, CommandContext::Status(), wxImage(), and Yield().

Referenced by Apply(), CaptureDock(), CaptureToolbar(), and CaptureWindowOnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureCommands()

void ScreenshotCommand::CaptureCommands	(	const CommandContext &	Context,
		const wxArrayStringEx &	Commands
	)

private

Definition at line 581 of file ScreenshotCommand.cpp.

{
   using namespace std::chrono;
   AudacityProject * pProject = &context.project;
   CommandManager &manager = CommandManager::Get( *pProject );
   wxString Str;
   // Yucky static variables.  Is there a better way?  The problem is that we need the
   // idle callback to know more about what to do.
#ifdef __WXMSW__
   mDirToWriteTo = mFileName.BeforeLast('\\') + "\\";
#else
   mDirToWriteTo = mFileName.BeforeLast('/') + "/";
#endif
   mpShooter = this;
 
   for( size_t i=0;i<Commands.size();i++){
      // The handler is cleared each time it is used.
      SetIdleHandler( context.project );
      Str = Commands[i];
      const CommandContext projectContext( *pProject );
      if( !manager.HandleTextualCommand( Str, projectContext, AlwaysEnabledFlag, true ) )
      {
         wxLogDebug("Command %s not found", Str);
      }
      // This particular sleep is not needed, but gives user a chance to see the
      // dialogs as they whizz by.
      std::this_thread::sleep_for(200ms);
   }
}

References AlwaysEnabledFlag, CommandManager::Get(), manager, mDirToWriteTo, mFileName, mpShooter, CommandContext::project, and SetIdleHandler().

Referenced by CaptureEffects(), and CaptureScriptables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureDock()

bool ScreenshotCommand::CaptureDock	(	const CommandContext &	Context,
		wxWindow *	win,
		const wxString &	fileName
	)

private

Definition at line 354 of file ScreenshotCommand.cpp.

{
   int x = 0, y = 0;
   int width, height;
 
   win->ClientToScreen(&x, &y);
   win->GetParent()->ScreenToClient(&x, &y);
   win->GetClientSize(&width, &height);
 
   return Capture(context, FileName, win, wxRect(x, y, width, height));
}

References Capture().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureEffects()

void ScreenshotCommand::CaptureEffects	(	const CommandContext &	Context,
		AudacityProject *	pProject,
		const wxString &	fileName
	)

private

Definition at line 450 of file ScreenshotCommand.cpp.

{
   (void)pProject;
   (void)&FileName;//compiler food.
   (void)&context;
#define TRICKY_CAPTURE
#define CAPTURE_NYQUIST_TOO
   // Commented out the effects that don't have dialogs.
   // Also any problematic ones, 
   CaptureCommands( context, {
#ifdef TRICKY_CAPTURE
      //"Contrast...", // renamed
      "ContrastAnalyser",
      //"Plot Spectrum...", // renamed
      "PlotSpectrum",
 
      "Auto Duck...",  // needs a track below.
      //"Spectral Edit Multi Tool",
      "Spectral Edit Parametric EQ...", // Needs a spectral selection.
      "Spectral Edit Shelves...",
 
      //"Noise Reduction...", // Exits twice...
      //"SC4...", //Has 'Close' rather than 'Cancel'.
#endif
      "Amplify...",
      "Bass and Treble...",
      "Change Pitch...",
      "Change Speed...",
      "Change Tempo...",
      "Click Removal...",
      "Compressor...",
      "Distortion...",
      "Echo...",
      //"Equalization...",
      "Filter Curve EQ...",
      "Graphic EQ...",
      //"Fade In",
      //"Fade Out",
      //"Invert",
      "Normalize...",
      "Paulstretch...",
      "Phaser...",
      //"Repair",
      "Repeat...",
      "Reverb...",
      //"Reverse",
      "Sliding Stretch...",
      "Truncate Silence...",
      "Wahwah...",
      // Sole LADSPA effect...
#ifdef CAPTURE_NYQUIST_TOO
      "Adjustable Fade...",
      "Clip Fix...",
      //"Crossfade Clips",
      "Crossfade Tracks...",
      "Delay...",
      "High Pass Filter...",
      "Limiter...",
      "Low Pass Filter...",
      "Notch Filter...",
      "Nyquist Effects Prompt...",
      //"Studio Fade Out",
      "Tremolo...",
      "Vocal Reduction and Isolation...",
      "Vocal Remover...",
      "Vocoder...",
#endif
      // Generators.....
      "Chirp...",
      "DTMF Tones...",
      "Noise...",
      "Silence...",
      "Tone...",
#ifdef CAPTURE_NYQUIST_TOO
      "Pluck...",
      "Rhythm Track...",
      "Risset Drum...",
      "Sample Data Import...",
#endif
      // Analyzers...
      "Find Clipping...",
#ifdef CAPTURE_NYQUIST_TOO
      "Beat Finder...",
      "Label Sounds...",
      "Regular Interval Labels...",
      "Sample Data Export...",
#endif
   } );
}

References CaptureCommands().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CapturePreferences()

void ScreenshotCommand::CapturePreferences	(	const CommandContext &	Context,
		AudacityProject *	pProject,
		const wxString &	fileName
	)

private

Definition at line 413 of file ScreenshotCommand.cpp.

{
   using namespace std::chrono;
   (void)&FileName;//compiler food.
   (void)&context;
 
   // Yucky static variables.  Is there a better way?  The problem is that we need the
   // idle callback to know more about what to do.
#ifdef __WXMSW__
   mDirToWriteTo = FileName.BeforeLast('\\') + "\\";
#else
   mDirToWriteTo = FileName.BeforeLast('/') + "/";
#endif
   mpShooter = this;
   const int nPrefsPages = 19;
 
   for( int i=0;i<nPrefsPages;i++){
      // The handler is cleared each time it is used.
      SetIdleHandler( context.project );
      gPrefs->Write(wxT("/Prefs/PrefsCategory"), (long)i);
      gPrefs->Flush();
      CommandID Command{ wxT("Preferences") };
      const CommandContext projectContext( *pProject );
      if( !CommandDispatch::HandleTextualCommand(
         Command, projectContext, AlwaysEnabledFlag, true ) )
      {
         // using GET in a log message for devs' eyes only
         wxLogDebug("Command %s not found", Command.GET() );
      }
      // This sleep is not needed, but gives user a chance to see the
      // dialogs as they whizz by.
      std::this_thread::sleep_for(200ms);
   }
}

References AlwaysEnabledFlag, MenuRegistry::Command, audacity::BasicSettings::Flush(), gPrefs, CommandDispatch::HandleTextualCommand(), mDirToWriteTo, mpShooter, CommandContext::project, SetIdleHandler(), audacity::BasicSettings::Write(), and wxT().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureScriptables()

void ScreenshotCommand::CaptureScriptables	(	const CommandContext &	Context,
		AudacityProject *	pProject,
		const wxString &	fileName
	)

private

Definition at line 542 of file ScreenshotCommand.cpp.

{
   (void)pProject;
   (void)&FileName;//compiler food.
   (void)&context;
 
   CaptureCommands( context, {
      "SelectTime",
      "SelectFrequencies",
      "SelectTracks",
      "SetTrackStatus",
      "SetTrackAudio",
      "SetTrackVisuals",
      "GetPreference",
      "SetPreference",
      "SetClip",
      "SetEnvelope",
      "SetLabel",
      "SetProject",
 
      "Select",
      "SetTrack",
      "GetInfo",
      "Message",
      "Help", // Help on individual commands
      "Import2",
      "Export2",
      "OpenProject2",
      "SaveProject2",
      "Drag",
      "CompareAudio",
      "Screenshot",
   } );
 
}

References CaptureCommands().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureToolbar()

bool ScreenshotCommand::CaptureToolbar	(	const CommandContext &	Context,
		ToolManager *	man,
		Identifier	type,
		const wxString &	name
	)

private

Definition at line 323 of file ScreenshotCommand.cpp.

{
   bool visible = man->IsVisible(type);
   if (!visible) {
      man->ShowHide(type);
      Yield();
   }
 
   wxWindow *w = man->GetToolBar(type);
   if (!w)
      return false;
 
   int x = 0, y = 0;
   int width, height;
 
   w->ClientToScreen(&x, &y);
   w->GetParent()->ScreenToClient(&x, &y);
   w->GetClientSize(&width, &height);
   
   bool result = Capture(context, name, w, wxRect(x, y, width, height));
 
   if (!visible) {
      man->ShowHide(type);
      if (mIgnore)
         mIgnore->Raise();
   }
   return result;
}

References Capture(), ToolManager::GetToolBar(), ToolManager::IsVisible(), mIgnore, name, ToolManager::ShowHide(), and Yield().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureWindowOnIdle()

void ScreenshotCommand::CaptureWindowOnIdle	(	const CommandContext &	context,
		wxWindow *	pWin
	)

Definition at line 379 of file ScreenshotCommand.cpp.

{
   using namespace std::chrono;
   wxDialog * pDlg = dynamic_cast<wxDialog*>(pWin);
   if( !pDlg ){
      wxLogDebug("Event from bogus dlg" );
      return;
   }
 
   wxPoint Pos = pDlg->GetScreenPosition();
   wxSize Siz = pDlg->GetSize();
   wxString Title = pDlg->GetTitle();
 
   // Remove '/' from "Sliding Time Scale/Pitch Shift..."
   // and any other effects that have illegal filename characters.
   Title.Replace( "/", "" );
   Title.Replace( ":", "" );
   wxString Name = mDirToWriteTo + Title + ".png";
 
   wxLogDebug("Taking screenshot of window %s (%i,%i,%i,%i)", Name, 
         Pos.x, Pos.y, Siz.x, Siz.y );
   // This delay is needed, as dialogs take a moment or two to fade in.
   std::this_thread::sleep_for(400ms);
   // JKC: The border of 7 pixels was determined from a trial capture and then measuring
   // in the GIMP.  I'm unsure where the border comes from.
   Capture( context, Name, pDlg, wxRect((int)Pos.x+7, (int)Pos.y, (int)Siz.x-14, (int)Siz.y-7) );
 
   // We've captured the dialog, so now dismiss the dialog.
   wxCommandEvent Evt( wxEVT_BUTTON, wxID_CANCEL );
   pDlg->GetEventHandler()->AddPendingEvent( Evt );
}

References Capture(), and mDirToWriteTo.

Referenced by IdleHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBackgroundRect()

wxRect ScreenshotCommand::GetBackgroundRect ( )

private

Definition at line 210 of file ScreenshotCommand.cpp.

{
   wxRect r;
 
   r.x = 16;
   r.y = 16;
   r.width = r.x * 2;
   r.height = r.y * 2;
 
   return r;
}

Referenced by Capture(), and GetFullWindowRect().

Here is the caller graph for this function:

◆ GetDerivedParams()

void ScreenshotCommand::GetDerivedParams ( )

Definition at line 635 of file ScreenshotCommand.cpp.

{
      // Read the parameters that were passed in
   mFilePath    = mPath;
   mCaptureMode = mWhat;
 
   // Build a suitable filename
   mFileName = MakeFileName(mFilePath,
      kCaptureWhatStrings()[ mCaptureMode ].Translation() );
 
   if (mBack == kBlue)
   {
      mBackground = true;
      mBackColor = wxColour(51, 102, 153);
   }
   else if (mBack == kWhite)
   {
      mBackground = true;
      mBackColor = wxColour(255, 255, 255);
   }
   else
   {
      mBackground = false;
   }
 
}

References kBlue, kCaptureWhatStrings(), kWhite, MakeFileName(), mBack, mBackColor, mBackground, mCaptureMode, mFileName, mFilePath, mPath, and mWhat.

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDescription()

TranslatableString ScreenshotCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 74 of file ScreenshotCommand.h.

74{return XO("Takes screenshots.");};

XO

XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetFrontWindow()

wxTopLevelWindow * ScreenshotCommand::GetFrontWindow ( AudacityProject * project )

Definition at line 189 of file ScreenshotCommand.cpp.

{
   wxWindow *front = NULL;
   wxWindow *proj = wxGetTopLevelParent(FindProjectFrame(project));
 
   for (auto & win : wxTopLevelWindows)
   {
      win = wxGetTopLevelParent(win);
      if (win != mIgnore && win != proj  && win->IsShown()) {
         front = win;
         break;
      }
   }
 
   if (!front || !front->IsTopLevel()) {
      return (wxTopLevelWindow *)proj;
   }
 
   return (wxTopLevelWindow *)front;
}

References FindProjectFrame(), mIgnore, and project.

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFullWindowRect()

wxRect ScreenshotCommand::GetFullWindowRect ( wxTopLevelWindow * w )

private

Definition at line 671 of file ScreenshotCommand.cpp.

                                                              {
 
   wxRect r = w->GetRect();
   r.SetPosition(w->GetScreenPosition());
   r = w->GetScreenRect();
 
#if defined(__WXGTK__)
   // In wxGTK, we need to include decoration sizes
   r.width += (wxSystemSettings::GetMetric(wxSYS_BORDER_X, w) * 2);
   r.height += wxSystemSettings::GetMetric(wxSYS_CAPTION_Y, w) +
      wxSystemSettings::GetMetric(wxSYS_BORDER_Y, w);
#endif
   if (!mBackground && mCaptureMode == kwindowplus )
   {
      // background colour not selected but we want a background
      wxRect b = GetBackgroundRect();
      r.x = (r.x - b.x) >= 0 ? (r.x - b.x): 0;
      r.y = (r.y - b.y) >= 0 ? (r.y - b.y): 0;
      r.width += b.width;
      r.height += b.height;
   }
 
   return r;
}

References GetBackgroundRect(), kwindowplus, mBackground, and mCaptureMode.

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPanelRect()

wxRect ScreenshotCommand::GetPanelRect ( TrackPanel * panel )

private

Definition at line 703 of file ScreenshotCommand.cpp.

                                                        {
   //AdornedRulerPanel *ruler = panel->mRuler;
 
   int h = panel->GetRuler()->GetRulerHeight();
   int x = 0, y = -h;
   int width, height;
 
   panel->ClientToScreen(&x, &y);
   panel->GetParent()->ScreenToClient(&x, &y);
   panel->GetClientSize(&width, &height);
   return wxRect(x, y, width, height + h);
}

References TrackPanel::GetRuler(), and AdornedRulerPanel::GetRulerHeight().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRulerRect()

wxRect ScreenshotCommand::GetRulerRect ( AdornedRulerPanel * ruler )

private

Definition at line 716 of file ScreenshotCommand.cpp.

                                                              {
   int x = 0, y = 0;
   int width, height;
 
   ruler->ClientToScreen(&x, &y);
   ruler->GetParent()->ScreenToClient(&x, &y);
   ruler->GetClientSize(&width, &height);
   height = ruler->GetRulerHeight();
   return wxRect( x, y, width, height);
}

References anonymous_namespace{TimeTrackVRulerControls.cpp}::ruler().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScreenRect()

wxRect ScreenshotCommand::GetScreenRect ( )

private

Definition at line 696 of file ScreenshotCommand.cpp.

                                       {
   int width, height;
   wxDisplaySize(&width, &height);
 
   return wxRect( 0,0,width,height);
}

Referenced by Apply().

Here is the caller graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol ScreenshotCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 73 of file ScreenshotCommand.h.

73{return Symbol;};

ScreenshotCommand::Symbol

static const ComponentInterfaceSymbol Symbol

Definition: ScreenshotCommand.h:69

◆ GetTrackRect()

wxRect ScreenshotCommand::GetTrackRect	(	AudacityProject *	pProj,
		TrackPanel *	panel,
		int	n
	)

private

Definition at line 738 of file ScreenshotCommand.cpp.

                                                                                         {
   auto FindRectangle = []( TrackPanel &panel, Track &t )
   {
      wxRect rect = panel.FindFocusedTrackRect( &t );
 
      // Reposition it relative to parent of panel
      rect.SetPosition(
         panel.GetParent()->ScreenToClient(
            panel.ClientToScreen(
               rect.GetPosition())));
 
      return rect;
   };
 
   int count = 0;
   for (auto t : TrackList::Get( *pProj )) {
      count +=  1;
      if( count > n )
      {
         wxRect r =  FindRectangle( *panel, *t );
         return r;
      }
   }
   return wxRect( 0,0,0,0);
}

References TrackPanel::FindFocusedTrackRect(), and TrackList::Get().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTracksRect()

wxRect ScreenshotCommand::GetTracksRect ( TrackPanel * panel )

private

Definition at line 727 of file ScreenshotCommand.cpp.

                                                         {
   int x = 0, y = 0;
   int width, height;
 
   panel->ClientToScreen(&x, &y);
   panel->GetParent()->ScreenToClient(&x, &y);
   panel->GetClientSize(&width, &height);
 
   return wxRect( x, y, width, height);
}

Referenced by Apply().

Here is the caller graph for this function:

◆ GetWindowRect()

wxRect ScreenshotCommand::GetWindowRect ( wxTopLevelWindow * w )

private

Definition at line 662 of file ScreenshotCommand.cpp.

                                                          {
   int x = 0, y = 0;
   int width, height;
 
   w->ClientToScreen(&x, &y);
   w->GetClientSize(&width, &height);
   return wxRect( x,y,width,height);
}

Referenced by Apply().

Here is the caller graph for this function:

◆ kCaptureWhatStrings()

EnumValueSymbols ScreenshotCommand::kCaptureWhatStrings ( )

Definition at line 57 of file ScreenshotCommand.cpp.

{
   static EnumValueSymbol symbols[]{
      { XO("Window") },
      { wxT("FullWindow"), XO("Full Window") },
      { wxT("WindowPlus"), XO("Window Plus") },
      { XO("Fullscreen") },
      { XO("Toolbars") },
      { XO("Effects") },
      { XO("Scriptables") },
      { XO("Preferences") },
      { XO("Trackpanel") },
      { XO("Ruler") },
      { XO("Tracks") },
      { wxT("FirstTrack"),       XO("First Track") },
      { wxT("FirstTwoTracks"),   XO("First Two Tracks") },
      { wxT("FirstThreeTracks"), XO("First Three Tracks") },
      { wxT("FirstFourTracks"),  XO("First Four Tracks") },
      { wxT("SecondTrack"),      XO("Second Track") },
      { wxT("TracksPlus"),       XO("Tracks Plus") },
      { wxT("FirstTrackPlus"),   XO("First Track Plus") },
      { wxT("AllTracks"),        XO("All Tracks") },
      { wxT("AllTracksPlus"),    XO("All Tracks Plus") },
   };
 
   if (mSymbols.empty()) {
      // Compute the table of strings once
 
      // Some fixed choices
      copy(std::begin(symbols), std::end(symbols), back_inserter(mSymbols));
      auto nFixed = mSymbols.size();
 
      // Discover the set of toolbars -- don't hard-code it here
      /*
       There is no context passed in for a project.
       So this need to use the active project is unfortunate, but the set of
       toolbars and their identifying strings should not vary among projects
       */
      auto pProject = ::GetActiveProject().lock();
      if ( pProject ) {
         // Toolbars will be sorted by textual ID.
         // Macro programmers do use these English ids no matter what their
         // preferred language is.
         ToolManager::Get(*pProject).ForEach([&](ToolBar *pBar){
            mSymbols.emplace_back( pBar->GetSection(), pBar->GetLabel() );
         });
      }
   }
 
   return mSymbols;
};

References PackedArray::begin(), staffpad::vo::copy(), PackedArray::end(), ToolManager::ForEach(), ToolManager::Get(), GetActiveProject(), mSymbols, wxT(), and XO().

Referenced by Apply(), GetDerivedParams(), PopulateOrExchange(), VisitSettings(), and WindowFileName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeFileName()

wxString ScreenshotCommand::MakeFileName	(	const wxString &	path,
		const wxString &	basename
	)

private

Definition at line 612 of file ScreenshotCommand.cpp.

{
   // If the path is a full file name, then use it.
   if( path.EndsWith( ".png" ) )
      return path;
 
   // Otherwise make up a file name that has not been used already.
   wxFileName prefixPath;
   prefixPath.AssignDir(path);
   wxString prefix = prefixPath.GetPath
      (wxPATH_GET_VOLUME|wxPATH_GET_SEPARATOR);
 
   wxString filename;
   int i = 0;
   do {
      filename.Printf(wxT("%s%s%03d.png"),
                      prefix, basename, i);
      i++;
   } while (::wxFileExists(filename));
 
   return filename;
}

References wxT().

Referenced by GetDerivedParams(), and WindowFileName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ManualPage()

ManualPageID ScreenshotCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 81 of file ScreenshotCommand.h.

81{return L"Extra_Menu:_Scriptables_II#screenshot_short_format";}

◆ MayCapture()

bool ScreenshotCommand::MayCapture ( wxDialog * pDlg )

static

Definition at line 369 of file ScreenshotCommand.cpp.

{
   if( mIdleHandler == NULL )
      return false;
   pDlg->Bind( wxEVT_IDLE, mIdleHandler );
   mIdleHandler = NULL;
   pDlg->ShowModal();
   return true;
}

References mIdleHandler.

Referenced by ScreenshotCommand().

Here is the caller graph for this function:

◆ PopulateOrExchange()

void ScreenshotCommand::PopulateOrExchange ( ShuttleGui & S )

override

Definition at line 145 of file ScreenshotCommand.cpp.

{
   auto strings = kCaptureWhatStrings();
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieTextBox(  XXO("Path:"), mPath);
      S.TieChoice(   XXO("Capture What:"),
         mWhat, Msgids(strings.data(), strings.size()));
      S.TieChoice(   XXO("Background:"),
         mBack, Msgids(kBackgroundStrings, nBackgrounds));
      S.TieCheckBox( XXO("Bring To Top"), mbBringToTop);
   }
   S.EndMultiColumn();
}

References kBackgroundStrings, kCaptureWhatStrings(), mBack, mbBringToTop, mPath, Msgids(), mWhat, nBackgrounds, S, and XXO().

Here is the call graph for this function:

◆ SetIdleHandler()

void ScreenshotCommand::SetIdleHandler ( AudacityProject & project )

static

Definition at line 183 of file ScreenshotCommand.cpp.

{
   mIdleHandler = IdleHandler;
   pIdleHandlerProject = &project;
}

References IdleHandler(), mIdleHandler, pIdleHandlerProject, and project.

Referenced by CaptureCommands(), and CapturePreferences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitSettings() [1/3]

bool ScreenshotCommand::VisitSettings ( ConstSettingsVisitor & )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 142 of file ScreenshotCommand.cpp.

143 { return VisitSettings<true>(S); }

References S.

◆ VisitSettings() [2/3]

bool ScreenshotCommand::VisitSettings ( SettingsVisitor & )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 139 of file ScreenshotCommand.cpp.

140 { return VisitSettings<false>(S); }

References S.

◆ VisitSettings() [3/3]

template<bool Const>

bool ScreenshotCommand::VisitSettings ( SettingsVisitorBase< Const > & S )

Definition at line 130 of file ScreenshotCommand.cpp.

                                                                     {
   auto strings = kCaptureWhatStrings();
   S.Define(                               mPath,        wxT("Path"),         wxString{});
   S.DefineEnum(                           mWhat,        wxT("CaptureWhat"),  kwindow, strings.data(), strings.size() );
   S.DefineEnum(                           mBack,        wxT("Background"),   kNone, kBackgroundStrings, nBackgrounds );
   S.Define(                               mbBringToTop, wxT("ToTop"), true );
   return true;
};

References kBackgroundStrings, kCaptureWhatStrings(), kNone, kwindow, mBack, mbBringToTop, mPath, mWhat, nBackgrounds, S, and wxT().

Here is the call graph for this function:

◆ WindowFileName()

wxString ScreenshotCommand::WindowFileName	(	AudacityProject *	proj,
		wxTopLevelWindow *	w
	)

private

Definition at line 764 of file ScreenshotCommand.cpp.

                                                                                     {
   if (w != FindProjectFrame(proj) && !w->GetTitle().empty()) {
      mFileName = MakeFileName(mFilePath,
         kCaptureWhatStrings()[ mCaptureMode ].Translation() +
            (wxT("-") + w->GetTitle() + wxT("-")));
   }
   return mFileName;
}

References FindProjectFrame(), kCaptureWhatStrings(), MakeFileName(), mCaptureMode, mFileName, mFilePath, and wxT().

Referenced by Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ ScreenshotBigDialog

friend class ScreenshotBigDialog

friend

Definition at line 90 of file ScreenshotCommand.h.

Member Data Documentation

◆ bHasBackground

bool ScreenshotCommand::bHasBackground

private

Definition at line 88 of file ScreenshotCommand.h.

◆ bHasBringToTop

bool ScreenshotCommand::bHasBringToTop

private

Definition at line 89 of file ScreenshotCommand.h.

Referenced by Capture().

◆ mBack

int ScreenshotCommand::mBack

private

Definition at line 85 of file ScreenshotCommand.h.

Referenced by GetDerivedParams(), PopulateOrExchange(), and VisitSettings().

◆ mBackColor

wxColour ScreenshotCommand::mBackColor

private

Definition at line 104 of file ScreenshotCommand.h.

Referenced by Capture(), and GetDerivedParams().

◆ mBackground

bool ScreenshotCommand::mBackground

private

Definition at line 103 of file ScreenshotCommand.h.

Referenced by Capture(), GetDerivedParams(), and GetFullWindowRect().

◆ mbBringToTop

bool ScreenshotCommand::mbBringToTop

private

Definition at line 87 of file ScreenshotCommand.h.

Referenced by Capture(), PopulateOrExchange(), ScreenshotCommand(), and VisitSettings().

◆ mCaptureMode

int ScreenshotCommand::mCaptureMode

private

Definition at line 109 of file ScreenshotCommand.h.

Referenced by Apply(), GetDerivedParams(), GetFullWindowRect(), and WindowFileName().

◆ mDirToWriteTo

wxString ScreenshotCommand::mDirToWriteTo

private

Definition at line 105 of file ScreenshotCommand.h.

Referenced by CaptureCommands(), CapturePreferences(), and CaptureWindowOnIdle().

◆ mFileName

wxString ScreenshotCommand::mFileName

private

Definition at line 108 of file ScreenshotCommand.h.

Referenced by Apply(), CaptureCommands(), GetDerivedParams(), and WindowFileName().

◆ mFilePath

wxString ScreenshotCommand::mFilePath

private

Definition at line 107 of file ScreenshotCommand.h.

Referenced by GetDerivedParams(), and WindowFileName().

◆ mIdleHandler

void(* ScreenshotCommand::mIdleHandler)(wxIdleEvent &event) = NULL

static

Definition at line 137 of file ScreenshotCommand.h.

Referenced by MayCapture(), and SetIdleHandler().

◆ mIgnore

wxWindow* ScreenshotCommand::mIgnore

private

Definition at line 101 of file ScreenshotCommand.h.

Referenced by CaptureToolbar(), GetFrontWindow(), and ScreenshotCommand().

◆ mPath

wxString ScreenshotCommand::mPath

private

Definition at line 86 of file ScreenshotCommand.h.

Referenced by GetDerivedParams(), PopulateOrExchange(), and VisitSettings().

◆ mpShooter

ScreenshotCommand * ScreenshotCommand::mpShooter =NULL

static

Definition at line 136 of file ScreenshotCommand.h.

Referenced by CaptureCommands(), CapturePreferences(), and IdleHandler().

◆ mSymbols

EnumValueSymbols ScreenshotCommand::mSymbols

private

Definition at line 97 of file ScreenshotCommand.h.

Referenced by kCaptureWhatStrings().

◆ mWhat

int ScreenshotCommand::mWhat

private

Definition at line 84 of file ScreenshotCommand.h.

Referenced by GetDerivedParams(), PopulateOrExchange(), and VisitSettings().

◆ Symbol

const ComponentInterfaceSymbol ScreenshotCommand::Symbol { XO("Screenshot") }

static

Definition at line 69 of file ScreenshotCommand.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ kBackgrounds

◆ kCaptureTypes

Constructor & Destructor Documentation

◆ ScreenshotCommand()

Member Function Documentation

◆ Apply()

◆ Capture()

◆ CaptureCommands()

◆ CaptureDock()

◆ CaptureEffects()

◆ CapturePreferences()

◆ CaptureScriptables()

◆ CaptureToolbar()

◆ CaptureWindowOnIdle()

◆ GetBackgroundRect()

◆ GetDerivedParams()

◆ GetDescription()

◆ GetFrontWindow()

◆ GetFullWindowRect()

◆ GetPanelRect()

◆ GetRulerRect()

◆ GetScreenRect()

◆ GetSymbol()

◆ GetTrackRect()

◆ GetTracksRect()

◆ GetWindowRect()

◆ kCaptureWhatStrings()

◆ MakeFileName()

◆ ManualPage()

◆ MayCapture()

◆ PopulateOrExchange()

◆ SetIdleHandler()

◆ VisitSettings() [1/3]

◆ VisitSettings() [2/3]

◆ VisitSettings() [3/3]

◆ WindowFileName()

Friends And Related Function Documentation

◆ ScreenshotBigDialog

Member Data Documentation

◆ bHasBackground

◆ bHasBringToTop

◆ mBack

◆ mBackColor

◆ mBackground

◆ mbBringToTop

◆ mCaptureMode

◆ mDirToWriteTo

◆ mFileName

◆ mFilePath

◆ mIdleHandler

◆ mIgnore

◆ mPath

◆ mpShooter

◆ mSymbols

◆ mWhat

◆ Symbol