Audacity  2.2.2
Public Member Functions | Public Attributes | List of all members
ShuttleParams Class Reference

Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothing by default. More...

#include <Shuttle.h>

Inheritance diagram for ShuttleParams:
Shuttle ShuttleDefaults ShuttleGetAutomation ShuttleGetDefinition ShuttleSetAutomation

Public Member Functions

 ShuttleParams ()
 
virtual ~ShuttleParams ()
 
bool ExchangeWithMaster (const wxString &Name) override
 
bool ShouldSet ()
 
virtual ShuttleParamsOptional (bool &WXUNUSED(var))
 
virtual ShuttleParamsOptionalY (bool &var)
 
virtual ShuttleParamsOptionalN (bool &var)
 
virtual void Define (bool &var, const wxChar *key, const bool vdefault, const bool vmin=false, const bool vmax=false, const bool vscl=false)
 
virtual void Define (size_t &var, const wxChar *key, const int vdefault, const int vmin=0, const int vmax=100000, const int vscl=1)
 
virtual void Define (int &var, const wxChar *key, const int vdefault, const int vmin=0, const int vmax=100000, const int vscl=1)
 
virtual void Define (float &var, const wxChar *key, const float vdefault, const float vmin, const float vmax, const float vscl=1.0f)
 
virtual void Define (double &var, const wxChar *key, const float vdefault, const float vmin, const float vmax, const float vscl=1.0f)
 
virtual void Define (double &var, const wxChar *key, const double vdefault, const double vmin, const double vmax, const double vscl=1.0f)
 
virtual void Define (wxString &var, const wxChar *key, const wxString vdefault, const wxString vmin="", const wxString vmax="", const wxString vscl="")
 
virtual void DefineEnum (int &var, const wxChar *key, const int vdefault, const IdentInterfaceSymbol strings[], size_t nStrings)
 
- 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)
 

Public Attributes

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

Detailed Description

Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothing by default.

Definition at line 60 of file Shuttle.h.

Constructor & Destructor Documentation

ShuttleParams::ShuttleParams ( )
inline

Definition at line 66 of file Shuttle.h.

References mParams, mpEap, and pOptionalFlag.

66 { mParams = wxT("") ;mpEap=NULL;pOptionalFlag=NULL;}
wxString mParams
Definition: Shuttle.h:63
CommandParameters * mpEap
Definition: Shuttle.h:65
bool * pOptionalFlag
Definition: Shuttle.h:64
virtual ShuttleParams::~ShuttleParams ( )
inlinevirtual

Definition at line 67 of file Shuttle.h.

67 {}

Member Function Documentation

void ShuttleParams::Define ( bool &  var,
const wxChar *  key,
const bool  vdefault,
const bool  vmin = false,
const bool  vmax = false,
const bool  vscl = false 
)
virtual
void ShuttleParams::Define ( size_t &  var,
const wxChar *  key,
const int  vdefault,
const int  vmin = 0,
const int  vmax = 100000,
const int  vscl = 1 
)
virtual

Reimplemented in ShuttleGetDefinition, ShuttleSetAutomation, and ShuttleGetAutomation.

Definition at line 340 of file Shuttle.cpp.

340 {;};
void ShuttleParams::Define ( int &  var,
const wxChar *  key,
const int  vdefault,
const int  vmin = 0,
const int  vmax = 100000,
const int  vscl = 1 
)
virtual

Reimplemented in ShuttleGetDefinition, ShuttleSetAutomation, and ShuttleGetAutomation.

Definition at line 341 of file Shuttle.cpp.

341 {;};
void ShuttleParams::Define ( float &  var,
const wxChar *  key,
const float  vdefault,
const float  vmin,
const float  vmax,
const float  vscl = 1.0f 
)
virtual

Reimplemented in ShuttleGetDefinition, ShuttleSetAutomation, and ShuttleGetAutomation.

Definition at line 342 of file Shuttle.cpp.

342 {;};
void ShuttleParams::Define ( double &  var,
const wxChar *  key,
const float  vdefault,
const float  vmin,
const float  vmax,
const float  vscl = 1.0f 
)
virtual

Reimplemented in ShuttleGetDefinition, ShuttleSetAutomation, and ShuttleGetAutomation.

Definition at line 343 of file Shuttle.cpp.

343 {;};
void ShuttleParams::Define ( double &  var,
const wxChar *  key,
const double  vdefault,
const double  vmin,
const double  vmax,
const double  vscl = 1.0f 
)
virtual

Reimplemented in ShuttleGetDefinition, ShuttleSetAutomation, and ShuttleGetAutomation.

Definition at line 344 of file Shuttle.cpp.

344 {;};
void ShuttleParams::Define ( wxString &  var,
const wxChar *  key,
const wxString  vdefault,
const wxString  vmin = "",
const wxString  vmax = "",
const wxString  vscl = "" 
)
virtual

Reimplemented in ShuttleGetDefinition, ShuttleSetAutomation, and ShuttleGetAutomation.

Definition at line 345 of file Shuttle.cpp.

345 {;};
void ShuttleParams::DefineEnum ( int &  var,
const wxChar *  key,
const int  vdefault,
const IdentInterfaceSymbol  strings[],
size_t  nStrings 
)
virtual
bool ShuttleParams::ExchangeWithMaster ( const wxString &  Name)
overridevirtual

Reimplemented from Shuttle.

Definition at line 311 of file Shuttle.cpp.

312 {
313  return true;
314 }
virtual ShuttleParams& ShuttleParams::Optional ( bool &  WXUNUSEDvar)
inlinevirtual

Definition at line 70 of file Shuttle.h.

References pOptionalFlag.

Referenced by OptionalN(), and OptionalY().

70 { pOptionalFlag = NULL;return *this;};
bool * pOptionalFlag
Definition: Shuttle.h:64
virtual ShuttleParams& ShuttleParams::OptionalN ( bool &  var)
inlinevirtual
virtual ShuttleParams& ShuttleParams::OptionalY ( bool &  var)
inlinevirtual
bool ShuttleParams::ShouldSet ( )

Definition at line 331 of file Shuttle.cpp.

References pOptionalFlag.

Referenced by ShuttleGetAutomation::Define(), and ShuttleGetAutomation::DefineEnum().

331  {
332  if( !pOptionalFlag )
333  return true;
334  bool result = *pOptionalFlag;
335  pOptionalFlag = NULL;
336  return result;
337 }
bool * pOptionalFlag
Definition: Shuttle.h:64

Member Data Documentation

wxString ShuttleParams::mParams

Definition at line 63 of file Shuttle.h.

Referenced by ShuttleParams().

CommandParameters* ShuttleParams::mpEap
bool* ShuttleParams::pOptionalFlag

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