Audacity 3.2.0
Public Member Functions | List of all members
ShuttleGetAutomation Class Referencefinal

SettingsVisitor that gets parameter values into a string. More...

#include <ShuttleAutomation.h>

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

Public Member Functions

ConstSettingsVisitor & Optional (const bool &var) override
 
void Define (bool var, const wxChar *key, bool vdefault, bool vmin, bool vmax, bool vscl) override
 
void Define (int var, const wxChar *key, int vdefault, int vmin, int vmax, int vscl) override
 
void Define (size_t var, const wxChar *key, int vdefault, int vmin, int vmax, int vscl) override
 
void Define (float var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl) override
 
void Define (double var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl) override
 
void Define (double var, const wxChar *key, double vdefault, double vmin, double vmax, double vscl) override
 
void Define (const wxString &var, const wxChar *key, wxString vdefault, wxString vmin, wxString vmax, wxString vscl) override
 
void DefineEnum (int var, const wxChar *key, int vdefault, const EnumValueSymbol strings[], size_t nStrings) override
 
- Public Member Functions inherited from SettingsVisitorBase< Const >
 SettingsVisitorBase ()
 
virtual ~SettingsVisitorBase ()
 
bool ShouldSet ()
 
virtual SettingsVisitorBase & Optional (Ref< bool > var)
 
virtual SettingsVisitorBase & OptionalY (Ref< bool > var)
 
virtual SettingsVisitorBase & OptionalN (Ref< bool > var)
 
virtual void Define (Arg< bool > var, const wxChar *key, bool vdefault, bool vmin=false, bool vmax=false, bool vscl=false)
 
virtual void Define (Arg< size_t > var, const wxChar *key, int vdefault, int vmin=0, int vmax=100000, int vscl=1)
 
virtual void Define (Arg< int > var, const wxChar *key, int vdefault, int vmin=0, int vmax=100000, int vscl=1)
 
virtual void Define (Arg< float > var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl=1.0f)
 
virtual void Define (Arg< double > var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl=1.0f)
 
virtual void Define (Arg< double > var, const wxChar *key, double vdefault, double vmin, double vmax, double vscl=1.0f)
 
virtual void Define (Ref< wxString > var, const wxChar *key, wxString vdefault, wxString vmin={}, wxString vmax={}, wxString vscl={})
 
virtual void DefineEnum (Arg< int > var, const wxChar *key, int vdefault, const EnumValueSymbol strings[], size_t nStrings)
 

Additional Inherited Members

- Public Types inherited from SettingsVisitorBase< Const >
template<typename T >
using Ref = std::conditional_t< Const, const T &, T & >
 
template<typename T >
using Arg = std::conditional_t< Const, T, T & >
 
- Public Attributes inherited from SettingsVisitorBase< Const >
wxString mParams
 
std::conditional_t< Const, const bool, bool > * pOptionalFlag {}
 
CommandParameters * mpEap {}
 

Detailed Description

SettingsVisitor that gets parameter values into a string.

Definition at line 244 of file ShuttleAutomation.h.

Member Function Documentation

◆ Define() [1/7]

void ShuttleGetAutomation::Define ( bool  var,
const wxChar *  key,
bool  vdefault,
bool  vmin,
bool  vmax,
bool  vscl 
)
override

Definition at line 22 of file ShuttleAutomation.cpp.

24{
25 if( !ShouldSet() ) return;
26 mpEap->Write(key, var);
27}
key
static const AudacityProject::AttachedObjects::RegisteredFactory key
Definition: NavigationMenus.cpp:547
SettingsVisitorBase::mpEap
CommandParameters * mpEap
Definition: SettingsVisitor.h:88

References key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::ShouldSet().

Here is the call graph for this function:

◆ Define() [2/7]

void ShuttleGetAutomation::Define ( const wxString &  var,
const wxChar *  key,
wxString  vdefault,
wxString  vmin,
wxString  vmax,
wxString  vscl 
)
override

Definition at line 65 of file ShuttleAutomation.cpp.

67{
68 if( !ShouldSet() ) return;
69 mpEap->Write(key, var);
70}

References key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::ShouldSet().

Here is the call graph for this function:

◆ Define() [3/7]

void ShuttleGetAutomation::Define ( double  var,
const wxChar *  key,
double  vdefault,
double  vmin,
double  vmax,
double  vscl 
)
override

Definition at line 57 of file ShuttleAutomation.cpp.

59{
60 if( !ShouldSet() ) return;
61 mpEap->Write(key, var);
62}

References key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::ShouldSet().

Here is the call graph for this function:

◆ Define() [4/7]

void ShuttleGetAutomation::Define ( double  var,
const wxChar *  key,
float  vdefault,
float  vmin,
float  vmax,
float  vscl 
)
override

Definition at line 43 of file ShuttleAutomation.cpp.

45{
46 if( !ShouldSet() ) return;
47 mpEap->WriteFloat(key, var);
48}
CommandParameters::WriteFloat
bool WriteFloat(const wxString &key, float f)
Definition: EffectAutomationParameters.h:155

References key, SettingsVisitorBase< Const >::mpEap, SettingsVisitorBase< Const >::ShouldSet(), and CommandParameters::WriteFloat().

Here is the call graph for this function:

◆ Define() [5/7]

void ShuttleGetAutomation::Define ( float  var,
const wxChar *  key,
float  vdefault,
float  vmin,
float  vmax,
float  vscl 
)
override

Definition at line 50 of file ShuttleAutomation.cpp.

52{
53 if( !ShouldSet() ) return;
54 mpEap->WriteFloat(key, var);
55}

References key, SettingsVisitorBase< Const >::mpEap, SettingsVisitorBase< Const >::ShouldSet(), and CommandParameters::WriteFloat().

Here is the call graph for this function:

◆ Define() [6/7]

void ShuttleGetAutomation::Define ( int  var,
const wxChar *  key,
int  vdefault,
int  vmin,
int  vmax,
int  vscl 
)
override

Definition at line 29 of file ShuttleAutomation.cpp.

31{
32 if( !ShouldSet() ) return;
33 mpEap->Write(key, var);
34}

References key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::ShouldSet().

Here is the call graph for this function:

◆ Define() [7/7]

void ShuttleGetAutomation::Define ( size_t  var,
const wxChar *  key,
int  vdefault,
int  vmin,
int  vmax,
int  vscl 
)
override

Definition at line 36 of file ShuttleAutomation.cpp.

38{
39 if( !ShouldSet() ) return;
40 mpEap->Write(key, (int) var);
41}

References key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::ShouldSet().

Here is the call graph for this function:

◆ DefineEnum()

void ShuttleGetAutomation::DefineEnum ( int  var,
const wxChar *  key,
int  vdefault,
const EnumValueSymbol  strings[],
size_t  nStrings 
)
override

Definition at line 73 of file ShuttleAutomation.cpp.

75{
76 if( !ShouldSet() ) return;
77 mpEap->Write(key, strings[var].Internal());
78}
ExceptionType::Internal
@ Internal
Indicates internal failure from Audacity.

References Internal, key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::ShouldSet().

Here is the call graph for this function:

◆ Optional()

ConstSettingsVisitor & ShuttleGetAutomation::Optional ( const bool &  var)
override

Definition at line 17 of file ShuttleAutomation.cpp.

17 {
18 pOptionalFlag = &var;
19 return *this;
20};
SettingsVisitorBase::pOptionalFlag
std::conditional_t< Const, const bool, bool > * pOptionalFlag
Definition: SettingsVisitor.h:87

References SettingsVisitorBase< Const >::pOptionalFlag.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.3