Audacity 3.2.0
Public Member Functions | List of all members
DefaultEffectUIValidator Class Reference

Default implementation of EffectUIValidator invokes ValidateUI method of an EffectUIClientInterface. More...

#include <EffectInterface.h>

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

Public Member Functions

 ~DefaultEffectUIValidator () override
 
bool ValidateUI () override
 Calls mEffect.ValidateUI() More...
 
 EffectUIValidator (EffectUIClientInterface &effect, EffectSettingsAccess &access)
 
- 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...
 

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
 

Detailed Description

Default implementation of EffectUIValidator invokes ValidateUI method of an EffectUIClientInterface.

This is a transitional class; it should be eliminated when all effect classes define their own associated subclasses of EffectUIValidator, which can hold state only for the lifetime of a dialog, so the effect object need not hold it

Definition at line 544 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ ~DefaultEffectUIValidator()

DefaultEffectUIValidator::~DefaultEffectUIValidator ( )
overridedefault

Member Function Documentation

◆ EffectUIValidator()

EffectUIValidator::EffectUIValidator ( EffectUIClientInterface effect,
EffectSettingsAccess access 
)

Definition at line 500 of file EffectInterface.cpp.

190 : mEffect{effect}
191 , mAccess{access}
192{}
EffectSettingsAccess & mAccess
EffectUIClientInterface & mEffect

◆ ValidateUI()

bool DefaultEffectUIValidator::ValidateUI ( )
overridevirtual

Calls mEffect.ValidateUI()

Implements EffectUIValidator.

Definition at line 206 of file EffectInterface.cpp.

207{
208 bool result {};
210 result = mEffect.ValidateUI(settings);
211 });
212 return result;
213}
static Settings & settings()
Definition: TrackInfo.cpp:87
void ModifySettings(Function &&function)
Do a correct read-modify-write of settings.
virtual bool ValidateUI(EffectSettings &settings)=0
Externalized state of a plug-in.

References EffectUIValidator::mAccess, EffectUIValidator::mEffect, EffectSettingsAccess::ModifySettings(), settings(), and EffectUIClientInterface::ValidateUI().

Here is the call graph for this function:

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