UI-related services.
More...
#include <EffectHostInterface.h>
|
EffectUIHostInterface & | operator= (EffectUIHostInterface &)=delete |
|
virtual | ~EffectUIHostInterface () |
|
virtual const EffectDefinitionInterface & | GetDefinition () const =0 |
|
virtual int | ShowHostInterface (wxWindow &parent, const EffectDialogFactory &factory, EffectSettingsAccess &access, bool forceModal=false)=0 |
| Usually applies factory to self and given access. More...
|
|
virtual void | Preview (EffectSettingsAccess &access, bool dryOnly)=0 |
|
virtual bool | SaveSettingsAsString (const EffectSettings &settings, wxString &parms) const =0 |
|
virtual bool | LoadSettingsFromString (const wxString &parms, EffectSettings &settings) const =0 |
|
virtual bool | IsBatchProcessing () const =0 |
|
virtual void | SetBatchProcessing ()=0 |
|
virtual void | UnsetBatchProcessing ()=0 |
|
virtual bool | DoEffect (EffectSettings &settings, double projectRate, TrackList *list, WaveTrackFactory *factory, NotifyingSelectedRegion &selectedRegion, unsigned flags, wxWindow *pParent=nullptr, const EffectDialogFactory &dialogFactory={}, const EffectSettingsAccessPtr &pAccess=nullptr)=0 |
| Unfortunately complicated dual-use function. More...
|
|
virtual bool | TransferDataToWindow (const EffectSettings &settings)=0 |
| Update controls for the settings. More...
|
|
virtual bool | TransferDataFromWindow (EffectSettings &settings)=0 |
| Update the given settings from controls. More...
|
|
virtual bool | InitializeInstance (EffectSettings &settings)=0 |
|
UI-related services.
Definition at line 45 of file EffectHostInterface.h.
◆ EffectSettingsAccessPtr
◆ ~EffectUIHostInterface()
EffectUIHostInterface::~EffectUIHostInterface |
( |
| ) |
|
|
virtualdefault |
◆ DoEffect()
Unfortunately complicated dual-use function.
Sometimes this is invoked only to do effect processing, as a delegate for another effect, but sometimes also to put up a dialog prompting the user for settings first.
Create a user interface only if the supplied factory is not null. Factory may be null because we "Repeat last effect" or apply a macro
Will only operate on tracks that have the "selected" flag set to true, which is consistent with Audacity's standard UI.
- Returns
- true on success
- Parameters
-
settings | Always given; only for processing |
pAccess | Sometimes given; only for UI |
Implemented in Effect.
◆ GetDefinition()
Implemented in Effect.
Referenced by EffectUIHost::BuildButtonBar(), GetID(), GetUserPresets(), HasCurrentSettings(), HasFactoryDefaults(), EffectUIHost::Initialize(), EffectUIHost::LoadUserPresets(), EffectUIHost::OnApply(), EffectUIHost::OnDefaults(), EffectUIHost::OnDeletePreset(), EffectUIHost::OnFactoryPreset(), EffectUIHost::OnHelp(), EffectUIHost::OnMenu(), EffectUIHost::OnSaveAs(), EffectUIHost::OnUserPreset(), EffectUIHost::TransferDataFromWindow(), and EffectUIHost::UpdateControls().
◆ InitializeInstance()
virtual bool EffectUIHostInterface::InitializeInstance |
( |
EffectSettings & |
settings | ) |
|
|
pure virtual |
◆ IsBatchProcessing()
virtual bool EffectUIHostInterface::IsBatchProcessing |
( |
| ) |
const |
|
pure virtual |
◆ LoadSettingsFromString()
virtual bool EffectUIHostInterface::LoadSettingsFromString |
( |
const wxString & |
parms, |
|
|
EffectSettings & |
settings |
|
) |
| const |
|
pure virtual |
◆ operator=()
◆ Preview()
◆ SaveSettingsAsString()
virtual bool EffectUIHostInterface::SaveSettingsAsString |
( |
const EffectSettings & |
settings, |
|
|
wxString & |
parms |
|
) |
| const |
|
pure virtual |
◆ SetBatchProcessing()
virtual void EffectUIHostInterface::SetBatchProcessing |
( |
| ) |
|
|
pure virtual |
◆ ShowHostInterface()
Usually applies factory to self and given access.
But there are a few unusual overrides for historical reasons
- Parameters
-
access | is only guaranteed to have lifetime suitable for a modal dialog, unless the dialog stores access.shared_from_this() |
- 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 Effect, EffectNoiseReduction, EffectNoiseRemoval, and NyquistEffect.
◆ TransferDataFromWindow()
virtual bool EffectUIHostInterface::TransferDataFromWindow |
( |
EffectSettings & |
settings | ) |
|
|
pure virtual |
Update the given settings from controls.
Implemented in EffectAmplify, EffectChangeSpeed, EffectCompressor, EffectDistortion, Effect, EffectFindClipping, EffectNoise, EffectPhaser, EffectRepeat, EffectReverb, EffectScienFilter, EffectSilence, EffectToneGen, EffectTruncSilence, and NyquistEffect.
Referenced by EffectUIHost::TransferDataFromWindow().
◆ TransferDataToWindow()
virtual bool EffectUIHostInterface::TransferDataToWindow |
( |
const EffectSettings & |
settings | ) |
|
|
pure virtual |
Update controls for the settings.
Implemented in EffectAmplify, EffectAutoDuck, EffectBassTreble, EffectChangeSpeed, EffectCompressor, EffectDistortion, Effect, EffectEqualization, EffectFindClipping, EffectLoudness, EffectNoise, EffectNormalize, NyquistEffect, EffectPhaser, EffectRepeat, EffectReverb, EffectScienFilter, EffectSilence, EffectTimeScale, EffectToneGen, VampEffect, and EffectWahwah.
Referenced by EffectUIHost::TransferDataToWindow().
◆ UnsetBatchProcessing()
virtual void EffectUIHostInterface::UnsetBatchProcessing |
( |
| ) |
|
|
pure virtual |
◆ kCurrentSettingsIdent
const wxString EffectUIHostInterface::kCurrentSettingsIdent = wxT("<Current Settings>") |
|
static |
◆ kFactoryDefaultsIdent
const wxString EffectUIHostInterface::kFactoryDefaultsIdent = wxT("<Factory Defaults>") |
|
static |
◆ kFactoryPresetIdent
const wxString EffectUIHostInterface::kFactoryPresetIdent = wxT("Factory Preset:") |
|
static |
◆ kUserPresetIdent
const wxString EffectUIHostInterface::kUserPresetIdent = wxT("User Preset:") |
|
static |
The documentation for this class was generated from the following files: