![]() |
Audacity 3.2.0
|
Base class for command in Audacity. More...
#include <AudacityCommand.h>
Public Types | |
enum | : long { DefaultMessageBoxStyle = wxOK | wxCENTRE } |
Public Member Functions | |
AudacityCommand () | |
virtual | ~AudacityCommand () |
PluginPath | GetPath () const override |
VendorSymbol | GetVendor () const override |
wxString | GetVersion () const override |
ComponentInterfaceSymbol | GetSymbol () const override=0 |
virtual TranslatableString | GetDescription () const override |
virtual ManualPageID | ManualPage () |
virtual bool | IsBatchProcessing () const |
virtual void | SetBatchProcessing (bool start) |
virtual bool | Apply (const CommandContext &WXUNUSED(context)) |
bool | ShowInterface (wxWindow *parent, bool forceModal=false) |
wxDialog * | CreateUI (wxWindow *parent, AudacityCommand *client) |
bool | SaveSettingsAsString (wxString &parms) |
bool | LoadSettingsFromString (const wxString &parms) |
bool | DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true) |
int | MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={}) |
virtual bool | Init () |
virtual bool | PromptUser (wxWindow *parent) |
virtual bool | CheckWhetherSkipAudacityCommand () |
virtual void | End () |
virtual void | PopulateOrExchange (ShuttleGui &WXUNUSED(S)) |
virtual bool | TransferDataToWindow () |
virtual bool | TransferDataFromWindow () |
virtual bool | VisitSettings (SettingsVisitor &) |
virtual bool | VisitSettings (ConstSettingsVisitor &) |
![]() | |
virtual | ~ComponentInterface () |
virtual PluginPath | GetPath () const =0 |
virtual ComponentInterfaceSymbol | GetSymbol () const =0 |
virtual VendorSymbol | GetVendor () const =0 |
virtual wxString | GetVersion () const =0 |
virtual TranslatableString | GetDescription () const =0 |
TranslatableString | GetName () const |
Protected Attributes | |
ProgressDialog * | mProgress |
wxDialog * | mUIDialog |
wxWindow * | mUIParent |
Private Attributes | |
bool | mIsBatch |
bool | mNeedsInit |
Base class for command in Audacity.
Definition at line 39 of file AudacityCommand.h.
anonymous enum : long |
AudacityCommand::AudacityCommand | ( | ) |
Definition at line 50 of file AudacityCommand.cpp.
References mIsBatch, mNeedsInit, mProgress, mUIDialog, and mUIParent.
|
virtual |
Definition at line 59 of file AudacityCommand.cpp.
References mUIDialog.
|
inlinevirtual |
Definition at line 67 of file AudacityCommand.h.
Referenced by DoAudacityCommand().
|
inlinevirtual |
Definition at line 110 of file AudacityCommand.h.
Referenced by DoAudacityCommand().
wxDialog * AudacityCommand::CreateUI | ( | wxWindow * | parent, |
AudacityCommand * | client | ||
) |
Definition at line 107 of file AudacityCommand.cpp.
References ComponentInterface::GetName(), and safenew.
Referenced by ShowInterface().
bool AudacityCommand::DoAudacityCommand | ( | wxWindow * | parent, |
const CommandContext & | context, | ||
bool | shouldPrompt = true |
||
) |
Definition at line 163 of file AudacityCommand.cpp.
References Apply(), CheckWhetherSkipAudacityCommand(), End(), ComponentInterface::GetName(), Init(), mProgress, name, pdlgHideStopButton, PromptUser(), valueRestorer(), and XO.
Referenced by EffectManager::DoAudacityCommand().
|
inlinevirtual |
Definition at line 115 of file AudacityCommand.h.
Referenced by DoAudacityCommand().
|
inlineoverridevirtual |
Implements ComponentInterface.
Reimplemented in CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.
Definition at line 59 of file AudacityCommand.h.
References XO.
Referenced by EffectManager::GetCommandTip().
|
overridevirtual |
Implements ComponentInterface.
Definition at line 66 of file AudacityCommand.cpp.
References BUILTIN_GENERIC_COMMAND_PREFIX, GetSymbol(), and ComponentInterfaceSymbol::Internal().
|
overridepure virtual |
Implements ComponentInterface.
Implemented in OldStyleCommandType, CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, SetTrackCommand, SetWaveClipNameCommand, and SetTrackNameCommand.
Referenced by GetPath().
|
overridevirtual |
|
overridevirtual |
Implements ComponentInterface.
Definition at line 68 of file AudacityCommand.cpp.
|
virtual |
Definition at line 71 of file AudacityCommand.cpp.
References mNeedsInit, and VisitSettings().
Referenced by DoAudacityCommand(), EffectManager::GetAudacityCommand(), and EffectManager::SetEffectParameters().
|
inlinevirtual |
Definition at line 64 of file AudacityCommand.h.
Referenced by PromptUser().
bool AudacityCommand::LoadSettingsFromString | ( | const wxString & | parms | ) |
Definition at line 138 of file AudacityCommand.cpp.
References ComponentInterface::GetName(), MessageBox(), preset, S, TransferDataToWindow(), VisitSettings(), and XO.
Referenced by EffectManager::SetEffectParameters().
|
inlinevirtual |
Reimplemented in CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.
Definition at line 63 of file AudacityCommand.h.
Referenced by EffectManager::GetCommandUrl(), and AudacityCommandDialog::OnHelp().
int AudacityCommand::MessageBox | ( | const TranslatableString & | message, |
long | style = DefaultMessageBoxStyle , |
||
const TranslatableString & | titleStr = {} |
||
) |
Definition at line 232 of file AudacityCommand.cpp.
References AudacityMessageBox(), TranslatableString::empty(), ComponentInterface::GetName(), mUIParent, title, and XO.
Referenced by LoadSettingsFromString().
|
inlinevirtual |
Definition at line 116 of file AudacityCommand.h.
Referenced by AudacityCommandDialog::PopulateOrExchange().
|
virtual |
Reimplemented in ClearLogCommand.
Definition at line 203 of file AudacityCommand.cpp.
References IsBatchProcessing(), and ShowInterface().
Referenced by DoAudacityCommand(), and EffectManager::PromptUser().
bool AudacityCommand::SaveSettingsAsString | ( | wxString & | parms | ) |
Definition at line 120 of file AudacityCommand.cpp.
References CommandParameters::GetParameters(), mUIDialog, S, TransferDataFromWindow(), and VisitSettings().
Referenced by EffectManager::GetEffectParameters().
|
inlinevirtual |
Definition at line 65 of file AudacityCommand.h.
bool AudacityCommand::ShowInterface | ( | wxWindow * | parent, |
bool | forceModal = false |
||
) |
Definition at line 79 of file AudacityCommand.cpp.
References GlobalHook< VetoDialogHook, bool(wxDialog *) >::Call(), CreateUI(), mUIDialog, and valueRestorer().
Referenced by PromptUser().
|
virtual |
Definition at line 215 of file AudacityCommand.cpp.
References mUIParent.
Referenced by SaveSettingsAsString().
|
virtual |
Definition at line 208 of file AudacityCommand.cpp.
References mUIParent.
Referenced by LoadSettingsFromString().
|
virtual |
Visit settings, if defined. false means no defined settings. Default implementation returns false
Reimplemented in CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackBase, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.
Definition at line 227 of file AudacityCommand.cpp.
|
virtual |
Visit settings, if defined. false means no defined settings. Default implementation returns false
Reimplemented in CompareAudioCommand, DemoCommand, DragCommand, GetInfoCommand, GetTrackInfoCommand, HelpCommand, CommentCommand, ImportCommand, ExportCommand, MessageCommand, OpenProjectCommand, SaveProjectCommand, SaveCopyCommand, SaveLogCommand, ClearLogCommand, GetPreferenceCommand, SetPreferenceCommand, ScreenshotCommand, SelectTimeCommand, SelectFrequenciesCommand, SelectTracksCommand, SelectCommand, SetClipCommand, SetEnvelopeCommand, SetLabelCommand, SetProjectCommand, SetTrackBase, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.
Definition at line 222 of file AudacityCommand.cpp.
Referenced by EffectManager::GetCommandDefinition(), Init(), LoadSettingsFromString(), and SaveSettingsAsString().
|
private |
Definition at line 135 of file AudacityCommand.h.
Referenced by AudacityCommand().
|
private |
Definition at line 136 of file AudacityCommand.h.
Referenced by AudacityCommand(), and Init().
|
protected |
Definition at line 129 of file AudacityCommand.h.
Referenced by AudacityCommand(), and DoAudacityCommand().
|
protected |
Definition at line 131 of file AudacityCommand.h.
Referenced by AudacityCommand(), SaveSettingsAsString(), ShowInterface(), and ~AudacityCommand().
|
protected |
Definition at line 132 of file AudacityCommand.h.
Referenced by AudacityCommand(), MessageBox(), TransferDataFromWindow(), and TransferDataToWindow().