Audacity  2.3.1
Public Member Functions | List of all members
ShuttleGetAutomation Class Reference

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

#include <Shuttle.h>

Inheritance diagram for ShuttleGetAutomation:
ShuttleParams Shuttle

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 ComponentInterfaceSymbol strings[], size_t nStrings) override
 
- Public Member Functions inherited from ShuttleParams
 ShuttleParams ()
 
virtual ~ShuttleParams ()
 
bool ExchangeWithMaster (const wxString &Name) override
 
bool ShouldSet ()
 
virtual ShuttleParamsOptional (bool &WXUNUSED(var))
 
virtual ShuttleParamsOptionalY (bool &var)
 
virtual ShuttleParamsOptionalN (bool &var)
 
- Public Member Functions inherited from Shuttle
 Shuttle ()
 
virtual ~Shuttle ()
 
virtual bool TransferBool (const wxString &Name, bool &bValue, const bool &bDefault)
 
virtual bool TransferFloat (const wxString &Name, float &fValue, const float &fDefault)
 
virtual bool TransferDouble (const wxString &Name, double &dValue, const double &dDefault)
 
virtual bool TransferInt (const wxString &Name, int &iValue, const int &iDefault)
 
virtual bool TransferInt (const wxString &Name, wxLongLong_t &iValue, const wxLongLong_t &iDefault)
 
virtual bool TransferLongLong (const wxString &Name, wxLongLong_t &iValue, const wxLongLong_t &iDefault)
 
virtual bool TransferString (const wxString &Name, wxString &strValue, const wxString &strDefault)
 
virtual bool TransferEnum (const wxString &Name, int &iValue, const int nChoices, const wxString *pFirstStr)
 
virtual bool TransferWrappedType (const wxString &Name, WrappedType &W)
 

Additional Inherited Members

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

Detailed Description

Shuttle that gets parameter values into a string.

Definition at line 87 of file Shuttle.h.

Member Function Documentation

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 361 of file Shuttle.cpp.

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

362 {
363  if( !ShouldSet() ) return;
364  mpEap->Write(key, var);
365 }
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
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 367 of file Shuttle.cpp.

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

368 {
369  if( !ShouldSet() ) return;
370  mpEap->Write(key, var);
371 }
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
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 373 of file Shuttle.cpp.

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

374 {
375  if( !ShouldSet() ) return;
376  mpEap->Write(key, var);
377 }
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
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 385 of file Shuttle.cpp.

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

386 {
387  if( !ShouldSet() ) return;
388  mpEap->WriteFloat(key, var);
389 }
bool WriteFloat(const wxString &key, float f)
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
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 379 of file Shuttle.cpp.

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

380 {
381  if( !ShouldSet() ) return;
382  mpEap->WriteFloat(key, var);
383 }
bool WriteFloat(const wxString &key, float f)
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
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 391 of file Shuttle.cpp.

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

392 {
393  if( !ShouldSet() ) return;
394  mpEap->Write(key, var);
395 }
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
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 398 of file Shuttle.cpp.

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

399 {
400  if( !ShouldSet() ) return;
401  mpEap->Write(key, var);
402 }
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
void ShuttleGetAutomation::DefineEnum ( int &  var,
const wxChar *  key,
const int  vdefault,
const ComponentInterfaceSymbol  strings[],
size_t  nStrings 
)
overridevirtual

Reimplemented from ShuttleParams.

Definition at line 405 of file Shuttle.cpp.

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

406 {
407  if( !ShouldSet() ) return;
408  mpEap->Write(key, strings[var].Internal());
409 }
CommandParameters * mpEap
Definition: Shuttle.h:65
bool ShouldSet()
Definition: Shuttle.cpp:330
ShuttleParams & ShuttleGetAutomation::Optional ( bool &  var)
override

Definition at line 356 of file Shuttle.cpp.

References ShuttleParams::pOptionalFlag.

356  {
357  pOptionalFlag = &var;
358  return *this;
359 };
bool * pOptionalFlag
Definition: Shuttle.h:64

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