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

#include <AutomationCommands.h>

Inheritance diagram for AutomationCommandsType:
CommandType

Public Member Functions

 AutomationCommandsType (const wxString &Name)
 
wxString BuildName () override
 
void BuildSignature (CommandSignature &signature) override
 Postcondition: signature is a 'signature' map containing parameter. More...
 
CommandHolder Create (std::unique_ptr< CommandOutputTarget > &&target) override
 
- Public Member Functions inherited from CommandType
 CommandType ()
 
virtual ~CommandType ()
 
const wxString & GetName ()
 
CommandSignatureGetSignature ()
 
wxString Describe ()
 

Public Attributes

wxString mCustomName
 

Detailed Description

Definition at line 29 of file AutomationCommands.h.

Constructor & Destructor Documentation

AutomationCommandsType::AutomationCommandsType ( const wxString &  Name)
inline

Definition at line 32 of file AutomationCommands.h.

32 { mCustomName = Name;};

Member Function Documentation

wxString AutomationCommandsType::BuildName ( )
overridevirtual

Implements CommandType.

Definition at line 27 of file AutomationCommands.cpp.

References mCustomName.

28 {
29  return mCustomName;
30 }
void AutomationCommandsType::BuildSignature ( CommandSignature signature)
overridevirtual

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

Implements CommandType.

Definition at line 32 of file AutomationCommands.cpp.

References CommandSignature::AddParameter().

33 {
34  auto infoTypeValidator = make_movable<OptionValidator>();
35  infoTypeValidator->AddOption(wxT("Menus"));
36  infoTypeValidator->AddOption(wxT("Menus+"));
37  infoTypeValidator->AddOption(wxT("Keycodes"));
38  infoTypeValidator->AddOption(wxT("Boxes"));
39 
40  signature.AddParameter(wxT("Type"), "Menus", std::move(infoTypeValidator));
41 }
void AddParameter(const wxString &name, const wxVariant &dft, movable_ptr< Validator > &&valid)
CommandHolder AutomationCommandsType::Create ( std::unique_ptr< CommandOutputTarget > &&  target)
overridevirtual

Implements CommandType.

Definition at line 43 of file AutomationCommands.cpp.

44 {
45  return std::make_shared<AutomationCommands>(*this, std::move(target));
46 }

Member Data Documentation

wxString AutomationCommandsType::mCustomName

Definition at line 32 of file AutomationCommands.h.

Referenced by BuildName().


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