Audacity 3.2.0
MessageCommand.h
Go to the documentation of this file.
1/**********************************************************************
2
3 Audacity - A Digital Audio Editor
4 Copyright 1999-2009 Audacity Team
5 File License: wxWidgets
6
7 Dan Horgan
8
9******************************************************************//***************************************************************//*******************************************************************/
20
21#ifndef __MESSAGE_COMMAND__
22#define __MESSAGE_COMMAND__
23
24#include "CommandType.h"
25#include "Command.h"
26
28{
29public:
31
32 // ComponentInterface overrides
33 ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
34 TranslatableString GetDescription() const override {return XO("Echos a message.");};
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
41 // AudacityCommand overrides
42 ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#message";}
43public:
44 wxString mMessage;
45};
46
47
48#endif /* End of include guard: __MESSAGECOMMAND__ */
Contains declaration of Command base class.
Contains declarations for CommandType class.
XO("Cut/Copy/Paste")
#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,...
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Command to get a message response. Used for testing, and used internally to create messages for forwa...
ManualPageID ManualPage() override
void PopulateOrExchange(ShuttleGui &S) override
wxString mMessage
ComponentInterfaceSymbol GetSymbol() const override
bool Apply(const CommandContext &context) override
static const ComponentInterfaceSymbol Symbol
bool VisitSettings(SettingsVisitorBase< Const > &S)
TranslatableString GetDescription() const override
Visitor of effect or command parameters. This is a base class with lots of virtual functions that do ...
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:630
Holds a msgid for the translation catalog; may also bind format arguments.