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

#include <HelpCommand.h>

Inheritance diagram for HelpCommandType:
CommandType

Public Member Functions

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 ()
 

Detailed Description

Definition at line 25 of file HelpCommand.h.

Member Function Documentation

wxString HelpCommandType::BuildName ( )
overridevirtual

Implements CommandType.

Definition at line 21 of file HelpCommand.cpp.

22 {
23  return wxT("Help");
24 }
void HelpCommandType::BuildSignature ( CommandSignature signature)
overridevirtual

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

Implements CommandType.

Definition at line 26 of file HelpCommand.cpp.

References CommandSignature::AddParameter().

27 {
28  auto commandNameValidator = make_movable<DefaultValidator>();
29  signature.AddParameter(wxT("CommandName"), wxT("Help"), std::move(commandNameValidator));
30 }
void AddParameter(const wxString &name, const wxVariant &dft, movable_ptr< Validator > &&valid)
CommandHolder HelpCommandType::Create ( std::unique_ptr< CommandOutputTarget > &&  target)
overridevirtual

Implements CommandType.

Definition at line 32 of file HelpCommand.cpp.

33 {
34  return std::make_shared<HelpCommand>(*this, std::move(target));
35 }

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