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

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

#include <Shuttle.h>

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

Public Member Functions

ShuttleParamsOptional (bool &var) override
 
void Define (bool &var, const wxChar *key, const bool vdefault, const bool vmin, const bool vmax, const bool vscl) override
 
void Define (int &var, const wxChar *key, const int vdefault, const int vmin, const int vmax, const int vscl) override
 
void Define (size_t &var, const wxChar *key, const int vdefault, const int vmin, const int vmax, const int vscl) override
 
void Define (float &var, const wxChar *key, const float vdefault, const float vmin, const float vmax, const float vscl) override
 
void Define (double &var, const wxChar *key, const float vdefault, const float vmin, const float vmax, const float vscl) override
 
void Define (double &var, const wxChar *key, const double vdefault, const double vmin, const double vmax, const double vscl) override
 
void Define (wxString &var, const wxChar *key, const wxString vdefault, const wxString vmin, const wxString vmax, const wxString vscl) override
 
void DefineEnum (int &var, const wxChar *key, const int vdefault, const EnumValueSymbol strings[], size_t nStrings) override
 
- Public Member Functions inherited from ShuttleParams
 ShuttleParams ()
 
virtual ~ShuttleParams ()
 
bool ShouldSet ()
 
virtual ShuttleParamsOptional (bool &WXUNUSED(var))
 
virtual ShuttleParamsOptionalY (bool &var)
 
virtual ShuttleParamsOptionalN (bool &var)
 

Additional Inherited Members

- Public Attributes inherited from ShuttleParams
wxString mParams
 
bool * pOptionalFlag
 
CommandParametersmpEap
 

Detailed Description

Shuttle that gets parameter values into a string.

Definition at line 87 of file Shuttle.h.

Member Function Documentation

◆ Define() [1/7]

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

Reimplemented from ShuttleParams.

Definition at line 355 of file Shuttle.cpp.

356 {
357  if( !ShouldSet() ) return;
358  mpEap->Write(key, var);
359 }

References key, ShuttleParams::mpEap, and ShuttleParams::ShouldSet().

Here is the call graph for this function:

◆ Define() [2/7]

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

Reimplemented from ShuttleParams.

Definition at line 385 of file Shuttle.cpp.

386 {
387  if( !ShouldSet() ) return;
388  mpEap->Write(key, var);
389 }

References key, ShuttleParams::mpEap, and ShuttleParams::ShouldSet().

Here is the call graph for this function:

◆ Define() [3/7]

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

Reimplemented from ShuttleParams.

Definition at line 373 of file Shuttle.cpp.

374 {
375  if( !ShouldSet() ) return;
376  mpEap->WriteFloat(key, var);
377 }

References key, ShuttleParams::mpEap, ShuttleParams::ShouldSet(), and CommandParameters::WriteFloat().

Here is the call graph for this function:

◆ Define() [4/7]

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

Reimplemented from ShuttleParams.

Definition at line 379 of file Shuttle.cpp.

380 {
381  if( !ShouldSet() ) return;
382  mpEap->WriteFloat(key, var);
383 }

References key, ShuttleParams::mpEap, ShuttleParams::ShouldSet(), and CommandParameters::WriteFloat().

Here is the call graph for this function:

◆ Define() [5/7]

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

Reimplemented from ShuttleParams.

Definition at line 361 of file Shuttle.cpp.

362 {
363  if( !ShouldSet() ) return;
364  mpEap->Write(key, var);
365 }

References key, ShuttleParams::mpEap, and ShuttleParams::ShouldSet().

Here is the call graph for this function:

◆ Define() [6/7]

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

Reimplemented from ShuttleParams.

Definition at line 367 of file Shuttle.cpp.

368 {
369  if( !ShouldSet() ) return;
370  mpEap->Write(key, (int) var);
371 }

References key, ShuttleParams::mpEap, and ShuttleParams::ShouldSet().

Here is the call graph for this function:

◆ Define() [7/7]

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

Reimplemented from ShuttleParams.

Definition at line 392 of file Shuttle.cpp.

393 {
394  if( !ShouldSet() ) return;
395  mpEap->Write(key, var);
396 }

References key, ShuttleParams::mpEap, and ShuttleParams::ShouldSet().

Here is the call graph for this function:

◆ DefineEnum()

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

Reimplemented from ShuttleParams.

Definition at line 399 of file Shuttle.cpp.

400 {
401  if( !ShouldSet() ) return;
402  mpEap->Write(key, strings[var].Internal());
403 }

References Internal, key, ShuttleParams::mpEap, and ShuttleParams::ShouldSet().

Here is the call graph for this function:

◆ Optional()

ShuttleParams & ShuttleGetAutomation::Optional ( bool &  var)
override

Definition at line 350 of file Shuttle.cpp.

350  {
351  pOptionalFlag = &var;
352  return *this;
353 };

References ShuttleParams::pOptionalFlag.


The documentation for this class was generated from the following files:
CommandParameters::WriteFloat
bool WriteFloat(const wxString &key, float f)
Definition: EffectAutomationParameters.h:155
ShuttleParams::mpEap
CommandParameters * mpEap
Definition: Shuttle.h:66
ShuttleParams::ShouldSet
bool ShouldSet()
Definition: Shuttle.cpp:324
key
static const AudacityProject::AttachedObjects::RegisteredFactory key
Definition: CommandManager.cpp:201
ExceptionType::Internal
@ Internal
Indicates internal failure from Audacity.
ShuttleParams::pOptionalFlag
bool * pOptionalFlag
Definition: Shuttle.h:65