Audacity  2.2.0
CommandType Class Referenceabstract

Base class for containing data common to all commands of a given type. Also acts as a factory. More...

#include <CommandType.h>

Inheritance diagram for CommandType:
BatchEvalCommandType CompareAudioCommandType ExecMenuCommandType ExportCommandType GetAllMenuCommandsType GetPreferenceCommandType GetProjectInfoCommandType GetTrackInfoCommandType HelpCommandType ImportCommandType MessageCommandType OpenProjectCommandType SaveProjectCommandType ScreenshotCommandType SelectCommandType SetPreferenceCommandType SetProjectInfoCommandType SetTrackInfoCommandType

Public Member Functions

 CommandType ()
 
virtual ~CommandType ()
 
const wxString & GetName ()
 
CommandSignatureGetSignature ()
 
wxString Describe ()
 
virtual wxString BuildName ()=0
 
virtual void BuildSignature (CommandSignature &signature)=0
 Postcondition: signature is a 'signature' map containing parameter. More...
 
virtual CommandHolder Create (std::unique_ptr< CommandOutputTarget > &&target)=0
 

Private Attributes

wxString mName
 
Maybe< CommandSignaturemSignature
 

Detailed Description

Base class for containing data common to all commands of a given type. Also acts as a factory.

Constructor & Destructor Documentation

CommandType::CommandType ( )
CommandType::~CommandType ( )
virtual

Member Function Documentation

const wxString & CommandType::GetName ( )

References BuildName(), and mName.

Referenced by Describe(), and CommandImplementation::GetName().

Member Data Documentation

wxString CommandType::mName
private

Referenced by GetName().

Maybe<CommandSignature> CommandType::mSignature
private

Referenced by Describe(), and GetSignature().


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