EffectUIClientInterface Class Reference

EffectUIClientInterface is an abstract base class to populate a UI and validate UI values. It can import and export presets. More...

#include <EffectInterface.h>

Inheritance diagram for EffectUIClientInterface:

Public Member Functions
virtual	~EffectUIClientInterface ()
virtual int	ShowClientInterface (wxWindow &parent, wxDialog &dialog, bool forceModal=false)=0
virtual bool	IsGraphicalUI ()=0
virtual std::unique_ptr< EffectUIValidator >	PopulateUI (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access)=0
	Adds controls to a panel that is given as the parent window of S More...
virtual bool	CanExportPresets ()=0
virtual void	ExportPresets (const EffectSettings &settings) const =0
virtual void	ImportPresets (EffectSettings &settings)=0
virtual bool	HasOptions ()=0
virtual void	ShowOptions ()=0

Protected Member Functions
virtual bool	ValidateUI (EffectSettings &settings)=0
virtual bool	CloseUI ()=0

Protected Attributes
friend	EffectUIValidator
friend	DefaultEffectUIValidator

Detailed Description

EffectUIClientInterface is an abstract base class to populate a UI and validate UI values. It can import and export presets.

Definition at line 569 of file EffectInterface.h.

Constructor & Destructor Documentation

~EffectUIClientInterface()

EffectUIClientInterface::~EffectUIClientInterface ( )

virtualdefault

Member Function Documentation

CanExportPresets()

virtual bool EffectUIClientInterface::CanExportPresets ( )

pure virtual

Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::OnMenu().

Here is the caller graph for this function:

CloseUI()

virtual bool EffectUIClientInterface::CloseUI ( )

protectedpure virtual

Implemented in AudioUnitEffect, Effect, EffectEqualization, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIValidator::~EffectUIValidator().

Here is the caller graph for this function:

ExportPresets()

virtual void EffectUIClientInterface::ExportPresets ( const EffectSettings &  settings ) const

pure virtual

Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::OnExport().

Here is the caller graph for this function:

HasOptions()

virtual bool EffectUIClientInterface::HasOptions ( )

pure virtual

Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::OnMenu().

Here is the caller graph for this function:

ImportPresets()

virtual void EffectUIClientInterface::ImportPresets ( EffectSettings &  settings )

pure virtual

Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::OnImport().

Here is the caller graph for this function:

IsGraphicalUI()

virtual bool EffectUIClientInterface::IsGraphicalUI ( )

pure virtual

Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::BuildButtonBar().

Here is the caller graph for this function:

PopulateUI()

virtual std::unique_ptr< EffectUIValidator > EffectUIClientInterface::PopulateUI ( ShuttleGui &  S, EffectInstance &  instance, EffectSettingsAccess &  access  )

pure virtual

Adds controls to a panel that is given as the parent window of S

Parameters

S	interface for adding controls to a panel in a dialog
instance	guaranteed to have a lifetime containing that of the returned object
access	guaranteed to have a lifetime containing that of the returned object

Returns

null for failure; else an object invoked to retrieve values of UI controls; it might also hold some state needed to implement event handlers of the controls; it will exist only while the dialog continues to exist

Implemented in AudioUnitEffect, Effect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::Initialize().

Here is the caller graph for this function:

ShowClientInterface()

virtual int EffectUIClientInterface::ShowClientInterface ( wxWindow &  parent, wxDialog &  dialog, bool  forceModal = false  )

pure virtual

Returns

0 if destructive effect processing should not proceed (and there may be a non-modal dialog still opened); otherwise, modal dialog return code

Implemented in AudioUnitEffect, LadspaEffect, LV2Effect, VSTEffect, VST3Effect, and Effect.

Referenced by EffectNoiseReduction::TrackProgress().

Here is the caller graph for this function:

ShowOptions()

virtual void EffectUIClientInterface::ShowOptions ( )

pure virtual

Implemented in AudioUnitEffect, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by EffectUIHost::OnOptions().

Here is the caller graph for this function:

ValidateUI()

virtual bool EffectUIClientInterface::ValidateUI ( EffectSettings &  settings )

protectedpure virtual

Implemented in Effect, EffectEqualization, LV2Effect, VSTEffect, and VST3Effect.

Referenced by DefaultEffectUIValidator::ValidateUI().

Here is the caller graph for this function:

Member Data Documentation

DefaultEffectUIValidator

friend EffectUIClientInterface::DefaultEffectUIValidator

protected

Definition at line 608 of file EffectInterface.h.

EffectUIValidator

friend EffectUIClientInterface::EffectUIValidator

protected

Definition at line 607 of file EffectInterface.h.

---

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

• EffectInterface.h
• EffectInterface.cpp