Audacity 3.2.0
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
27{
28public:
31
32 // ComponentInterface overrides
33 ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
34 TranslatableString GetDescription() const override {return XO("Gives help on a command.");};
35 template<bool Const> bool VisitSettings( SettingsVisitorBase<Const> &S );
36 bool VisitSettings( SettingsVisitor & S ) override;
37 bool VisitSettings( ConstSettingsVisitor & S ) override;
38 void PopulateOrExchange(ShuttleGui & S) override;
39 bool Apply(const CommandContext & context) override;
40 bool ApplyInner(const CommandContext & context);
41
42 // AudacityCommand overrides
43 ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#help";}
44public:
45 wxString mCommandName;
46};
47
49{
50public:
53
54 // ComponentInterface overrides
55 ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
56 TranslatableString GetDescription() const override {return XO("For comments in a macro.");};
57 template<bool Const> bool VisitSettings( SettingsVisitorBase<Const> &S );
58 bool VisitSettings( SettingsVisitor & S ) override;
59 bool VisitSettings( ConstSettingsVisitor & S ) override;
60 void PopulateOrExchange(ShuttleGui & S) override;
61 bool Apply(const CommandContext & context) override {
62 return true;
63 };
64 // AudacityCommand overrides
65 ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#comment";}
66public:
67 wxString mComment;
68};
69
70
71#endif /* End of include guard: __HELPCOMMAND__ */
Contains declaration of Command base class.
Contains declarations for CommandType class.
#define XO(s)
Definition: Internat.h:31
#define S(N)
Definition: ToChars.cpp:64
Base class for command in Audacity.
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
void PopulateOrExchange(ShuttleGui &S) override
bool Apply(const CommandContext &context) override
Definition: HelpCommand.h:61
TranslatableString GetDescription() const override
Definition: HelpCommand.h:56
ManualPageID ManualPage() override
Definition: HelpCommand.h:65
wxString mComment
Definition: HelpCommand.h:67
static const ComponentInterfaceSymbol Symbol
Definition: HelpCommand.h:51
ComponentInterfaceSymbol GetSymbol() const override
Definition: HelpCommand.h:55
bool VisitSettings(SettingsVisitorBase< Const > &S)
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Command to get help about other commands.
Definition: HelpCommand.h:27
void PopulateOrExchange(ShuttleGui &S) override
Definition: HelpCommand.cpp:66
wxString mCommandName
Definition: HelpCommand.h:45
TranslatableString GetDescription() const override
Definition: HelpCommand.h:34
static const ComponentInterfaceSymbol Symbol
Definition: HelpCommand.h:29
bool Apply(const CommandContext &context) override
Definition: HelpCommand.cpp:79
bool ApplyInner(const CommandContext &context)
ComponentInterfaceSymbol GetSymbol() const override
Definition: HelpCommand.h:33
bool VisitSettings(SettingsVisitorBase< Const > &S)
Definition: HelpCommand.cpp:55
ManualPageID ManualPage() override
Definition: HelpCommand.h:43
Visitor of effect or command parameters. This is a base class with lots of virtual functions that do ...
Definition: Shuttle.h:115
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:628
Holds a msgid for the translation catalog; may also bind format arguments.