Audacity  2.2.0
HelpCommand.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity - A Digital Audio Editor
4  Copyright 1999-2009 Audacity Team
5  License: wxwidgets
6 
7  Dan Horgan
8 
9 ******************************************************************//*******************************************************************/
18 
19 #ifndef __HELPCOMMAND__
20 #define __HELPCOMMAND__
21 
22 #include "CommandType.h"
23 #include "Command.h"
24 
25 class HelpCommandType final : public CommandType
26 {
27 public:
28  wxString BuildName() override;
29  void BuildSignature(CommandSignature &signature) override;
30  CommandHolder Create(std::unique_ptr<CommandOutputTarget> &&target) override;
31 };
32 
33 class HelpCommand final : public CommandImplementation
34 {
35 public:
36  HelpCommand(HelpCommandType &type, std::unique_ptr<CommandOutputTarget> &&target)
37  : CommandImplementation(type, std::move(target)) { }
38  bool Apply(CommandExecutionContext context) override;
39 };
40 
41 #endif /* End of include guard: __HELPCOMMAND__ */
Definition: HelpCommand.h:25
std::shared_ptr< Command > CommandHolder
Definition: AppCommandEvent.h:26
Contains declarations for CommandType class.
Contains declaration of Command base class.
bool Apply(CommandExecutionContext context) override
Definition: HelpCommand.cpp:37
wxString BuildName() override
Definition: HelpCommand.cpp:21
HelpCommand(HelpCommandType &type, std::unique_ptr< CommandOutputTarget > &&target)
Definition: HelpCommand.h:36
CommandHolder Create(std::unique_ptr< CommandOutputTarget > &&target) override
Definition: HelpCommand.cpp:32
Definition: Command.h:108
Base class for containing data common to all commands of a given type. Also acts as a factory...
Definition: CommandType.h:29
Represents a context to which a command may be applied.
Definition: Command.h:40
Command which returns information about the given command.
Definition: HelpCommand.h:33
Class that maps parameter names to default values and validators.
Definition: CommandSignature.h:28
void BuildSignature(CommandSignature &signature) override
Postcondition: signature is a 'signature' map containing parameter.
Definition: HelpCommand.cpp:26