Audacity  3.0.3
BatchPrefs.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  BatchPrefs.h
6 
7  Dominic Mazzoni
8  James Crook
9 
10 **********************************************************************/
11 
12 #ifndef __AUDACITY_BATCH_PREFS__
13 #define __AUDACITY_BATCH_PREFS__
14 
15 #include <wx/defs.h>
16 
17 #include "PrefsPanel.h"
18 
19 class ShuttleGui;
20 
21 #define BATCH_PREFS_PLUGIN_SYMBOL ComponentInterfaceSymbol{ XO("Batch") }
22 
23 class BatchPrefs final : public PrefsPanel
24 {
25 public:
26  BatchPrefs(wxWindow * parent, wxWindowID winid);
27  ~BatchPrefs();
30  ManualPageID HelpPageName() override;
31 
32  bool Commit() override;
33  void PopulateOrExchange(ShuttleGui & S) override;
34 
35 private:
36  void Populate();
37 
38  DECLARE_EVENT_TABLE()
39 };
40 
41 #endif
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
BatchPrefs::BatchPrefs
BatchPrefs(wxWindow *parent, wxWindowID winid)
Constructor.
Definition: BatchPrefs.cpp:32
PrefsPanel.h
BatchPrefs::Populate
void Populate()
Creates the dialog and its contents.
Definition: BatchPrefs.cpp:54
BatchPrefs::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Defines the dialog and does data exchange with it.
Definition: BatchPrefs.cpp:66
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
BatchPrefs::~BatchPrefs
~BatchPrefs()
Definition: BatchPrefs.cpp:94
BatchPrefs::Commit
bool Commit() override
Send changed values back to Prefs, and update Audacity.
Definition: BatchPrefs.cpp:86
BatchPrefs::GetDescription
TranslatableString GetDescription() override
Definition: BatchPrefs.cpp:43
TaggedIdentifier< ManualPageIDTag >
BatchPrefs::HelpPageName
ManualPageID HelpPageName() override
If not empty string, the Help button is added below the panel.
Definition: BatchPrefs.cpp:48
PrefsPanel
Base class for a panel in the PrefsDialog. Classes derived from this class include BatchPrefs,...
Definition: PrefsPanel.h:51
BatchPrefs::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: BatchPrefs.cpp:38
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631
BatchPrefs
A probably unused PrefsPanel that in debug builds could offer a setting used in debugging batch (aka ...
Definition: BatchPrefs.h:24