Audacity  3.0.3
OpenSaveCommands.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4  Audacity(R) is copyright (c) 1999-2018 Audacity Team.
5  File License: wxwidgets
6 
7  OpenSaveCommands.h
8  Stephen Parry
9  James Crook
10 
11 ******************************************************************//*******************************************************************/
26 
27 #include "Command.h"
28 #include "CommandType.h"
29 
31 {
32 public:
34 
35  // ComponentInterface overrides
37  TranslatableString GetDescription() override {return XO("Opens a project.");};
38  bool DefineParams( ShuttleParams & S ) override;
39  void PopulateOrExchange(ShuttleGui & S) override;
40  bool Apply(const CommandContext & context) override;
41 
42  // AudacityCommand overrides
43  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#open_project";}
44 public:
45  wxString mFileName;
48 };
49 
51 {
52 public:
54 
55  // ComponentInterface overrides
57  TranslatableString GetDescription() override {return XO("Saves a project.");};
58  bool DefineParams( ShuttleParams & S ) override;
59  void PopulateOrExchange(ShuttleGui & S) override;
60  bool Apply(const CommandContext & context) override;
61 
62  // AudacityCommand overrides
63  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#save_project";}
64 public:
65  wxString mFileName;
68 };
69 
71 {
72 public:
74 
75  // ComponentInterface overrides
77  TranslatableString GetDescription() override {return XO("Saves a copy of current project.");};
78  bool DefineParams( ShuttleParams & S ) override;
79  void PopulateOrExchange(ShuttleGui & S) override;
80  bool Apply(const CommandContext & context) override;
81 
82  // AudacityCommand overrides
83  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#save_copy";}
84 public:
85  wxString mFileName;
86 };
87 
89 {
90 public:
92 
93  // ComponentInterface overrides
95  TranslatableString GetDescription() override {return XO("Saves the log contents.");};
96  bool DefineParams( ShuttleParams & S ) override;
97  void PopulateOrExchange(ShuttleGui & S) override;
98  bool Apply(const CommandContext & context) override;
99 
100  // AudacityCommand overrides
101  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#save_log";}
102 public:
103  wxString mFileName;
104 };
105 
107 {
108 public:
110 
111  // ComponentInterface overrides
113  TranslatableString GetDescription() override {return XO("Clears the log contents.");};
114  bool DefineParams( ShuttleParams & S ) override;
115  bool PromptUser(wxWindow *parent) override;
116  bool Apply(const CommandContext & context) override;
117 
118  // AudacityCommand overrides
119  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#Clear_log";}
120 public:
121  wxString mFileName;
122 };
SaveCopyCommand::GetDescription
TranslatableString GetDescription() override
Definition: OpenSaveCommands.h:77
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
SaveProjectCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: OpenSaveCommands.cpp:86
ClearLogCommand::mFileName
wxString mFileName
Definition: OpenSaveCommands.h:121
OpenProjectCommand::ManualPage
ManualPageID ManualPage() override
Definition: OpenSaveCommands.h:43
OpenProjectCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: OpenSaveCommands.h:33
OpenProjectCommand::bHasAddToHistory
bool bHasAddToHistory
Definition: OpenSaveCommands.h:47
SaveProjectCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: OpenSaveCommands.h:53
OpenProjectCommand::mFileName
wxString mFileName
Definition: OpenSaveCommands.h:45
XO
#define XO(s)
Definition: Internat.h:31
ShuttleParams
Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothi...
Definition: Shuttle.h:62
OpenProjectCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: OpenSaveCommands.cpp:43
ClearLogCommand
Definition: OpenSaveCommands.h:107
ClearLogCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: OpenSaveCommands.cpp:173
SaveLogCommand
Command for saving the log contents.
Definition: OpenSaveCommands.h:89
OpenProjectCommand::GetDescription
TranslatableString GetDescription() override
Definition: OpenSaveCommands.h:37
OpenProjectCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: OpenSaveCommands.cpp:37
OpenProjectCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: OpenSaveCommands.h:36
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
SaveCopyCommand::mFileName
wxString mFileName
Definition: OpenSaveCommands.h:85
ClearLogCommand::Apply
bool Apply(const CommandContext &context) override
Definition: OpenSaveCommands.cpp:183
ClearLogCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: OpenSaveCommands.h:112
CommandContext
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
Definition: CommandContext.h:34
SaveLogCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: OpenSaveCommands.h:94
SaveProjectCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: OpenSaveCommands.h:56
SaveCopyCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: OpenSaveCommands.cpp:118
SaveLogCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: OpenSaveCommands.h:91
AudacityCommand
Base class for command in Audacity.
Definition: AudacityCommand.h:41
SaveLogCommand::Apply
bool Apply(const CommandContext &context) override
Definition: OpenSaveCommands.cpp:162
SaveCopyCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: OpenSaveCommands.cpp:123
SaveCopyCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: OpenSaveCommands.h:76
OpenProjectCommand::Apply
bool Apply(const CommandContext &context) override
Definition: OpenSaveCommands.cpp:55
ClearLogCommand::ManualPage
ManualPageID ManualPage() override
Definition: OpenSaveCommands.h:119
CommandType.h
Contains declarations for CommandType class.
SaveCopyCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: OpenSaveCommands.h:73
SaveProjectCommand::mbAddToHistory
bool mbAddToHistory
Definition: OpenSaveCommands.h:66
SaveCopyCommand::ManualPage
ManualPageID ManualPage() override
Definition: OpenSaveCommands.h:83
SaveProjectCommand::Apply
bool Apply(const CommandContext &context) override
Definition: OpenSaveCommands.cpp:104
SaveProjectCommand::ManualPage
ManualPageID ManualPage() override
Definition: OpenSaveCommands.h:63
ClearLogCommand::PromptUser
bool PromptUser(wxWindow *parent) override
Definition: OpenSaveCommands.cpp:178
SaveProjectCommand::bHasAddToHistory
bool bHasAddToHistory
Definition: OpenSaveCommands.h:67
TaggedIdentifier< ManualPageIDTag >
SaveProjectCommand::GetDescription
TranslatableString GetDescription() override
Definition: OpenSaveCommands.h:57
SaveLogCommand::GetDescription
TranslatableString GetDescription() override
Definition: OpenSaveCommands.h:95
SaveProjectCommand::mFileName
wxString mFileName
Definition: OpenSaveCommands.h:65
SaveCopyCommand
Command for saving a copy of currently project.
Definition: OpenSaveCommands.h:71
ClearLogCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: OpenSaveCommands.h:109
SaveProjectCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: OpenSaveCommands.cpp:92
SaveLogCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: OpenSaveCommands.cpp:145
SaveCopyCommand::Apply
bool Apply(const CommandContext &context) override
Definition: OpenSaveCommands.cpp:134
Command.h
Contains declaration of Command base class.
OpenProjectCommand::mbAddToHistory
bool mbAddToHistory
Definition: OpenSaveCommands.h:46
ClearLogCommand::GetDescription
TranslatableString GetDescription() override
Definition: OpenSaveCommands.h:113
SaveLogCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: OpenSaveCommands.cpp:151
SaveLogCommand::ManualPage
ManualPageID ManualPage() override
Definition: OpenSaveCommands.h:101
OpenProjectCommand
Command for opening an Audacity project.
Definition: OpenSaveCommands.h:31
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631
SaveLogCommand::mFileName
wxString mFileName
Definition: OpenSaveCommands.h:103
SaveProjectCommand
Command for saving an Audacity project.
Definition: OpenSaveCommands.h:51