11#ifndef __AUDACITY_COMMAND__
12#define __AUDACITY_COMMAND__
30#define BUILTIN_GENERIC_COMMAND_PREFIX wxT("Built-in AudacityCommand: ")
59 {wxFAIL_MSG(
"Implement a Description for this command");
return XO(
"FAIL");};
68 bool ShowInterface(wxWindow *parent,
bool forceModal =
false);
72 bool SaveSettingsAsString(wxString & parms);
73 bool LoadSettingsFromString(
const wxString & parms);
80 enum :
long { DefaultMessageBoxStyle = wxOK | wxCENTRE };
82 long style = DefaultMessageBoxStyle,
102 virtual bool PromptUser(wxWindow *parent);
116 virtual bool TransferDataToWindow();
117 virtual bool TransferDataFromWindow();
148 int flags = wxDEFAULT_DIALOG_STYLE,
149 int additionalButtons = 0);
153 bool TransferDataToWindow()
override;
154 bool TransferDataFromWindow()
override;
155 bool Validate()
override;
158 virtual void OnOk(wxCommandEvent & evt);
159 virtual void OnCancel(wxCommandEvent & evt);
160 virtual void OnHelp(wxCommandEvent & evt);
167 DECLARE_EVENT_TABLE()
wxString PluginPath
type alias for identifying a Plugin supplied by a module, each module defining its own interpretation...
Default dialog used for commands. Is populated using ShuttleGui.
AudacityCommand * mpCommand
Base class for command in Audacity.
virtual bool IsBatchProcessing() const
virtual bool Apply(const CommandContext &WXUNUSED(context))
virtual void PopulateOrExchange(ShuttleGui &WXUNUSED(S))
ComponentInterfaceSymbol GetSymbol() const override=0
virtual void SetBatchProcessing(bool start)
virtual ManualPageID ManualPage()
ProgressDialog * mProgress
virtual bool CheckWhetherSkipAudacityCommand()
virtual TranslatableString GetDescription() const override
The top-level handle to an Audacity project. It serves as a source of events that other objects can b...
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
ComponentInterface provides name / vendor / version functions to identify plugins....
virtual wxString GetVersion() const =0
virtual PluginPath GetPath() const =0
virtual VendorSymbol GetVendor() const =0
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
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.
Holds a msgid for the translation catalog; may also bind format arguments.
AUDACITY_DLL_API bool DoAudacityCommand(const PluginID &ID, const CommandContext &context, unsigned flags)