EffectEditor.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  EffectEditor.h
 
  Dominic Mazzoni
  Vaughan Johnson
  Martyn Shaw
 
  Paul Licameli split from EffectPlugin.h
 
**********************************************************************/
#ifndef __AUDACITY_EFFECT_EDITOR__
#define __AUDACITY_EFFECT_EDITOR__
 
#include "Observer.h"
#include <wx/event.h>
 
class EffectSettingsAccess;
class EffectUIServices;
class wxWindow;
 
struct EffectSettingChanged final
{
   size_t index { size_t(-1) };
   float newValue {};
};
 
class AUDACITY_DLL_API EffectEditor /* not final */
    : public Observer::Publisher<EffectSettingChanged>
{
public:
   EffectEditor(
      const EffectUIServices &services, EffectSettingsAccess &access);
 
   virtual ~EffectEditor();
 
 
   virtual bool ValidateUI() = 0;
 
 
   virtual bool UpdateUI();
 
   virtual bool IsGraphicalUI();
 
 
   virtual void Disconnect();
 
   virtual void OnClose();
 
   static bool EnableApply(wxWindow *parent, bool enable = true);
 
   // id that should be used by preview play button of effect dialog
   static constexpr int kPlayID = 20102;
 
   static bool EnablePreview(wxWindow *parent, bool enable = true);
 
 protected:
   // Convenience function template for binding event handler functions
   template<typename EventTag, typename Class, typename Event>
   void BindTo(
      wxEvtHandler &src, const EventTag& eventType, void (Class::*pmf)(Event &))
   {
      src.Bind(eventType, pmf, static_cast<Class *>(this));
   }
 
   const EffectUIServices &mUIServices;
   EffectSettingsAccess &mAccess;
 
   bool mUIClosed { false };
};
#endif