The <something>CommandType classes are classes which are going away. They all provided a BuildSignature (what parameters they accept) and Name, but that is now replaced by the AudacityCommand interface.
More...

#include <BatchEvalCommand.h>

Inheritance diagram for BatchEvalCommandType:

[legend]

Collaboration diagram for BatchEvalCommandType:

[legend]

Public Member Functions
ComponentInterfaceSymbol	BuildName () const override

void	BuildSignature (CommandSignature &signature) override
	Postcondition: signature is a 'signature' map containing parameter. More...

OldStyleCommandPointer	Create (AudacityProject &project, std::unique_ptr< CommandOutputTargets > &&target) override

Public Member Functions inherited from OldStyleCommandType
	OldStyleCommandType ()

virtual	~OldStyleCommandType ()

ComponentInterfaceSymbol	GetSymbol () const override

CommandSignature &	GetSignature ()

wxString	Describe ()

virtual ComponentInterfaceSymbol	BuildName () const =0

virtual void	BuildSignature (CommandSignature &signature)=0
	Postcondition: signature is a 'signature' map containing parameter. More...

virtual OldStyleCommandPointer	Create (AudacityProject &project, std::unique_ptr< CommandOutputTargets > &&target)=0

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 (const CommandContext &context, bool shouldPrompt=true)

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

virtual bool	Init ()

virtual bool	PromptUser (AudacityProject &)

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

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

Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress

wxDialog *	mUIDialog

wxWindow *	mUIParent

Detailed Description

The <something>CommandType classes are classes which are going away. They all provided a BuildSignature (what parameters they accept) and Name, but that is now replaced by the AudacityCommand interface.

We in effect merge the <something>CommandType classes into the <something>Command classes.

Definition at line 31 of file BatchEvalCommand.h.

Member Function Documentation

◆ BuildName()

ComponentInterfaceSymbol BatchEvalCommandType::BuildName ( ) const

overridevirtual

Implements OldStyleCommandType.

Definition at line 27 of file BatchEvalCommand.cpp.

{
   return { wxT("BatchCommand"), XO("Batch Command") };
}

References wxT(), and XO().

Here is the call graph for this function:

◆ BuildSignature()

void BatchEvalCommandType::BuildSignature ( CommandSignature & signature )

overridevirtual

Postcondition: signature is a 'signature' map containing parameter.

Implements OldStyleCommandType.

Definition at line 32 of file BatchEvalCommand.cpp.

{
   auto commandNameValidator = std::make_unique<DefaultValidator>();
   signature.AddParameter(wxT("CommandName"), wxT(""), std::move(commandNameValidator));
   auto paramValidator = std::make_unique<DefaultValidator>();
   signature.AddParameter(wxT("ParamString"), wxT(""), std::move(paramValidator));
   auto macroValidator = std::make_unique<DefaultValidator>();
   signature.AddParameter(wxT("MacroName"), wxT(""), std::move(macroValidator));
}

References CommandSignature::AddParameter(), and wxT().

Here is the call graph for this function:

◆ Create()

OldStyleCommandPointer BatchEvalCommandType::Create	(	AudacityProject &	project,
		std::unique_ptr< CommandOutputTargets > &&	target
	)

overridevirtual

Implements OldStyleCommandType.

Definition at line 42 of file BatchEvalCommand.cpp.

{
   return std::make_shared<BatchEvalCommand>(project, *this);
}

References project.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BuildName()

◆ BuildSignature()

◆ Create()