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

extends EffectHostInterface with UI-related services More...

#include <EffectHostInterface.h>

Inheritance diagram for EffectUIHostInterface:
[legend]
Collaboration diagram for EffectUIHostInterface:
[legend]

Public Member Functions

virtual ~EffectUIHostInterface ()
 
virtual int ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, bool forceModal=false)=0
 
- Public Member Functions inherited from EffectHostInterface
virtual ~EffectHostInterface ()
 
virtual EffectDefinitionInterfaceGetDefinition ()=0
 
virtual double GetDuration ()=0
 
virtual NumericFormatSymbol GetDurationFormat ()=0
 
virtual void SetDuration (double seconds)=0
 
virtual RegistryPath GetUserPresetsGroup (const RegistryPath &name)=0
 
virtual RegistryPath GetCurrentSettingsGroup ()=0
 
virtual RegistryPath GetFactoryDefaultsGroup ()=0
 

Detailed Description

extends EffectHostInterface with UI-related services

Definition at line 62 of file EffectHostInterface.h.

Constructor & Destructor Documentation

◆ ~EffectUIHostInterface()

EffectUIHostInterface::~EffectUIHostInterface ( )
virtualdefault

Member Function Documentation

◆ ShowHostInterface()

virtual int EffectUIHostInterface::ShowHostInterface ( wxWindow &  parent,
const EffectDialogFactory factory,
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 NyquistEffect, EffectNoiseRemoval, EffectNoiseReduction, and Effect.


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