EffectUIServices.h

Go to the documentation of this file.

/*!********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file EffectUIServices.h
 
  Paul Licameli split from EffectPlugin.h
 
**********************************************************************/
#ifndef __AUDACITY_EFFECT_UI_SERVICES__
#define __AUDACITY_EFFECT_UI_SERVICES__
 
#include "EffectInterface.h"
#include <memory>
#include <optional>
 
class EffectEditor;
class EffectInstance;
class EffectPlugin;
class EffectSettings;
class EffectOutputs;
class EffectUIServices;
class ShuttleGui;
class wxWindow;
class wxDialog;
 
using OptionalMessage =
   std::optional<std::unique_ptr<EffectSettingsAccess::Message>>;
 
struct DialogFactoryResults {
   wxDialog *pDialog{};
   std::shared_ptr<EffectInstance> pInstance{};
   EffectEditor *pEditor{};
};
 
 
using EffectDialogFactory = std::function< DialogFactoryResults(
   wxWindow &parent, EffectPlugin &, EffectUIServices &,
   EffectSettingsAccess &) >;
 
class AUDACITY_DLL_API EffectUIServices /* not final */
{
public:
   // Display a message box, using effect's (translated) name as the prefix
   // for the title.
   enum : long { DefaultMessageBoxStyle = wxOK | wxCENTRE };
   static int DoMessageBox(const EffectPlugin &plugin,
      const TranslatableString& message,
      long style = DefaultMessageBoxStyle,
      const TranslatableString &titleStr = {});
 
   virtual ~EffectUIServices();
 
 
   virtual int ShowHostInterface(EffectPlugin &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;
 
   virtual void ExportPresets(
      const EffectPlugin &plugin, const EffectSettings &settings) const = 0;
   [[nodiscard]] 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;
};
 
#endif