Audacity 3.2.0
Public Member Functions | List of all members
EffectUIClientInterface Class Referenceabstract

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:
[legend]

Public Member Functions

virtual ~EffectUIClientInterface ()
 
virtual int ShowClientInterface (wxWindow &parent, wxDialog &dialog, EffectUIValidator *pValidator, bool forceModal=false)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual std::unique_ptr< EffectUIValidatorPopulateUI (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
 
virtual bool ValidateUI (EffectSettings &settings)=0
 
virtual bool CloseUI ()=0
 

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 626 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 ( )
pure virtual

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

Referenced by EffectUIValidator::OnClose().

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
Returns
true if using a native plug-in UI, not widgets

Implemented in Effect, and VSTEffect.

Referenced by DefaultEffectUIValidator::IsGraphicalUI().

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
Sinterface for adding controls to a panel in a dialog
instanceguaranteed to have a lifetime containing that of the returned object
accessguaranteed 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,
EffectUIValidator pValidator,
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, Effect, LadspaEffect, LV2Effect, VSTEffect, and VST3Effect.

Referenced by RealtimeEffectStateUI::Show(), and Effect::ShowHostInterface().

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)
pure virtual

Implemented in Effect, EffectEqualization, and VSTEffect.

Referenced by DefaultEffectUIValidator::ValidateUI().

Here is the caller graph for this function:

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