#include <StatelessPerTrackEffect.h>

Inheritance diagram for StatelessEffectUIServices:

Collaboration diagram for StatelessEffectUIServices:

Public Member Functions
std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const override
	Adds controls to a panel that is given as the parent window of `S` More...

virtual std::unique_ptr< EffectEditor >	MakeEditor (ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Called only from PopulateUI, to add controls to effect panel. More...

Public Member Functions inherited from BasicEffectUIServices
int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal) const override

void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const override

OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const override

void	ShowOptions (const EffectPlugin &plugin) const override

bool	ValidateUI (const EffectPlugin &context, EffectSettings &) const override

bool	CloseUI () const override

Public Member Functions inherited from EffectUIServices
virtual	~EffectUIServices ()

virtual int	ShowHostInterface (EffectBase &plugin, wxWindow &parent, const EffectDialogFactory &factory, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, bool forceModal=false)

virtual int	ShowClientInterface (const EffectPlugin &plugin, wxWindow &parent, wxDialog &dialog, EffectEditor *pEditor, bool forceModal=false) const =0

virtual std::unique_ptr< EffectEditor >	PopulateUI (const EffectPlugin &plugin, ShuttleGui &S, EffectInstance &instance, EffectSettingsAccess &access, const EffectOutputs *pOutputs) const =0
	Adds controls to a panel that is given as the parent window of `S` More...

virtual void	ExportPresets (const EffectPlugin &plugin, const EffectSettings &settings) const =0

virtual OptionalMessage	ImportPresets (const EffectPlugin &plugin, EffectSettings &settings) const =0

virtual void	ShowOptions (const EffectPlugin &plugin) const =0

virtual bool	ValidateUI (const EffectPlugin &context, EffectSettings &settings) const =0

virtual bool	CloseUI () const =0

Additional Inherited Members
Public Types inherited from EffectUIServices
enum	: long { DefaultMessageBoxStyle = wxOK \| wxCENTRE }

Static Public Member Functions inherited from EffectUIServices
static int	DoMessageBox (const EffectPlugin &plugin, const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})

Detailed Description

Definition at line 16 of file StatelessPerTrackEffect.h.

Member Function Documentation

◆ MakeEditor()

virtual std::unique_ptr< EffectEditor > StatelessEffectUIServices::MakeEditor	(	ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access,
		const EffectOutputs *	pOutputs
	)		const

pure virtual

Called only from PopulateUI, to add controls to effect panel.

Returns: also returned from PopulateUI

Postcondition: result: result != nullptr

Implemented in AudioUnitEffect, LV2Effect, VSTEffect, VST3Effect, EffectBassTreble, EffectCompressor, EffectDistortion, EffectDtmf, EffectEcho, LadspaEffect, EffectLimiter, EffectPhaser, EffectReverb, and EffectWahwah.

Referenced by PopulateUI().

Here is the caller graph for this function:

◆ PopulateUI()

std::unique_ptr< EffectEditor > StatelessEffectUIServices::PopulateUI	(	const EffectPlugin &	plugin,
		ShuttleGui &	S,
		EffectInstance &	instance,
		EffectSettingsAccess &	access,
		const EffectOutputs *	pOutputs
	)		const

overridevirtual

Adds controls to a panel that is given as the parent window of S

Parameters

S	interface for adding controls to a panel in a dialog
instance	guaranteed to have a lifetime containing that of the returned object
access	guaranteed to have a lifetime containing that of the returned object
pOutputs	null, or else points to outputs with 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

Implements EffectUIServices.

Reimplemented in VSTEffect, and VST3Effect.

Definition at line 15 of file StatelessPerTrackEffect.cpp.

{
   auto parent = S.GetParent();
 
   // Subclass must provide something
   auto result = MakeEditor(S, instance, access, pOutputs);
   assert(result);
 
   parent->SetMinSize(parent->GetSizer()->GetMinSize());
 
   return result;
}

References MakeEditor(), and S.

Here is the call graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ MakeEditor()

◆ PopulateUI()