EffectEcho::Validator Struct Reference

Inheritance diagram for EffectEcho::Validator:

Collaboration diagram for EffectEcho::Validator:

Public Member Functions
	Validator (EffectUIClientInterface &effect, EffectSettingsAccess &access, const EffectEchoSettings &settings)
virtual	~Validator ()=default
Effect &	GetEffect () const
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 EffectUIValidator
	EffectUIValidator (EffectUIClientInterface &effect, EffectSettingsAccess &access)
virtual	~EffectUIValidator ()
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 Attributes
EffectEchoSettings	mSettings

Additional Inherited Members
Protected Member Functions inherited from EffectUIValidator
template<typename EventTag , typename Class , typename Event >
void	BindTo (wxEvtHandler &src, const EventTag &eventType, void(Class::*pmf)(Event &))
Protected Attributes inherited from EffectUIValidator
EffectUIClientInterface &	mEffect
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Definition at line 174 of file Echo.cpp.

Constructor & Destructor Documentation

Validator()

EffectEcho::Validator::Validator ( EffectUIClientInterface &  effect, EffectSettingsAccess &  access, const EffectEchoSettings &  settings  )

inline

Definition at line 177 of file Echo.cpp.

      : EffectUIValidator{ effect, access }
      , mSettings{ settings }
   {}

~Validator()

virtual EffectEcho::Validator::~Validator ( )

virtualdefault

Member Function Documentation

GetEffect()

Effect & EffectEcho::Validator::GetEffect ( ) const

inline

Definition at line 184 of file Echo.cpp.

{ return static_cast<Effect&>(mEffect); }

References EffectUIValidator::mEffect.

PopulateOrExchange()

void EffectEcho::Validator::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 207 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 EffectEcho::Decay, EffectEcho::Delay, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, S, and XXO.

UpdateUI()

bool EffectEcho::Validator::UpdateUI ( )

overridevirtual

Update appearance of the panel for changes in settings.

Default implementation does nothing, returns true

Returns

true if successful

Reimplemented from EffectUIValidator.

Definition at line 245 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< EffectEchoSettings, PerTrackEffect >::GetSettings(), and settings().

Here is the call graph for this function:

ValidateUI()

bool EffectEcho::Validator::ValidateUI ( )

overridevirtual

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

Returns

true only if panel settings are acceptable

Implements EffectUIValidator.

Definition at line 229 of file Echo.cpp.

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

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

Here is the call graph for this function:

Member Data Documentation

mSettings

EffectEchoSettings EffectEcho::Validator::mSettings

Definition at line 191 of file Echo.cpp.

---

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

• Echo.cpp