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 }
using	VetoDialogHook = bool(*)(wxDialog *)

Public Member Functions
	AudacityCommand ()
virtual	~AudacityCommand ()
PluginPath	GetPath () override
VendorSymbol	GetVendor () override
wxString	GetVersion () override
ComponentInterfaceSymbol	GetSymbol () override=0
virtual TranslatableString	GetDescription () override
virtual wxString	ManualPage ()
virtual bool	IsBatchProcessing ()
virtual void	SetBatchProcessing (bool start)
virtual bool	Apply (const CommandContext &WXUNUSED(context))
bool	ShowInterface (wxWindow *parent, bool forceModal=false)
virtual void	SetHostUI (EffectUIHostInterface *WXUNUSED(host))
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 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 ()
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
TranslatableString	GetName ()
virtual bool	DefineParams (ShuttleParams &WXUNUSED(S))

Static Public Member Functions
static VetoDialogHook	SetVetoDialogHook (VetoDialogHook hook)

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 39 of file AudacityCommand.h.

Member Typedef Documentation

VetoDialogHook

using AudacityCommand::VetoDialogHook = bool (*) ( wxDialog* )

Definition at line 51 of file AudacityCommand.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : long

Enumerator
DefaultMessageBoxStyle

Definition at line 87 of file AudacityCommand.h.

: long { DefaultMessageBoxStyle = wxOK | wxCENTRE };

Constructor & Destructor Documentation

AudacityCommand()

AudacityCommand::AudacityCommand

(

)

Definition at line 67 of file AudacityCommand.cpp.

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

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

~AudacityCommand()

AudacityCommand::~AudacityCommand ( )

virtual

Definition at line 77 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 72 of file AudacityCommand.h.

{return false;};

Referenced by DoAudacityCommand(), and EffectUIHost::OnApply().

Here is the caller graph for this function:

CheckWhetherSkipAudacityCommand()

virtual bool AudacityCommand::CheckWhetherSkipAudacityCommand ( )

inlinevirtual

Definition at line 116 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 126 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 182 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 121 of file AudacityCommand.h.

{;};

Referenced by DoAudacityCommand().

Here is the caller graph for this function:

GetAutomationParameters()

bool AudacityCommand::GetAutomationParameters ( wxString &  parms )

virtual

Definition at line 139 of file AudacityCommand.cpp.

{
   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);
}

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

virtual TranslatableString AudacityCommand::GetDescription ( )

inlineoverridevirtual

Implements ComponentInterface.

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

Definition at line 64 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 ( )

overridevirtual

Implements ComponentInterface.

Definition at line 84 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 ( )

overridepure virtual

Implements ComponentInterface.

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

Referenced by GetPath().

Here is the caller graph for this function:

GetVendor()

VendorSymbol AudacityCommand::GetVendor ( )

overridevirtual

Implements ComponentInterface.

Definition at line 85 of file AudacityCommand.cpp.

{      return XO("Audacity");}

References XO.

GetVersion()

wxString AudacityCommand::GetVersion ( )

overridevirtual

Implements ComponentInterface.

Definition at line 86 of file AudacityCommand.cpp.

{     return AUDACITY_VERSION_STRING;}

Init()

bool AudacityCommand::Init ( )

virtual

Definition at line 89 of file AudacityCommand.cpp.

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

References ComponentInterface::DefineParams(), and mNeedsInit.

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 ( )

inlinevirtual

Definition at line 69 of file AudacityCommand.h.

{ return mIsBatch;}

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

Here is the caller graph for this function:

ManualPage()

virtual wxString AudacityCommand::ManualPage ( )

inlinevirtual

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

Definition at line 68 of file AudacityCommand.h.

{ return wxEmptyString;};

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 241 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, and XO.

Referenced by SetAutomationParameters().

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 122 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 222 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:

SetAutomationParameters()

bool AudacityCommand::SetAutomationParameters ( const wxString &  parms )

virtual

Definition at line 157 of file AudacityCommand.cpp.

{
   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(
         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 ShuttleSetAutomation::bOK, ComponentInterface::DefineParams(), ComponentInterface::GetName(), MessageBox(), ShuttleSetAutomation::SetForWriting(), TransferDataToWindow(), and XO.

Referenced by EffectManager::SetEffectParameters().

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 70 of file AudacityCommand.h.

{ mIsBatch = start;};

Referenced by EffectManager::SetBatchProcessing().

Here is the caller graph for this function:

SetHostUI()

virtual void AudacityCommand::SetHostUI ( EffectUIHostInterface *  WXUNUSEDhost )

inlinevirtual

Definition at line 75 of file AudacityCommand.h.

{;};

SetVetoDialogHook()

auto AudacityCommand::SetVetoDialogHook ( VetoDialogHook  hook )

static

Definition at line 58 of file AudacityCommand.cpp.

{
   auto &theHook = GetVetoDialogHook();
   auto result = theHook;
   theHook = hook;
   return result;
}

References anonymous_namespace{AudacityCommand.cpp}::GetVetoDialogHook().

Referenced by ScreenshotCommand::ScreenshotCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowInterface()

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

Definition at line 97 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.
   auto hook = GetVetoDialogHook();
   if( hook && hook( mUIDialog ) )
      return false;
 
   bool res = mUIDialog->ShowModal() != 0;
   return res;
}

References CreateUI(), anonymous_namespace{AudacityCommand.cpp}::GetVetoDialogHook(), 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 234 of file AudacityCommand.cpp.

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

References mUIParent.

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

Here is the caller graph for this function:

TransferDataToWindow()

bool AudacityCommand::TransferDataToWindow ( )

virtual

Definition at line 227 of file AudacityCommand.cpp.

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

References mUIParent.

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

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 137 of file AudacityCommand.h.

Referenced by AudacityCommand(), and Init().

mProgress

ProgressDialog* AudacityCommand::mProgress

protected

Definition at line 128 of file AudacityCommand.h.

Referenced by AudacityCommand(), and DoAudacityCommand().

mUIDebug

bool AudacityCommand::mUIDebug

private

Definition at line 136 of file AudacityCommand.h.

Referenced by AudacityCommand().

mUIDialog

wxDialog* AudacityCommand::mUIDialog

protected

Definition at line 130 of file AudacityCommand.h.

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

mUIParent

wxWindow* AudacityCommand::mUIParent

protected

Definition at line 131 of file AudacityCommand.h.

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

mUIResultID

int AudacityCommand::mUIResultID

protected

Definition at line 132 of file AudacityCommand.h.

---

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

• AudacityCommand.h
• AudacityCommand.cpp