Audacity 3.2.0
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
SaveCopyCommand Class Reference

Command for saving a copy of currently project. More...

#include <OpenSaveCommands.h>

Inheritance diagram for SaveCopyCommand:
[legend]
Collaboration diagram for SaveCopyCommand:
[legend]

Public Member Functions

ComponentInterfaceSymbol GetSymbol () const override
 
TranslatableString GetDescription () const override
 
template<bool Const>
bool VisitSettings (SettingsVisitorBase< Const > &S)
 
bool VisitSettings (SettingsVisitor &S) override
 
bool VisitSettings (ConstSettingsVisitor &S) override
 
void PopulateOrExchange (ShuttleGui &S) override
 
bool Apply (const CommandContext &context) override
 
ManualPageID ManualPage () override
 
- Public Member Functions inherited from AudacityCommand
 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 &)
 
- Public Member Functions inherited from ComponentInterface
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
 

Public Attributes

wxString mFileName
 

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Save Copy") }
 

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Protected Attributes inherited from AudacityCommand
ProgressDialogmProgress
 
wxDialog * mUIDialog
 
wxWindow * mUIParent
 

Detailed Description

Command for saving a copy of currently project.

Definition at line 74 of file OpenSaveCommands.h.

Member Function Documentation

◆ Apply()

bool SaveCopyCommand::Apply ( const CommandContext context)
override

Definition at line 158 of file OpenSaveCommands.cpp.

159{
160 auto &projectFileManager = ProjectFileManager::Get( context.project );
161 return projectFileManager.SaveCopy(mFileName);
162}
AudacityProject & project
static ProjectFileManager & Get(AudacityProject &project)

References ProjectFileManager::Get(), mFileName, and CommandContext::project.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString SaveCopyCommand::GetDescription ( ) const
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 81 of file OpenSaveCommands.h.

81{return XO("Saves a copy of current project.");};
XO("Cut/Copy/Paste")

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol SaveCopyCommand::GetSymbol ( ) const
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 80 of file OpenSaveCommands.h.

80{return Symbol;};
static const ComponentInterfaceSymbol Symbol

References Symbol.

◆ ManualPage()

ManualPageID SaveCopyCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 89 of file OpenSaveCommands.h.

89{return L"Extra_Menu:_Scriptables_II#save_copy";}

◆ PopulateOrExchange()

void SaveCopyCommand::PopulateOrExchange ( ShuttleGui S)
override

Definition at line 147 of file OpenSaveCommands.cpp.

148{
149 S.AddSpace(0, 5);
150
151 S.StartMultiColumn(2, wxALIGN_CENTER);
152 {
153 S.TieTextBox(XXO("File Name:"),mFileName);
154 }
155 S.EndMultiColumn();
156}
XXO("&Cut/Copy/Paste Toolbar")
#define S(N)
Definition: ToChars.cpp:64

References mFileName, S, and XXO().

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool SaveCopyCommand::VisitSettings ( ConstSettingsVisitor )
overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 144 of file OpenSaveCommands.cpp.

145 { return VisitSettings<true>(S); }

References S.

◆ VisitSettings() [2/3]

bool SaveCopyCommand::VisitSettings ( SettingsVisitor )
overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 141 of file OpenSaveCommands.cpp.

142 { return VisitSettings<false>(S); }

References S.

◆ VisitSettings() [3/3]

template<bool Const>
bool SaveCopyCommand::VisitSettings ( SettingsVisitorBase< Const > &  S)

Definition at line 136 of file OpenSaveCommands.cpp.

136 {
137 S.Define( mFileName, wxT("Filename"), wxString{"name.aup3"} );
138 return true;
139}
wxT("CloseDown"))

References mFileName, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ mFileName

wxString SaveCopyCommand::mFileName

Definition at line 91 of file OpenSaveCommands.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

◆ Symbol

const ComponentInterfaceSymbol SaveCopyCommand::Symbol { XO("Save Copy") }
static

Definition at line 77 of file OpenSaveCommands.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files: