Audacity  2.2.2
HelpCommand.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity - A Digital Audio Editor
4  Copyright 1999-2018 Audacity Team
5  License: wxwidgets
6 
7  Dan Horgan
8  James Crook
9 
10 ******************************************************************//*******************************************************************/
19 
20 #ifndef __HELPCOMMAND__
21 #define __HELPCOMMAND__
22 
23 #include "CommandType.h"
24 #include "Command.h"
25 
26 #define HELP_PLUGIN_SYMBOL IdentInterfaceSymbol{ XO("Help") }
27 
29 {
30 public:
31  // CommandDefinitionInterface overrides
33  wxString GetDescription() override {return _("Gives help on a command.");};
34  bool DefineParams( ShuttleParams & S ) override;
35  void PopulateOrExchange(ShuttleGui & S) override;
36  bool Apply(const CommandContext & context) override;
37 
38  // AudacityCommand overrides
39  wxString ManualPage() override {return wxT("Help");};
40 public:
41  wxString mCommandName;
42 };
43 
44 
45 #endif /* End of include guard: __HELPCOMMAND__ */
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI...
Definition: ShuttleGui.h:409
bool DefineParams(ShuttleParams &S) override
Definition: HelpCommand.cpp:23
Contains declarations for CommandType class.
Contains declaration of Command base class.
CommandContext provides addiitonal information to an 'Apply()' command. It provides the project...
Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothi...
Definition: Shuttle.h:60
IdentInterfaceSymbol GetSymbol() override
Definition: HelpCommand.h:32
#define HELP_PLUGIN_SYMBOL
Definition: HelpCommand.h:26
wxString ManualPage() override
Definition: HelpCommand.h:39
wxString GetDescription() override
Definition: HelpCommand.h:33
wxString mCommandName
Definition: HelpCommand.h:39
IdentInterfaceSymbol pairs a persistent string identifier used internally with an optional...
Base class for command in Audacity.
void PopulateOrExchange(ShuttleGui &S) override
Definition: HelpCommand.cpp:28
_("Move Track &Down")+wxT("\t")+(GetActiveProject() -> GetCommandManager() ->GetKeyFromName(wxT("TrackMoveDown")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveTopID, _("Move Track to &Top")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveTop")).Raw()), OnMoveTrack) POPUP_MENU_ITEM(OnMoveBottomID, _("Move Track to &Bottom")+wxT("\t")+(GetActiveProject() ->GetCommandManager() ->GetKeyFromName(wxT("TrackMoveBottom")).Raw()), OnMoveTrack)#define SET_TRACK_NAME_PLUGIN_SYMBOLclass SetTrackNameCommand:public AudacityCommand
Command to get help about other commands.
Definition: HelpCommand.h:28
virtual bool Apply()