EffectEcho::Editor Struct Reference

Inheritance diagram for EffectEcho::Editor:

Collaboration diagram for EffectEcho::Editor:

Public Member Functions
	Editor (const EffectUIServices &services, EffectSettingsAccess &access, const EchoSettings &settings)
virtual	~Editor ()=default
bool	ValidateUI () override
	Get settings data from the panel; may make error dialogs and return false. More...
bool	UpdateUI () override
	Update appearance of the panel for changes in settings. More...
void	PopulateOrExchange (ShuttleGui &S)
Public Member Functions inherited from EffectEditor
	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...

Public Attributes
EchoSettings	mSettings

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...
Static Public Member Functions inherited from EffectEditor
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 inherited from EffectEditor
static constexpr int	kPlayID = 20102
Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all
Protected Member Functions inherited from EffectEditor
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 inherited from EffectEditor
const EffectUIServices &	mUIServices
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Definition at line 36 of file Echo.cpp.

Constructor & Destructor Documentation

Editor()

EffectEcho::Editor::Editor ( const EffectUIServices &  services, EffectSettingsAccess &  access, const EchoSettings &  settings  )

inline

Definition at line 39 of file Echo.cpp.

      : EffectEditor{ services, access }
      , mSettings{ settings }
   {}

~Editor()

virtual EffectEcho::Editor::~Editor ( )

virtualdefault

Member Function Documentation

PopulateOrExchange()

void EffectEcho::Editor::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 68 of file Echo.cpp.

{
   auto& echoSettings = mSettings;
 
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.Validator<FloatingPointValidator<double>>(
            3, &echoSettings.delay, NumValidatorStyle::NO_TRAILING_ZEROES,
            Delay.min, Delay.max )
         .AddTextBox(XXO("&Delay time (seconds):"), L"", 10);
 
      S.Validator<FloatingPointValidator<double>>(
            3, &echoSettings.decay, NumValidatorStyle::NO_TRAILING_ZEROES,
            Decay.min, Decay.max)
         .AddTextBox(XXO("D&ecay factor:"), L"", 10);
   }
   S.EndMultiColumn();
}

References EchoBase::Decay, EchoBase::Delay, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, mSettings, S, and XXO().

Here is the call graph for this function:

UpdateUI()

bool EffectEcho::Editor::UpdateUI ( )

overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns

true if successful

Reimplemented from EffectEditor.

Definition at line 107 of file Echo.cpp.

{
   // get the settings from the MessageBuffer and write them to our local copy
   const auto& settings = mAccess.Get();
 
   mSettings = GetSettings(settings);
 
   return true;
}

References EffectWithSettings< EchoSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

ValidateUI()

bool EffectEcho::Editor::ValidateUI ( )

overridevirtual

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

Returns

true only if panel settings are acceptable

Implements EffectEditor.

Definition at line 90 of file Echo.cpp.

{
   mAccess.ModifySettings
   (
      [this](EffectSettings& settings)
   {
      // pass back the modified settings to the MessageBuffer
 
      EffectEcho::GetSettings(settings) = mSettings;
      return nullptr;
   }
   );
 
   return true;
}

References EffectWithSettings< EchoSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

Member Data Documentation

mSettings

EchoSettings EffectEcho::Editor::mSettings

Definition at line 51 of file Echo.cpp.

Referenced by PopulateOrExchange().

---

The documentation for this struct was generated from the following file:

• Echo.cpp