AudacityCommand Class Reference

Base class for command in Audacity. More...

#include <AudacityCommand.h>

Inheritance diagram for AudacityCommand:

Collaboration diagram for AudacityCommand:

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

Public Member Functions
	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

Protected Attributes
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent

Private Attributes
bool	mIsBatch
bool	mNeedsInit

Detailed Description

Base class for command in Audacity.

Definition at line 39 of file AudacityCommand.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Definition at line 81 of file AudacityCommand.h.

: long { DefaultMessageBoxStyle = wxOK | wxCENTRE };

Constructor & Destructor Documentation

AudacityCommand()

AudacityCommand::AudacityCommand

(

)

Definition at line 50 of file AudacityCommand.cpp.

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

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

~AudacityCommand()

AudacityCommand::~AudacityCommand ( )

virtual

Definition at line 59 of file AudacityCommand.cpp.

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

References mUIDialog.

Member Function Documentation

Apply()

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

inlinevirtual

Definition at line 67 of file AudacityCommand.h.

{ return false; }

Referenced by DoAudacityCommand().

Here is the caller graph for this function:

CheckWhetherSkipAudacityCommand()

virtual bool AudacityCommand::CheckWhetherSkipAudacityCommand ( )

inlinevirtual

Definition at line 110 of file AudacityCommand.h.

{ return false; }

Referenced by DoAudacityCommand().

Here is the caller graph for this function:

CreateUI()

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

Definition at line 107 of file AudacityCommand.cpp.

{
   Destroy_ptr<AudacityCommandDialog> dlg { safenew AudacityCommandDialog{
      parent, GetName(), this}};
 
   if (dlg->Init())
   {
      // release() is safe because parent will own it
      return dlg.release();
   }
   return NULL;
}

References ComponentInterface::GetName(), and safenew.

Referenced by ShowInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAudacityCommand()

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

Definition at line 163 of file AudacityCommand.cpp.

{
   // 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 = GetName();
      ProgressDialog progress{
         name,
         XO("Applying %s...").Format( name ),
         pdlgHideStopButton
      };
      auto vr = valueRestorer( mProgress, &progress );
 
      returnVal = Apply(context);
   }
   return returnVal;
}

References Apply(), CheckWhetherSkipAudacityCommand(), End(), ComponentInterface::GetName(), Init(), mProgress, name, pdlgHideStopButton, PromptUser(), valueRestorer(), and XO.

Referenced by EffectManager::DoAudacityCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

End()

virtual void AudacityCommand::End ( )

inlinevirtual

Definition at line 115 of file AudacityCommand.h.

{;};

Referenced by DoAudacityCommand().

Here is the caller graph for this function:

GetDescription()

virtual TranslatableString AudacityCommand::GetDescription ( ) const

inlineoverridevirtual

Implements ComponentInterface.

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

Definition at line 59 of file AudacityCommand.h.

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

References XO.

Referenced by EffectManager::GetCommandTip().

Here is the caller graph for this function:

GetPath()

PluginPath AudacityCommand::GetPath ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 66 of file AudacityCommand.cpp.

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

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

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol AudacityCommand::GetSymbol ( ) const

overridepure virtual

Implements ComponentInterface.

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

Referenced by GetPath().

Here is the caller graph for this function:

GetVendor()

VendorSymbol AudacityCommand::GetVendor ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 67 of file AudacityCommand.cpp.

{      return XO("Audacity");}

References XO.

GetVersion()

wxString AudacityCommand::GetVersion ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 68 of file AudacityCommand.cpp.

{     return AUDACITY_VERSION_STRING;}

Init()

bool AudacityCommand::Init ( )

virtual

Definition at line 71 of file AudacityCommand.cpp.

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

References mNeedsInit, and VisitSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

IsBatchProcessing()

virtual bool AudacityCommand::IsBatchProcessing ( ) const

inlinevirtual

Definition at line 64 of file AudacityCommand.h.

{ return mIsBatch; }

Referenced by PromptUser().

Here is the caller graph for this function:

LoadSettingsFromString()

bool AudacityCommand::LoadSettingsFromString

(

const wxString &

parms

)

Definition at line 138 of file AudacityCommand.cpp.

{
   wxString preset = parms;
 
   CommandParameters eap(parms);
   ShuttleSetAutomation S;
 
   S.SetForWriting( &eap );
   bool bResult = VisitSettings( 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(
         XO(
"%s: Could not load settings below. Default settings will be used.\n\n%s")
            .Format( GetName(), preset ) );
 
      // fror now always succeed, so that we can prompt the user.
      return true;
   }
 
   return TransferDataToWindow();
}

References ComponentInterface::GetName(), MessageBox(), preset, S, TransferDataToWindow(), VisitSettings(), and XO.

Referenced by EffectManager::SetEffectParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

ManualPage()

virtual ManualPageID AudacityCommand::ManualPage ( )

inlinevirtual

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

Definition at line 63 of file AudacityCommand.h.

{ return {}; }

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

Here is the caller graph for this function:

MessageBox()

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

Definition at line 232 of file AudacityCommand.cpp.

{
   auto title = titleStr.empty()
      ? GetName()
      : XO("%s: %s").Format( GetName(), titleStr );
   return AudacityMessageBox(message, title, style, mUIParent);
}

References AudacityMessageBox(), TranslatableString::empty(), ComponentInterface::GetName(), mUIParent, title, and XO.

Referenced by LoadSettingsFromString().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

virtual void AudacityCommand::PopulateOrExchange ( ShuttleGui &  WXUNUSEDS )

inlinevirtual

Definition at line 116 of file AudacityCommand.h.

{return;};

Referenced by AudacityCommandDialog::PopulateOrExchange().

Here is the caller graph for this function:

PromptUser()

bool AudacityCommand::PromptUser ( wxWindow *  parent )

virtual

Reimplemented in ClearLogCommand.

Definition at line 203 of file AudacityCommand.cpp.

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

References IsBatchProcessing(), and ShowInterface().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SaveSettingsAsString()

bool AudacityCommand::SaveSettingsAsString

(

wxString &

parms

)

Definition at line 120 of file AudacityCommand.cpp.

{
   CommandParameters eap;
 
   if (mUIDialog && !TransferDataFromWindow())
   {
      return false;
   }
 
   ShuttleGetAutomation S;
   S.mpEap = &eap;
   bool bResult = VisitSettings( 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);
}

References CommandParameters::GetParameters(), mUIDialog, S, TransferDataFromWindow(), and VisitSettings().

Referenced by EffectManager::GetEffectParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

SetBatchProcessing()

virtual void AudacityCommand::SetBatchProcessing ( bool  start )

inlinevirtual

Definition at line 65 of file AudacityCommand.h.

{ mIsBatch = start; }

ShowInterface()

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

Definition at line 79 of file AudacityCommand.cpp.

{
   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 ( VetoDialogHook::Call( mUIDialog ) )
      return false;
 
   bool res = mUIDialog->ShowModal() != 0;
   return res;
}

References GlobalHook< VetoDialogHook, bool(wxDialog *) >::Call(), CreateUI(), mUIDialog, and valueRestorer().

Referenced by PromptUser().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataFromWindow()

bool AudacityCommand::TransferDataFromWindow ( )

virtual

Definition at line 215 of file AudacityCommand.cpp.

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

References mUIParent.

Referenced by SaveSettingsAsString().

Here is the caller graph for this function:

TransferDataToWindow()

bool AudacityCommand::TransferDataToWindow ( )

virtual

Definition at line 208 of file AudacityCommand.cpp.

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

References mUIParent.

Referenced by LoadSettingsFromString().

Here is the caller graph for this function:

VisitSettings() [1/2]

bool AudacityCommand::VisitSettings ( ConstSettingsVisitor &  )

virtual

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

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

Definition at line 227 of file AudacityCommand.cpp.

{
   return false;
}

VisitSettings() [2/2]

bool AudacityCommand::VisitSettings ( SettingsVisitor &  )

virtual

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

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

Definition at line 222 of file AudacityCommand.cpp.

{
   return false;
}

Referenced by EffectManager::GetCommandDefinition(), Init(), LoadSettingsFromString(), and SaveSettingsAsString().

Here is the caller graph for this function:

Member Data Documentation

mIsBatch

bool AudacityCommand::mIsBatch

private

Definition at line 135 of file AudacityCommand.h.

Referenced by AudacityCommand().

mNeedsInit

bool AudacityCommand::mNeedsInit

private

Definition at line 136 of file AudacityCommand.h.

Referenced by AudacityCommand(), and Init().

mProgress

ProgressDialog* AudacityCommand::mProgress

protected

Definition at line 129 of file AudacityCommand.h.

Referenced by AudacityCommand(), and DoAudacityCommand().

mUIDialog

wxDialog* AudacityCommand::mUIDialog

protected

Definition at line 131 of file AudacityCommand.h.

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

mUIParent

wxWindow* AudacityCommand::mUIParent

protected

Definition at line 132 of file AudacityCommand.h.

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

---

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

• AudacityCommand.h
• AudacityCommand.cpp