Audacity  3.0.3
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 void SetHostUI (EffectUIHostInterface *host)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual bool PopulateUI (ShuttleGui &S)=0
 
virtual bool ValidateUI ()=0
 
virtual bool HideUI ()=0
 
virtual bool CloseUI ()=0
 
virtual bool CanExportPresets ()=0
 
virtual void ExportPresets ()=0
 
virtual void ImportPresets ()=0
 
virtual bool HasOptions ()=0
 
virtual void ShowOptions ()=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 270 of file EffectInterface.h.

Constructor & Destructor Documentation

◆ ~EffectUIClientInterface()

EffectUIClientInterface::~EffectUIClientInterface ( )
virtualdefault

Member Function Documentation

◆ CanExportPresets()

virtual bool EffectUIClientInterface::CanExportPresets ( )
pure virtual

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

Referenced by EffectUIHost::OnMenu().

Here is the caller graph for this function:

◆ CloseUI()

virtual bool EffectUIClientInterface::CloseUI ( )
pure virtual

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

Referenced by EffectUIHost::OnClose(), and EffectUIHost::~EffectUIHost().

Here is the caller graph for this function:

◆ ExportPresets()

virtual void EffectUIClientInterface::ExportPresets ( )
pure virtual

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

Referenced by EffectUIHost::OnExport().

Here is the caller graph for this function:

◆ HasOptions()

virtual bool EffectUIClientInterface::HasOptions ( )
pure virtual

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

Referenced by EffectUIHost::OnMenu().

Here is the caller graph for this function:

◆ HideUI()

virtual bool EffectUIClientInterface::HideUI ( )
pure virtual

◆ ImportPresets()

virtual void EffectUIClientInterface::ImportPresets ( )
pure virtual

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

Referenced by EffectUIHost::OnImport().

Here is the caller graph for this function:

◆ IsGraphicalUI()

virtual bool EffectUIClientInterface::IsGraphicalUI ( )
pure virtual

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

Referenced by EffectUIHost::BuildButtonBar().

Here is the caller graph for this function:

◆ PopulateUI()

virtual bool EffectUIClientInterface::PopulateUI ( ShuttleGui S)
pure virtual

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

Referenced by EffectUIHost::Initialize().

Here is the caller graph for this function:

◆ SetHostUI()

virtual void EffectUIClientInterface::SetHostUI ( EffectUIHostInterface host)
pure virtual

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

Referenced by EffectUIHost::EffectUIHost().

Here is the caller graph for this function:

◆ ShowOptions()

virtual void EffectUIClientInterface::ShowOptions ( )
pure virtual

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

Referenced by EffectUIHost::OnOptions().

Here is the caller graph for this function:

◆ ValidateUI()

virtual bool EffectUIClientInterface::ValidateUI ( )
pure virtual

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

Referenced by EffectUIHost::OnApply(), EffectUIHost::OnPlay(), and EffectUIHost::Resume().

Here is the caller graph for this function:

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