Audacity
3.2.0
src
commands
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
27
class
MessageCommand
:
public
AudacityCommand
28
{
29
public
:
30
static
const
ComponentInterfaceSymbol
Symbol
;
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"
;}
43
public
:
44
wxString
mMessage
;
45
};
46
47
48
#endif
/* End of include guard: __MESSAGECOMMAND__ */
Command.h
Contains declaration of Command base class.
CommandType.h
Contains declarations for CommandType class.
XO
XO("Cut/Copy/Paste")
S
#define S(N)
Definition:
ToChars.cpp:64
AudacityCommand
Base class for command in Audacity.
Definition:
AudacityCommand.h:40
CommandContext
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
Definition:
CommandContext.h:37
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition:
ComponentInterfaceSymbol.h:27
MessageCommand
Command to get a message response. Used for testing, and used internally to create messages for forwa...
Definition:
MessageCommand.h:28
MessageCommand::ManualPage
ManualPageID ManualPage() override
Definition:
MessageCommand.h:42
MessageCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition:
MessageCommand.cpp:44
MessageCommand::mMessage
wxString mMessage
Definition:
MessageCommand.h:44
MessageCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() const override
Definition:
MessageCommand.h:33
MessageCommand::Apply
bool Apply(const CommandContext &context) override
Definition:
MessageCommand.cpp:55
MessageCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition:
MessageCommand.h:30
MessageCommand::VisitSettings
bool VisitSettings(SettingsVisitorBase< Const > &S)
Definition:
MessageCommand.cpp:33
MessageCommand::GetDescription
TranslatableString GetDescription() const override
Definition:
MessageCommand.h:34
SettingsVisitorBase
Visitor of effect or command parameters. This is a base class with lots of virtual functions that do ...
Definition:
SettingsVisitor.h:79
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition:
ShuttleGui.h:640
TaggedIdentifier< ManualPageIDTag >
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition:
TranslatableString.h:32
Generated by
1.9.3