Audacity 3.2.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EffectUIValidator Class Referenceabstract

Interface for transferring values from a panel of effect controls. More...

#include <EffectInterface.h>

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

Public Member Functions

 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...
 

Protected Member Functions

template<typename EventTag , typename Class , typename Event >
void BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
 

Protected Attributes

EffectUIClientInterfacemEffect
 
EffectSettingsAccessmAccess
 

Detailed Description

Interface for transferring values from a panel of effect controls.

Definition at line 497 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ EffectUIValidator()

EffectUIValidator::EffectUIValidator ( EffectUIClientInterface effect,
EffectSettingsAccess access 
)

Definition at line 188 of file EffectInterface.cpp.

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

◆ ~EffectUIValidator()

EffectUIValidator::~EffectUIValidator ( )
virtual

Definition at line 194 of file EffectInterface.cpp.

195{
197}
virtual bool CloseUI()=0

References EffectUIClientInterface::CloseUI(), and mEffect.

Here is the call graph for this function:

Member Function Documentation

◆ BindTo()

template<typename EventTag , typename Class , typename Event >
void EffectUIValidator::BindTo ( wxEvtHandler &  src,
const EventTag &  eventType,
void(Class::*)(Event &)  pmf 
)
inlineprotected

Definition at line 522 of file EffectInterface.h.

524 {
525 src.Bind(eventType, pmf, static_cast<Class *>(this));
526 }

◆ UpdateUI()

bool EffectUIValidator::UpdateUI ( )
virtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns
true if successful

Reimplemented in AudioUnitValidator, EffectDtmf::Validator, EffectEcho::Validator, LadspaEffect::Validator, EffectReverb::Validator, and EffectWahwah::Validator.

Definition at line 199 of file EffectInterface.cpp.

200{
201 return true;
202}

◆ ValidateUI()

virtual bool EffectUIValidator::ValidateUI ( )
pure virtual

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

Returns
true only if panel settings are acceptable

Implemented in DefaultEffectUIValidator, AudioUnitValidator, EffectDtmf::Validator, EffectEcho::Validator, LadspaEffect::Validator, EffectReverb::Validator, and EffectWahwah::Validator.

Member Data Documentation

◆ mAccess

EffectSettingsAccess& EffectUIValidator::mAccess
protected

◆ mEffect

EffectUIClientInterface& EffectUIValidator::mEffect
protected

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