Audacity  2.2.2
Public Member Functions | List of all members
BatchEvalCommandType Class Referencefinal

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:
OldStyleCommandType AudacityCommand CommandDefinitionInterface IdentInterface ParamsInterface

Public Member Functions

IdentInterfaceSymbol BuildName () override
 
void BuildSignature (CommandSignature &signature) override
 Postcondition: signature is a 'signature' map containing parameter. More...
 
OldStyleCommandPointer Create (std::unique_ptr< CommandOutputTargets > &&target) override
 
- Public Member Functions inherited from OldStyleCommandType
 OldStyleCommandType ()
 
virtual ~OldStyleCommandType ()
 
IdentInterfaceSymbol GetSymbol () override
 
CommandSignatureGetSignature ()
 
wxString Describe ()
 
- Public Member Functions inherited from AudacityCommand
 AudacityCommand ()
 
virtual ~AudacityCommand ()
 
wxString GetPath () override
 
IdentInterfaceSymbol GetVendor () override
 
wxString GetVersion () override
 
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))
 

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Protected Attributes inherited from AudacityCommand
ProgressDialogmProgress
 
wxDialog * mUIDialog
 
wxWindow * mUIParent
 
int mUIResultID
 

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 29 of file BatchEvalCommand.h.

Member Function Documentation

IdentInterfaceSymbol BatchEvalCommandType::BuildName ( )
overridevirtual

Implements OldStyleCommandType.

Definition at line 20 of file BatchEvalCommand.cpp.

References XO.

21 {
22  return { wxT("BatchCommand"), XO("Batch Command") };
23 }
#define XO(s)
Definition: Internat.h:33
void BatchEvalCommandType::BuildSignature ( CommandSignature signature)
overridevirtual

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

Implements OldStyleCommandType.

Definition at line 25 of file BatchEvalCommand.cpp.

References CommandSignature::AddParameter().

26 {
27  auto commandNameValidator = std::make_unique<DefaultValidator>();
28  signature.AddParameter(wxT("CommandName"), wxT(""), std::move(commandNameValidator));
29  auto paramValidator = std::make_unique<DefaultValidator>();
30  signature.AddParameter(wxT("ParamString"), wxT(""), std::move(paramValidator));
31  auto macroValidator = std::make_unique<DefaultValidator>();
32  signature.AddParameter(wxT("MacroName"), wxT(""), std::move(macroValidator));
33 }
void AddParameter(const wxString &name, const wxVariant &dft, std::unique_ptr< Validator > &&valid)
OldStyleCommandPointer BatchEvalCommandType::Create ( std::unique_ptr< CommandOutputTargets > &&  target)
overridevirtual

Implements OldStyleCommandType.

Definition at line 35 of file BatchEvalCommand.cpp.

36 {
37  return std::make_shared<BatchEvalCommand>(*this);
38 }

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