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

Shuttle that sets parameters to their default values. More...

#include <Shuttle.h>

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

Public Member Functions

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

Public Attributes

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

Detailed Description

Shuttle that sets parameters to their default values.

Definition at line 130 of file Shuttle.h.

Member Function Documentation

◆ Define() [1/7]

void ShuttleDefaults::Define ( bool &  var,
const wxChar *  WXUNUSEDkey,
const bool  vdefault,
const bool   WXUNUSEDvmin,
const bool   WXUNUSEDvmax,
const bool   WXUNUSEDvscl 
)
inlineoverride

Definition at line 138 of file Shuttle.h.

140  { var = vdefault;};

◆ Define() [2/7]

void ShuttleDefaults::Define ( double &  var,
const wxChar *  WXUNUSEDkey,
const double  vdefault,
const double   WXUNUSEDvmin,
const double   WXUNUSEDvmax,
const double   WXUNUSEDvscl 
)
inlineoverride

Definition at line 153 of file Shuttle.h.

155  { var = vdefault;};

◆ Define() [3/7]

void ShuttleDefaults::Define ( double &  var,
const wxChar *  WXUNUSEDkey,
const float  vdefault,
const float   WXUNUSEDvmin,
const float   WXUNUSEDvmax,
const float   WXUNUSEDvscl 
)
inlineoverride

Definition at line 150 of file Shuttle.h.

152  { var = vdefault;};

◆ Define() [4/7]

void ShuttleDefaults::Define ( float &  var,
const wxChar *  WXUNUSEDkey,
const float  vdefault,
const float   WXUNUSEDvmin,
const float   WXUNUSEDvmax,
const float   WXUNUSEDvscl 
)
inlineoverride

Definition at line 147 of file Shuttle.h.

149  { var = vdefault;};

◆ Define() [5/7]

void ShuttleDefaults::Define ( int &  var,
const wxChar *  WXUNUSEDkey,
const int  vdefault,
const int   WXUNUSEDvmin,
const int   WXUNUSEDvmax,
const int   WXUNUSEDvscl 
)
inlineoverride

Definition at line 141 of file Shuttle.h.

143  { var = vdefault;};

◆ Define() [6/7]

void ShuttleDefaults::Define ( size_t &  var,
const wxChar *  WXUNUSEDkey,
const int  vdefault,
const int   WXUNUSEDvmin,
const int   WXUNUSEDvmax,
const int   WXUNUSEDvscl 
)
inlineoverride

Definition at line 144 of file Shuttle.h.

146  { var = vdefault;};

◆ Define() [7/7]

void ShuttleDefaults::Define ( wxString &  var,
const wxChar *  WXUNUSEDkey,
const wxString  vdefault,
const wxString   WXUNUSEDvmin,
const wxString   WXUNUSEDvmax,
const wxString   WXUNUSEDvscl 
)
inlineoverride

Definition at line 156 of file Shuttle.h.

158  { var = vdefault;};

◆ DefineEnum()

void ShuttleDefaults::DefineEnum ( int &  var,
const wxChar *  WXUNUSEDkey,
const int  vdefault,
const EnumValueSymbol   WXUNUSED(strings)[],
size_t   WXUNUSEDnStrings 
)
inlineoverride

Definition at line 159 of file Shuttle.h.

161  { var = vdefault;};

◆ Optional()

virtual ShuttleParams& ShuttleDefaults::Optional ( bool &  var)
inlineoverridevirtual

Definition at line 134 of file Shuttle.h.

134 { var = true; pOptionalFlag = NULL;return *this;};

References ShuttleParams::pOptionalFlag.

◆ OptionalN()

virtual ShuttleParams& ShuttleDefaults::OptionalN ( bool &  var)
inlineoverridevirtual

Reimplemented from ShuttleParams.

Definition at line 136 of file Shuttle.h.

136 { var = false;pOptionalFlag = NULL;return *this;};

References ShuttleParams::pOptionalFlag.

◆ OptionalY()

virtual ShuttleParams& ShuttleDefaults::OptionalY ( bool &  var)
inlineoverridevirtual

Reimplemented from ShuttleParams.

Definition at line 135 of file Shuttle.h.

135 { var = true; pOptionalFlag = NULL;return *this;};

References ShuttleParams::pOptionalFlag.

Member Data Documentation

◆ Result

wxString ShuttleDefaults::Result

Definition at line 133 of file Shuttle.h.


The documentation for this class was generated from the following file:
ShuttleParams::pOptionalFlag
bool * pOptionalFlag
Definition: Shuttle.h:65