EffectUIValidator Class Reference

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

#include <EffectInterface.h>

Inheritance diagram for EffectUIValidator:

Collaboration diagram for EffectUIValidator:

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...
virtual bool	IsGraphicalUI ()
virtual void	Disconnect ()
	On the first call only, may disconnect from further event handling. More...
virtual void	OnClose ()

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

Protected Attributes
EffectUIClientInterface &	mEffect
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Interface for transferring values from a panel of effect controls.

Definition at line 564 of file EffectInterface.h.

Constructor & Destructor Documentation

EffectUIValidator()

EffectUIValidator::EffectUIValidator	(	EffectUIClientInterface &	effect,
		EffectSettingsAccess &	access
	)

Definition at line 199 of file EffectInterface.cpp.

   : mEffect{effect}
   , mAccess{access}
{}

~EffectUIValidator()

EffectUIValidator::~EffectUIValidator ( )

virtualdefault

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 606 of file EffectInterface.h.

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

Disconnect()

void EffectUIValidator::Disconnect ( )

virtual

On the first call only, may disconnect from further event handling.

Default implemantation does nothing

Reimplemented in DefaultEffectUIValidator, and LV2Validator.

Definition at line 217 of file EffectInterface.cpp.

{
}

IsGraphicalUI()

bool EffectUIValidator::IsGraphicalUI ( )

virtual

Default implementation returns false

Returns

true if using a native plug-in UI, not widgets

Reimplemented in AudioUnitValidator, DefaultEffectUIValidator, LV2Validator, and VST3UIValidator.

Definition at line 212 of file EffectInterface.cpp.

{
   return false;
}

OnClose()

void EffectUIValidator::OnClose ( )

virtual

Handle the UI OnClose event. Default implementation calls mEffect.CloseUI()

Reimplemented in VST3UIValidator.

Definition at line 221 of file EffectInterface.cpp.

{
   if (!mUIClosed)
   {
      mEffect.CloseUI();
      mUIClosed = true;
   }
}

References EffectUIClientInterface::CloseUI(), mEffect, and mUIClosed.

Referenced by VST3UIValidator::OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

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, LV2Validator, EffectReverb::Validator, VST3UIValidator, and EffectWahwah::Validator.

Definition at line 207 of file EffectInterface.cpp.

{
   return true;
}

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 AudioUnitValidator, EffectDtmf::Validator, EffectEcho::Validator, DefaultEffectUIValidator, LadspaEffect::Validator, LV2Validator, EffectReverb::Validator, VST3UIValidator, and EffectWahwah::Validator.

Member Data Documentation

mAccess

EffectSettingsAccess& EffectUIValidator::mAccess

protected

Definition at line 613 of file EffectInterface.h.

Referenced by AudioUnitValidator::AudioUnitValidator(), LV2Validator::OnChoice(), VST3UIValidator::OnClose(), LV2Validator::OnIdle(), LV2Validator::OnSlider(), LV2Validator::OnText(), LV2Validator::OnToggle(), LV2Validator::OnTrigger(), LV2Validator::suil_port_write(), AudioUnitValidator::UpdateUI(), LV2Validator::UpdateUI(), VST3UIValidator::UpdateUI(), AudioUnitValidator::ValidateUI(), DefaultEffectUIValidator::ValidateUI(), LV2Validator::ValidateUI(), EffectReverb::Validator::ValidateUI(), VST3UIValidator::ValidateUI(), EffectWahwah::Validator::ValidateUI(), and VST3UIValidator::VST3UIValidator().

mEffect

EffectUIClientInterface& EffectUIValidator::mEffect

protected

Definition at line 612 of file EffectInterface.h.

Referenced by EffectWahwah::Validator::EnableApplyFromTransferDataToWindow(), EffectWahwah::Validator::EnableApplyFromValidate(), LadspaEffect::Validator::GetEffect(), EffectDtmf::Validator::GetEffect(), EffectEcho::Validator::GetEffect(), EffectReverb::Validator::GetEffect(), EffectWahwah::Validator::GetEffect(), DefaultEffectUIValidator::IsGraphicalUI(), OnClose(), and DefaultEffectUIValidator::ValidateUI().

mUIClosed

bool EffectUIValidator::mUIClosed { false }

protected

Definition at line 615 of file EffectInterface.h.

Referenced by OnClose().

---

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

• EffectInterface.h
• EffectInterface.cpp