Audacity 3.2.0
ShuttleGetDefinition.h
Go to the documentation of this file.
1/**********************************************************************
2
3 Audacity: A Digital Audio Editor
4
5 ShuttleGetDefinition.h
6
7 Paul Licameli split this out of Shuttle.h
8
9**********************************************************************/
10
11#ifndef __AUDACITY_SHUTTLE_GET_DEFINITION__
12#define __AUDACITY_SHUTTLE_GET_DEFINITION__
13
14#include "Shuttle.h" // to inherit
15#include "commands/CommandTargets.h" // to inherit
16
17/**************************************************************************/
20class AUDACITY_DLL_API ShuttleGetDefinition final
22{
23public:
25 wxString Result;
26 bool IsOptional();
27 ConstSettingsVisitor & Optional( const bool & var ) override;
28 void Define(bool var, const wxChar * key, bool vdefault,
29 bool vmin, bool vmax, bool vscl) override;
30 void Define(int var, const wxChar * key, int vdefault,
31 int vmin, int vmax, int vscl) override;
32 void Define(size_t var, const wxChar * key, int vdefault,
33 int vmin, int vmax, int vscl) override;
34 void Define(float var, const wxChar * key, float vdefault,
35 float vmin, float vmax, float vscl) override;
36 void Define(double var, const wxChar * key, float vdefault,
37 float vmin, float vmax, float vscl) override;
38 void Define(double var, const wxChar * key, double vdefault,
39 double vmin, double vmax, double vscl) override;
40 void Define(const wxString &var, const wxChar * key, wxString vdefault,
41 wxString vmin, wxString vmax, wxString vscl) override;
42 void DefineEnum( int var, const wxChar * key, int vdefault,
43 const EnumValueSymbol strings[], size_t nStrings) override;
44};
45
46#endif
static const AudacityProject::AttachedObjects::RegisteredFactory key
CommandMessageTargetDecorator is a CommandOutputTarget that forwards its work on to another one....
Interface for objects that can receive (string) messages from a command.
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Visitor of effect or command parameters. This is a base class with lots of virtual functions that do ...
Definition: Shuttle.h:115
virtual void Define(Arg< bool > var, const wxChar *key, bool vdefault, bool vmin=false, bool vmax=false, bool vscl=false)
Definition: Shuttle.cpp:359
virtual SettingsVisitorBase & Optional(Ref< bool > var)
Definition: Shuttle.cpp:322
virtual void DefineEnum(Arg< int > var, const wxChar *key, int vdefault, const EnumValueSymbol strings[], size_t nStrings)
Definition: Shuttle.cpp:394
SettingsVisitor that retrieves a JSON format definition of a command's parameters.