Audacity 3.2.0
Public Member Functions | Public Attributes | List of all members
EffectEcho::Validator Struct Reference
Inheritance diagram for EffectEcho::Validator:
[legend]
Collaboration diagram for EffectEcho::Validator:
[legend]

Public Member Functions

 Validator (EffectUIClientInterface &effect, EffectSettingsAccess &access, const EffectEchoSettings &settings)
 
virtual ~Validator ()=default
 
EffectGetEffect () const
 
bool ValidateUI () override
 Get settings data from the panel; may make error dialogs and return false. More...
 
bool UpdateUI () override
 Update appearance of the panel for changes in settings. More...
 
void PopulateOrExchange (ShuttleGui &S)
 
- Public Member Functions inherited from EffectUIValidator
 EffectUIValidator (EffectUIClientInterface &effect, EffectSettingsAccess &access)
 
virtual ~EffectUIValidator ()
 
virtual bool ValidateUI ()=0
 Get settings data from the panel; may make error dialogs and return false. More...
 
virtual bool UpdateUI ()
 Update appearance of the panel for changes in settings. More...
 
virtual bool IsGraphicalUI ()
 
virtual void Disconnect ()
 On the first call only, may disconnect from further event handling. More...
 
virtual void OnClose ()
 

Public Attributes

EffectEchoSettings mSettings
 

Additional Inherited Members

- Protected Member Functions inherited from EffectUIValidator
template<typename EventTag , typename Class , typename Event >
void BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
 
- Protected Attributes inherited from EffectUIValidator
EffectUIClientInterfacemEffect
 
EffectSettingsAccessmAccess
 
bool mUIClosed { false }
 

Detailed Description

Definition at line 174 of file Echo.cpp.

Constructor & Destructor Documentation

◆ Validator()

EffectEcho::Validator::Validator ( EffectUIClientInterface effect,
EffectSettingsAccess access,
const EffectEchoSettings settings 
)
inline

Definition at line 177 of file Echo.cpp.

179 : EffectUIValidator{ effect, access }
181 {}
static Settings & settings()
Definition: TrackInfo.cpp:87
Interface for transferring values from a panel of effect controls.
EffectEchoSettings mSettings
Definition: Echo.cpp:191

◆ ~Validator()

virtual EffectEcho::Validator::~Validator ( )
virtualdefault

Member Function Documentation

◆ GetEffect()

Effect & EffectEcho::Validator::GetEffect ( ) const
inline

Definition at line 184 of file Echo.cpp.

184{ return static_cast<Effect&>(mEffect); }
Base class for many of the effects in Audacity.
Definition: Effect.h:63
EffectUIClientInterface & mEffect

References EffectUIValidator::mEffect.

◆ PopulateOrExchange()

void EffectEcho::Validator::PopulateOrExchange ( ShuttleGui S)

Definition at line 207 of file Echo.cpp.

208{
209 auto& echoSettings = mSettings;
210
211 S.AddSpace(0, 5);
212
213 S.StartMultiColumn(2, wxALIGN_CENTER);
214 {
215 S.Validator<FloatingPointValidator<double>>(
216 3, &echoSettings.delay, NumValidatorStyle::NO_TRAILING_ZEROES,
217 Delay.min, Delay.max )
218 .AddTextBox(XXO("&Delay time (seconds):"), L"", 10);
219
220 S.Validator<FloatingPointValidator<double>>(
221 3, &echoSettings.decay, NumValidatorStyle::NO_TRAILING_ZEROES,
223 .AddTextBox(XXO("D&ecay factor:"), L"", 10);
224 }
225 S.EndMultiColumn();
226}
#define XXO(s)
Definition: Internat.h:44
#define S(N)
Definition: ToChars.cpp:64
static constexpr EffectParameter Decay
Definition: Echo.h:81
static constexpr EffectParameter Delay
Definition: Echo.h:79
const Type min
Minimum value.
Definition: Shuttle.h:30
const Type max
Maximum value.
Definition: Shuttle.h:31

References EffectEcho::Decay, EffectEcho::Delay, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, S, and XXO.

◆ UpdateUI()

bool EffectEcho::Validator::UpdateUI ( )
overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns
true if successful

Reimplemented from EffectUIValidator.

Definition at line 245 of file Echo.cpp.

246{
247 // get the settings from the MessageBuffer and write them to our local copy
248 const auto& settings = mAccess.Get();
249
251
252 return true;
253}
virtual const EffectSettings & Get()=0
EffectSettingsAccess & mAccess
static EffectEchoSettings & GetSettings(EffectSettings &settings)
Assume settings originated from MakeSettings() and copies thereof.
Definition: Effect.h:330

References EffectWithSettings< EffectEchoSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

◆ ValidateUI()

bool EffectEcho::Validator::ValidateUI ( )
overridevirtual

Get settings data from the panel; may make error dialogs and return false.

Returns
true only if panel settings are acceptable

Implements EffectUIValidator.

Definition at line 229 of file Echo.cpp.

230{
232 (
233 [this](EffectSettings& settings)
234 {
235 // pass back the modified settings to the MessageBuffer
236
238 }
239 );
240
241 return true;
242}
void ModifySettings(Function &&function)
Do a correct read-modify-write of settings.
Externalized state of a plug-in.

References EffectWithSettings< EffectEchoSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

Member Data Documentation

◆ mSettings

EffectEchoSettings EffectEcho::Validator::mSettings

Definition at line 191 of file Echo.cpp.


The documentation for this struct was generated from the following file: