Audacity  2.2.2
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:
Effect LadspaEffect EffectAmplify EffectAutoDuck EffectBassTreble EffectChangeSpeed EffectClickRemoval EffectDistortion EffectDtmf EffectEcho EffectEqualization EffectFade EffectFindClipping EffectInvert EffectNoise EffectNoiseReduction EffectNormalize EffectPaulstretch EffectPhaser EffectRepair EffectRepeat EffectReverb EffectReverse EffectScienFilter EffectSimpleMono EffectStereoToMono EffectToneGen EffectTruncSilence EffectTwoPassSimpleMono EffectWahwah Generator NyquistEffect

Public Member Functions

virtual ~EffectUIClientInterface ()
 
virtual void SetHostUI (EffectUIHostInterface *host)=0
 
virtual bool IsGraphicalUI ()=0
 
virtual bool PopulateUI (wxWindow *parent)=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 248 of file EffectInterface.h.

Constructor & Destructor Documentation

virtual EffectUIClientInterface::~EffectUIClientInterface ( )
inlinevirtual

Definition at line 251 of file EffectInterface.h.

251 {};

Member Function Documentation

virtual bool EffectUIClientInterface::CanExportPresets ( )
pure virtual

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::OnMenu().

virtual bool EffectUIClientInterface::CloseUI ( )
pure virtual
virtual void EffectUIClientInterface::ExportPresets ( )
pure virtual

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::OnExport().

virtual bool EffectUIClientInterface::HasOptions ( )
pure virtual

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::OnMenu().

virtual bool EffectUIClientInterface::HideUI ( )
pure virtual

Implemented in Effect, and LadspaEffect.

virtual void EffectUIClientInterface::ImportPresets ( )
pure virtual

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::OnImport().

virtual bool EffectUIClientInterface::IsGraphicalUI ( )
pure virtual

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::Initialize().

virtual bool EffectUIClientInterface::PopulateUI ( wxWindow *  parent)
pure virtual

Implemented in Effect, EffectEqualization, and LadspaEffect.

Referenced by EffectUIHost::Initialize().

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

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::EffectUIHost().

virtual void EffectUIClientInterface::ShowOptions ( )
pure virtual

Implemented in Effect, and LadspaEffect.

Referenced by EffectUIHost::OnOptions().

virtual bool EffectUIClientInterface::ValidateUI ( )
pure virtual

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