EffectEditor Class Reference

#include <EffectEditor.h>

Inheritance diagram for EffectEditor:

Collaboration diagram for EffectEditor:

Public Member Functions
	EffectEditor (const EffectUIServices &services, EffectSettingsAccess &access)
virtual	~EffectEditor ()
virtual bool	ValidateUI ()=0
	Get settings data from the panel; may make error dialogs and return false. More...
virtual bool	UpdateUI ()
	Update appearance of the panel for changes in settings. More...
virtual bool	IsGraphicalUI ()
virtual void	Disconnect ()
	On the first call only, may disconnect from further event handling. More...
virtual void	OnClose ()
Public Member Functions inherited from Observer::Publisher< EffectSettingChanged >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static bool	EnableApply (wxWindow *parent, bool enable=true)
	Enable or disable the Apply button of the dialog that contains parent. More...
static bool	EnablePreview (wxWindow *parent, bool enable=true)

Static Public Attributes
static constexpr int	kPlayID = 20102
Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all

Protected Member Functions
template<typename EventTag , typename Class , typename Event >
void	BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
Protected Member Functions inherited from Observer::Publisher< EffectSettingChanged >
CallbackReturn	Publish (const EffectSettingChanged &message)
	Send a message to connected callbacks. More...

Protected Attributes
const EffectUIServices &	mUIServices
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Additional Inherited Members
Public Types inherited from Observer::Publisher< EffectSettingChanged >
using	message_type = EffectSettingChanged
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const EffectSettingChanged &) >
	Type of functions that can be connected to the Publisher. More...

Detailed Description

Definition at line 31 of file EffectEditor.h.

Constructor & Destructor Documentation

EffectEditor()

EffectEditor::EffectEditor	(	const EffectUIServices &	services,
		EffectSettingsAccess &	access
	)

Definition at line 19 of file EffectEditor.cpp.

   : mUIServices{ services }
   , mAccess{ access }
{}

~EffectEditor()

EffectEditor::~EffectEditor ( )

virtualdefault

Member Function Documentation

BindTo()

template<typename EventTag , typename Class , typename Event >

void EffectEditor::BindTo ( wxEvtHandler &  src, const EventTag &  eventType, void(Class::*)(Event &)  pmf  )

inlineprotected

Definition at line 85 of file EffectEditor.h.

   {
      src.Bind(eventType, pmf, static_cast<Class *>(this));
   }

Referenced by VSTEditor::BuildFancy(), VSTEditor::BuildPlain(), and LadspaEditor::PopulateUI().

Here is the caller graph for this function:

Disconnect()

void EffectEditor::Disconnect ( )

virtual

On the first call only, may disconnect from further event handling.

Default implemantation does nothing

Reimplemented in anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor, LadspaEditor, LV2Editor, and anonymous_namespace{StatefulEffectUIServices.cpp}::DefaultEffectEditor.

Definition at line 37 of file EffectEditor.cpp.

{
}

EnableApply()

bool EffectEditor::EnableApply ( wxWindow *  parent, bool  enable = true  )

static

Enable or disable the Apply button of the dialog that contains parent.

Definition at line 50 of file EffectEditor.cpp.

{
   // May be called during initialization, so try to find the dialog
   if (auto dlg = wxGetTopLevelParent(parent)) {
      wxWindow *apply = dlg->FindWindow(wxID_APPLY);
 
      // Don't allow focus to get trapped
      if (!enable)
      {
         wxWindow *focus = dlg->FindFocus();
         if (focus == apply)
         {
            dlg->FindWindow(wxID_CLOSE)->SetFocus();
         }
      }
 
      if (apply)
         apply->Enable(enable);
   }
 
   EnablePreview(parent, enable);
 
   return enable;
}

References EnablePreview().

Referenced by EffectAmplify::CheckClip(), EffectRepeat::DisplayNewTime(), EffectBassTreble::Editor::EnableApplyFromTransferDataFromWindow(), EffectPhaser::Editor::EnableApplyFromTransferDataFromWindow(), EffectWahwah::Editor::EnableApplyFromTransferDataToWindow(), EffectBassTreble::Editor::EnableApplyFromValidate(), EffectPhaser::Editor::EnableApplyFromValidate(), EffectWahwah::Editor::EnableApplyFromValidate(), EffectAmplify::OnAmpText(), EffectTruncSilence::OnControlChange(), EffectToneGen::OnControlUpdate(), EffectScienFilter::OnCutoff(), EffectAmplify::OnPeakText(), EffectScienFilter::OnRipple(), EffectScienFilter::OnStopbandRipple(), EffectPaulstretch::OnText(), EffectTimeScale::OnText_PitchHalfStepsEnd(), EffectTimeScale::OnText_PitchHalfStepsStart(), EffectTimeScale::OnText_PitchPercentChangeEnd(), EffectTimeScale::OnText_PitchPercentChangeStart(), EffectTimeScale::OnText_RatePercentChangeEnd(), EffectTimeScale::OnText_RatePercentChangeStart(), EffectChangeSpeed::UpdateUI(), EffectLoudness::UpdateUI(), and EffectNormalize::UpdateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

EnablePreview()

bool EffectEditor::EnablePreview ( wxWindow *  parent, bool  enable = true  )

static

Enable or disable the preview play button of the dialog that contains parent

Definition at line 75 of file EffectEditor.cpp.

{
   // May be called during initialization, so try to find the dialog
   if (auto dlg = wxGetTopLevelParent(parent)) {
      wxWindow *play = dlg->FindWindow(kPlayID);
      if (play)
      {
         // Don't allow focus to get trapped
         if (!enable)
         {
            wxWindow *focus = dlg->FindFocus();
            if (focus == play)
            {
               dlg->FindWindow(wxID_CLOSE)->SetFocus();
            }
         }
 
         play->Enable(enable);
      }
   }
 
   return enable;
}

References kPlayID.

Referenced by EnableApply(), and NyquistEffect::TransferDataToWindow().

Here is the caller graph for this function:

IsGraphicalUI()

bool EffectEditor::IsGraphicalUI ( )

virtual

Default implementation returns false

Returns

true if using a native plug-in UI, not widgets

Reimplemented in AudioUnitEditor, LV2Editor, VSTEditor, and VST3Editor.

Definition at line 32 of file EffectEditor.cpp.

{
   return false;
}

Referenced by VST3Effect::ShowClientInterface().

Here is the caller graph for this function:

OnClose()

void EffectEditor::OnClose ( )

virtual

Handle the UI OnClose event. Default implementation calls mUIServices.CloseUI()

Reimplemented in VSTEditor, and VST3Editor.

Definition at line 41 of file EffectEditor.cpp.

{
   if (!mUIClosed)
   {
      mUIServices.CloseUI();
      mUIClosed = true;
   }
}

References EffectUIServices::CloseUI(), mUIClosed, and mUIServices.

Referenced by VST3Editor::OnClose().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateUI()

bool EffectEditor::UpdateUI ( )

virtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns

true if successful

Reimplemented in AudioUnitEditor, EffectBassTreble::Editor, EffectDistortion::Editor, EffectDtmf::Editor, EffectEcho::Editor, LadspaEditor, LV2Editor, EffectPhaser::Editor, EffectReverb::Editor, VSTEditor, VST3Editor, and EffectWahwah::Editor.

Definition at line 27 of file EffectEditor.cpp.

{
   return true;
}

ValidateUI()

virtual bool EffectEditor::ValidateUI ( )

pure virtual

Get settings data from the panel; may make error dialogs and return false.

Returns

true only if panel settings are acceptable

Implemented in AudioUnitEditor, EffectBassTreble::Editor, EffectDistortion::Editor, EffectDtmf::Editor, EffectEcho::Editor, anonymous_namespace{EqualizationUI.cpp}::EqualizationUIEditor, LadspaEditor, LV2Editor, EffectPhaser::Editor, EffectReverb::Editor, anonymous_namespace{StatefulEffectUIServices.cpp}::DefaultEffectEditor, VSTEditor, VST3Editor, and EffectWahwah::Editor.

Member Data Documentation

kPlayID

constexpr int EffectEditor::kPlayID = 20102

staticconstexpr

Definition at line 76 of file EffectEditor.h.

Referenced by EnablePreview().

mAccess

EffectSettingsAccess& EffectEditor::mAccess

protected

Definition at line 92 of file EffectEditor.h.

Referenced by AudioUnitEditor::AudioUnitEditor(), VSTEditor::Automate(), AudioUnitEditor::EventListener(), VSTEditor::Flush(), VSTEditor::NotifyParameterChanged(), LV2Editor::OnChoice(), VSTEditor::OnClose(), VST3Editor::OnClose(), VST3Editor::OnIdle(), AudioUnitEditor::OnIdle(), LV2Editor::OnIdle(), VSTEditor::OnIdle(), LV2Editor::OnSlider(), VSTEditor::OnSlider(), LV2Editor::OnText(), LV2Editor::OnToggle(), LV2Editor::OnTrigger(), LadspaEditor::PopulateUI(), LadspaEditor::RefreshControls(), LV2Editor::suil_port_write(), AudioUnitEditor::UpdateUI(), LV2Editor::UpdateUI(), VST3Editor::UpdateUI(), AudioUnitEditor::ValidateUI(), EffectDistortion::Editor::ValidateUI(), LadspaEditor::ValidateUI(), LV2Editor::ValidateUI(), EffectReverb::Editor::ValidateUI(), anonymous_namespace{StatefulEffectUIServices.cpp}::DefaultEffectEditor::ValidateUI(), VSTEditor::ValidateUI(), VST3Editor::ValidateUI(), EffectWahwah::Editor::ValidateUI(), VST3Editor::VST3Editor(), and VSTEditor::VSTEditor().

mUIClosed

bool EffectEditor::mUIClosed { false }

protected

Definition at line 94 of file EffectEditor.h.

Referenced by OnClose().

mUIServices

const EffectUIServices& EffectEditor::mUIServices

protected

Definition at line 91 of file EffectEditor.h.

Referenced by OnClose(), and anonymous_namespace{StatefulEffectUIServices.cpp}::DefaultEffectEditor::ValidateUI().

---

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

• EffectEditor.h
• EffectEditor.cpp