Audacity  2.2.0
Command Class Referenceabstract

Base class which encapsulates a process. More...

#include <Command.h>

Inheritance diagram for Command:
CommandImplementation DecoratedCommand BatchEvalCommand CompareAudioCommand ExecMenuCommand ExportCommand GetAllMenuCommands GetPreferenceCommand GetProjectInfoCommand GetTrackInfoCommand HelpCommand ImportCommand MessageCommand OpenProjectCommand SaveProjectCommand ScreenshotCommand SelectCommand SetPreferenceCommand SetProjectInfoCommand SetTrackInfoCommand ApplyAndSendResponse

Public Member Functions

virtual void Progress (double completed)=0
 
virtual void Status (const wxString &message)=0
 
virtual void Error (const wxString &message)=0
 
virtual ~Command ()
 
virtual wxString GetName ()=0
 
virtual CommandSignatureGetSignature ()=0
 
virtual bool SetParameter (const wxString &paramName, const wxVariant &paramValue)
 
virtual bool Apply (CommandExecutionContext context)=0
 

Detailed Description

Base class which encapsulates a process.

That process may depend on certain parameters (determined by the command's signature) and may produce output on various channels. Any process which is to be controlled by a script should be separated out into its own Command class. (And that class should be registered with the CommandDirectory).

Constructor & Destructor Documentation

virtual Command::~Command ( )
inlinevirtual

Member Function Documentation

virtual void Command::Error ( const wxString &  message)
pure virtual
virtual wxString Command::GetName ( )
pure virtual
virtual CommandSignature& Command::GetSignature ( )
pure virtual
virtual void Command::Progress ( double  completed)
pure virtual
bool Command::SetParameter ( const wxString &  paramName,
const wxVariant &  paramValue 
)
virtual

Reimplemented in CommandImplementation, and DecoratedCommand.

virtual void Command::Status ( const wxString &  message)
pure virtual

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