AudacityCommand Class Reference

Base class for command in Audacity. More...

#include <AudacityCommand.h>

Inheritance diagram for AudacityCommand:

Public Types
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }

Public Member Functions
	AudacityCommand ()
virtual	~AudacityCommand ()
wxString	GetPath () override
IdentInterfaceSymbol	GetVendor () override
wxString	GetVersion () override
IdentInterfaceSymbol	GetSymbol () override=0
virtual wxString	GetDescription () override
virtual wxString	ManualPage ()
virtual bool	IsBatchProcessing ()
virtual void	SetBatchProcessing (bool start)
virtual bool	Apply (const CommandContext &WXUNUSED(context))
virtual bool	Apply ()
bool	ShowInterface (wxWindow *parent, bool forceModal=false)
virtual void	SetHostUI (EffectUIHostInterface *WXUNUSED(host))
bool	PopulateUI (wxWindow *parent)
wxDialog *	CreateUI (wxWindow *parent, AudacityCommand *client)
virtual bool	GetAutomationParameters (wxString &parms)
virtual bool	SetAutomationParameters (const wxString &parms)
bool	DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)
int	MessageBox (const wxString &message, long style=DefaultMessageBoxStyle, const wxString &titleStr=wxString{})
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 ()
Public Member Functions inherited from CommandDefinitionInterface
virtual	~CommandDefinitionInterface ()
Public Member Functions inherited from IdentInterface
virtual	~IdentInterface ()
const wxString &	GetTranslatedName ()
Public Member Functions inherited from ParamsInterface
virtual	~ParamsInterface ()
virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Protected Attributes
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent
int	mUIResultID

Private Attributes
bool	mIsBatch
bool	mUIDebug
bool	mNeedsInit

Detailed Description

Base class for command in Audacity.

Definition at line 53 of file AudacityCommand.h.

Member Enumeration Documentation

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Definition at line 98 of file AudacityCommand.h.

: long { DefaultMessageBoxStyle = wxOK | wxCENTRE };

Constructor & Destructor Documentation

AudacityCommand::AudacityCommand

(

)

Definition at line 65 of file AudacityCommand.cpp.

References mIsBatch, mNeedsInit, mProgress, mUIDebug, mUIDialog, and mUIParent.

{
   mProgress = NULL;
   mUIParent = NULL;
   mUIDialog = NULL;
   mUIDebug = false;
   mIsBatch = false;
   mNeedsInit = true;
}

AudacityCommand::~AudacityCommand ( )

virtual

Definition at line 75 of file AudacityCommand.cpp.

References mUIDialog.

{
   if (mUIDialog)
      mUIDialog->Close();
}

Member Function Documentation

virtual bool AudacityCommand::Apply ( const CommandContext &  WXUNUSEDcontext )

inlinevirtual

Definition at line 81 of file AudacityCommand.h.

Referenced by EffectUIHost::OnApply().

{return false;}; 

bool AudacityCommand::Apply ( )

virtual

Reimplemented in CompareAudioCommand.

Definition at line 87 of file AudacityCommand.cpp.

References GetActiveProject().

Referenced by DoAudacityCommand().

                            { 
   AudacityProject * pProj = GetActiveProject();
   const CommandContext context( *pProj );
   return Apply( context );
};

virtual bool AudacityCommand::CheckWhetherSkipAudacityCommand ( )

inlinevirtual

Definition at line 127 of file AudacityCommand.h.

Referenced by DoAudacityCommand().

{ return false; }

wxDialog * AudacityCommand::CreateUI	(	wxWindow *	parent,
		AudacityCommand *	client
	)

Definition at line 129 of file AudacityCommand.cpp.

References IdentInterface::GetTranslatedName(), and safenew.

Referenced by ShowInterface().

{
   Destroy_ptr<AudacityCommandDialog> dlg { safenew AudacityCommandDialog{
      parent, GetTranslatedName(), this}};

   if (dlg->Init())
   {
      // release() is safe because parent will own it
      return dlg.release();
   }
   return NULL;
}

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

Definition at line 188 of file AudacityCommand.cpp.

References _(), Apply(), CheckWhetherSkipAudacityCommand(), End(), IdentInterface::GetTranslatedName(), Init(), mProgress, name, pdlgHideStopButton, PromptUser(), and valueRestorer().

Referenced by EffectManager::DoAudacityCommand().

{
   // Note: Init may read parameters from preferences
   if (!Init())
   {
      return false;
   }

   // Prompting will be bypassed when applying a command that has already 
   // been configured, e.g. repeating the last effect on a different selection.
   // Prompting may call AudacityCommand::Preview
   if (shouldPrompt && /*IsInteractive() && */!PromptUser(parent))
   {
      return false;
   }

   auto cleanup = finally( [&] {
      End();
   } );

   bool returnVal = true;
   bool skipFlag = CheckWhetherSkipAudacityCommand();
   if (skipFlag == false)
   {
      auto name = GetTranslatedName();
      ProgressDialog progress{
         name,
         wxString::Format(_("Applying %s..."), name),
         pdlgHideStopButton
      };
      auto vr = valueRestorer( mProgress, &progress );

      returnVal = Apply(context);
   }
   return returnVal;
}

virtual void AudacityCommand::End ( )

inlinevirtual

Definition at line 132 of file AudacityCommand.h.

Referenced by DoAudacityCommand().

{;};

bool AudacityCommand::GetAutomationParameters ( wxString &  parms )

virtual

Definition at line 142 of file AudacityCommand.cpp.

References ParamsInterface::DefineParams(), CommandParameters::GetParameters(), ShuttleParams::mpEap, mUIDialog, and TransferDataFromWindow().

Referenced by EffectManager::GetEffectParameters(), and EffectUIHost::OnApply().

{
   CommandParameters eap;

   if (mUIDialog && !TransferDataFromWindow())
   {
      return false;
   }

   ShuttleGetAutomation S;
   S.mpEap = &eap;
   bool bResult = DefineParams( S );
   wxASSERT_MSG( bResult, "You did not define DefineParameters() for this command" );
   static_cast<void>(bResult); // fix unused variable warning in release mode

   return eap.GetParameters(parms);
}

virtual wxString AudacityCommand::GetDescription ( )

inlineoverridevirtual

Implements IdentInterface.

Reimplemented in SetTrackCommand, SetTrackVisualsCommand, SelectCommand, ScreenshotCommand, SelectTracksCommand, SetTrackAudioCommand, SelectFrequenciesCommand, SetPreferenceCommand, SetTrackStatusCommand, ExportCommand, SaveProjectCommand, SelectTimeCommand, GetPreferenceCommand, GetInfoCommand, MessageCommand, CompareAudioCommand, HelpCommand, ImportCommand, OpenProjectCommand, SetClipCommand, SetEnvelopeCommand, SetProjectCommand, DemoCommand, DragCommand, GetTrackInfoCommand, and SetLabelCommand.

Definition at line 73 of file AudacityCommand.h.

Referenced by EffectManager::GetCommandTip().

   {wxFAIL_MSG( "Implement a Description for this command");return "FAIL";};

wxString AudacityCommand::GetPath ( )

overridevirtual

Implements IdentInterface.

Definition at line 82 of file AudacityCommand.cpp.

References BUILTIN_GENERIC_COMMAND_PREFIX, GetSymbol(), and IdentInterfaceSymbol::Internal().

{        return BUILTIN_GENERIC_COMMAND_PREFIX + GetSymbol().Internal(); }

IdentInterfaceSymbol AudacityCommand::GetSymbol ( )

overridepure virtual

Implements IdentInterface.

Implemented in SetTrackCommand, SetTrackVisualsCommand, SelectCommand, ScreenshotCommand, SelectTracksCommand, SetTrackAudioCommand, SelectFrequenciesCommand, SetPreferenceCommand, SetTrackStatusCommand, OldStyleCommandType, ExportCommand, SaveProjectCommand, SelectTimeCommand, GetPreferenceCommand, GetInfoCommand, MessageCommand, CompareAudioCommand, HelpCommand, ImportCommand, OpenProjectCommand, SetClipCommand, SetEnvelopeCommand, SetProjectCommand, DemoCommand, DragCommand, GetTrackInfoCommand, and SetLabelCommand.

Referenced by _(), and GetPath().

IdentInterfaceSymbol AudacityCommand::GetVendor ( )

overridevirtual

Implements IdentInterface.

Definition at line 83 of file AudacityCommand.cpp.

References XO.

{      return XO("Audacity");}

wxString AudacityCommand::GetVersion ( )

overridevirtual

Implements IdentInterface.

Definition at line 84 of file AudacityCommand.cpp.

References AUDACITY_VERSION_STRING.

{     return AUDACITY_VERSION_STRING;}

bool AudacityCommand::Init ( )

virtual

Definition at line 93 of file AudacityCommand.cpp.

References ParamsInterface::DefineParams(), and mNeedsInit.

Referenced by DoAudacityCommand(), EffectManager::GetAudacityCommand(), and EffectManager::SetEffectParameters().

                          {
   if( !mNeedsInit )
      return true;
   mNeedsInit = false;
   ShuttleDefaults DefaultSettingShuttle;
   return DefineParams( DefaultSettingShuttle );
}

virtual bool AudacityCommand::IsBatchProcessing ( )

inlinevirtual

Definition at line 78 of file AudacityCommand.h.

Referenced by EffectUIHost::Initialize(), and PromptUser().

{ return mIsBatch;}

virtual wxString AudacityCommand::ManualPage ( )

inlinevirtual

Reimplemented in SetTrackCommand, SelectCommand, SetTrackVisualsCommand, ScreenshotCommand, SelectTracksCommand, SetTrackAudioCommand, SelectFrequenciesCommand, SetPreferenceCommand, SetTrackStatusCommand, ExportCommand, SaveProjectCommand, SelectTimeCommand, GetPreferenceCommand, GetInfoCommand, MessageCommand, CompareAudioCommand, HelpCommand, ImportCommand, OpenProjectCommand, DemoCommand, SetClipCommand, SetEnvelopeCommand, SetProjectCommand, DragCommand, GetTrackInfoCommand, and SetLabelCommand.

Definition at line 77 of file AudacityCommand.h.

Referenced by EffectManager::GetCommandUrl(), and AudacityCommandDialog::OnHelp().

{ return wxEmptyString;};

int AudacityCommand::MessageBox	(	const wxString &	message,
		long	style = DefaultMessageBoxStyle,
		const wxString &	titleStr = wxString{}
	)

Definition at line 247 of file AudacityCommand.cpp.

References _(), AudacityMessageBox(), IdentInterface::GetTranslatedName(), and mUIParent.

Referenced by SetAutomationParameters().

{
   wxString title;
   if (titleStr.empty())
      title = GetTranslatedName();
   else
      title = wxString::Format(_("%s: %s"), GetTranslatedName(), titleStr);
   return AudacityMessageBox(message, title, style, mUIParent);
}

virtual void AudacityCommand::PopulateOrExchange ( ShuttleGui &  WXUNUSEDS )

inlinevirtual

Definition at line 133 of file AudacityCommand.h.

Referenced by _(), and AudacityCommandDialog::PopulateOrExchange().

{return;};

bool AudacityCommand::PopulateUI

(

wxWindow *

parent

)

bool AudacityCommand::PromptUser ( wxWindow *  parent )

virtual

Definition at line 228 of file AudacityCommand.cpp.

References IsBatchProcessing(), and ShowInterface().

Referenced by DoAudacityCommand(), and EffectManager::PromptUser().

{
   return ShowInterface(parent, IsBatchProcessing());
}

bool AudacityCommand::SetAutomationParameters ( const wxString &  parms )

virtual

Definition at line 160 of file AudacityCommand.cpp.

References _(), ShuttleSetAutomation::bOK, ParamsInterface::DefineParams(), IdentInterface::GetTranslatedName(), MessageBox(), ShuttleSetAutomation::SetForWriting(), and TransferDataToWindow().

Referenced by EffectManager::SetEffectParameters().

{
   wxString preset = parms;

   CommandParameters eap(parms);
   ShuttleSetAutomation S;

   S.SetForWriting( &eap );
   bool bResult = DefineParams( S );
   wxASSERT_MSG( bResult, "You did not define DefineParameters() for this command" );
   static_cast<void>(bResult); // fix unused variable warning in release mode
   if (!S.bOK)
   {
      AudacityCommand::MessageBox(
         wxString::Format(
            _("%s: Could not load settings below. Default settings will be used.\n\n%s"),
            GetTranslatedName(),
            preset
         )
      );

      // fror now always succeed, so that we can prompt the user.
      return true;
   }

   return TransferDataToWindow();
}

virtual void AudacityCommand::SetBatchProcessing ( bool  start )

inlinevirtual

Definition at line 79 of file AudacityCommand.h.

Referenced by EffectManager::SetBatchProcessing().

{ mIsBatch = start;};

virtual void AudacityCommand::SetHostUI ( EffectUIHostInterface *  WXUNUSEDhost )

inlinevirtual

Definition at line 85 of file AudacityCommand.h.

{;};

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

Definition at line 101 of file AudacityCommand.cpp.

References CreateUI(), ScreenshotCommand::MayCapture(), mUIDialog, and valueRestorer().

Referenced by PromptUser().

{
   if (mUIDialog)
   {
      if ( mUIDialog->Close(true) )
         mUIDialog = nullptr;
      return false;
   }

   // mUIDialog is null
   auto cleanup = valueRestorer( mUIDialog );
   
   mUIDialog = CreateUI(parent, this);
   if (!mUIDialog)
      return false;

   mUIDialog->Layout();
   mUIDialog->Fit();
   mUIDialog->SetMinSize(mUIDialog->GetSize());

   // The Screenshot command might be popping this dialog up, just to capture it.
   if( ScreenshotCommand::MayCapture( mUIDialog ) )
      return false;

   bool res = mUIDialog->ShowModal() != 0;
   return res;
}

bool AudacityCommand::TransferDataFromWindow ( )

virtual

Definition at line 240 of file AudacityCommand.cpp.

References mUIParent.

Referenced by GetAutomationParameters(), and EffectUIHost::TransferDataFromWindow().

{
   if (mUIParent && (!mUIParent->Validate() || !mUIParent->TransferDataFromWindow()))
      return false;
   return true;
}

bool AudacityCommand::TransferDataToWindow ( )

virtual

Definition at line 233 of file AudacityCommand.cpp.

References mUIParent.

Referenced by SetAutomationParameters(), and EffectUIHost::TransferDataToWindow().

{
   if (mUIParent && !mUIParent->TransferDataToWindow())
      return false;
   return true;
}

Member Data Documentation

bool AudacityCommand::mIsBatch

private

Definition at line 146 of file AudacityCommand.h.

Referenced by AudacityCommand().

bool AudacityCommand::mNeedsInit

private

Definition at line 148 of file AudacityCommand.h.

Referenced by AudacityCommand(), and Init().

ProgressDialog* AudacityCommand::mProgress

protected

Definition at line 139 of file AudacityCommand.h.

Referenced by AudacityCommand(), and DoAudacityCommand().

bool AudacityCommand::mUIDebug

private

Definition at line 147 of file AudacityCommand.h.

Referenced by AudacityCommand().

wxDialog* AudacityCommand::mUIDialog

protected

Definition at line 141 of file AudacityCommand.h.

Referenced by AudacityCommand(), GetAutomationParameters(), ShowInterface(), and ~AudacityCommand().

wxWindow* AudacityCommand::mUIParent

protected

Definition at line 142 of file AudacityCommand.h.

Referenced by AudacityCommand(), MessageBox(), TransferDataFromWindow(), and TransferDataToWindow().

int AudacityCommand::mUIResultID

protected

Definition at line 143 of file AudacityCommand.h.

---

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

• AudacityCommand.h
• AudacityCommand.cpp