EffectDtmf::Validator Struct Reference

Inheritance diagram for EffectDtmf::Validator:

Collaboration diagram for EffectDtmf::Validator:

Public Member Functions
	Validator (EffectUIClientInterface &effect, EffectSettingsAccess &access, const DtmfSettings &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	DoUpdateUI ()
void	PopulateOrExchange (ShuttleGui &S, const EffectSettings &settings, double projectRate)
void	OnSequence (wxCommandEvent &evt)
void	OnDuration (wxCommandEvent &evt)
void	OnDutyCycle (wxCommandEvent &evt)
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 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
DtmfSettings	mSettings
wxTextCtrl *	mDtmfSequenceT
wxSlider *	mDtmfDutyCycleS
NumericTextCtrl *	mDtmfDurationT
wxStaticText *	mDtmfToneT
wxStaticText *	mDtmfSilenceT
wxStaticText *	mDtmfDutyT

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 EffectUIValidator
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 EffectUIValidator
static constexpr int	kPlayID = 20102
Static Public Attributes inherited from Observer::Publisher< EffectSettingChanged >
static constexpr bool	notifies_all
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 Member Functions inherited from Observer::Publisher< EffectSettingChanged >
CallbackReturn	Publish (const EffectSettingChanged &message)
	Send a message to connected callbacks. More...
Protected Attributes inherited from EffectUIValidator
EffectUIClientInterface &	mEffect
EffectSettingsAccess &	mAccess
bool	mUIClosed { false }

Detailed Description

Definition at line 291 of file DtmfGen.cpp.

Constructor & Destructor Documentation

Validator()

EffectDtmf::Validator::Validator ( EffectUIClientInterface &  effect, EffectSettingsAccess &  access, const DtmfSettings &  settings  )

inline

Definition at line 294 of file DtmfGen.cpp.

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

~Validator()

virtual EffectDtmf::Validator::~Validator ( )

virtualdefault

Member Function Documentation

DoUpdateUI()

void EffectDtmf::Validator::DoUpdateUI

(

)

Definition at line 645 of file DtmfGen.cpp.

{
   // Update some texts in response to controls
   auto &dtmfSettings = mSettings;
 
   mDtmfDutyT
      ->SetLabel(wxString::Format(wxT("%.1f %%"), dtmfSettings.dtmfDutyCycle));
   mDtmfDutyT->SetName(mDtmfDutyT->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mDtmfSilenceT
      ->SetLabel(wxString::Format(_("%.0f ms"), dtmfSettings.dtmfTone * 1000.0));
   mDtmfSilenceT->SetName(mDtmfSilenceT->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
 
   mDtmfToneT
      ->SetLabel(wxString::Format(_("%.0f ms"), dtmfSettings.dtmfSilence * 1000.0));
   mDtmfToneT->SetName(mDtmfToneT->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
}

References _, and wxT().

Here is the call graph for this function:

GetEffect()

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

inline

Definition at line 302 of file DtmfGen.cpp.

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

References EffectUIValidator::mEffect.

OnDuration()

void EffectDtmf::Validator::OnDuration

(

wxCommandEvent &

evt

)

Definition at line 674 of file DtmfGen.cpp.

{
   mAccess.ModifySettings([this](EffectSettings &settings){
      auto &dtmfSettings = mSettings;
      auto &effect = GetEffect();
      settings.extra.SetDuration(mDtmfDurationT->GetValue());
      dtmfSettings.Recalculate(settings);
      return nullptr;
   });
   DoUpdateUI();
}

References settings().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnDutyCycle()

void EffectDtmf::Validator::OnDutyCycle

(

wxCommandEvent &

evt

)

Definition at line 686 of file DtmfGen.cpp.

{
   mAccess.ModifySettings([this, &evt](EffectSettings &settings){
      auto &dtmfSettings = mSettings;
      dtmfSettings.dtmfDutyCycle = (double) evt.GetInt() / DutyCycle.scale;
      dtmfSettings.Recalculate(settings);
      return nullptr;
   });
   DoUpdateUI();
}

References EffectDtmf::DutyCycle, EffectParameter< Structure, Member, Type, Value >::scale, and settings().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSequence()

void EffectDtmf::Validator::OnSequence

(

wxCommandEvent &

evt

)

Definition at line 663 of file DtmfGen.cpp.

{
   mAccess.ModifySettings([this](EffectSettings &settings){
      auto &dtmfSettings = mSettings;
      dtmfSettings.dtmfSequence = mDtmfSequenceT->GetValue();
      dtmfSettings.Recalculate(settings);
      return nullptr;
   });
   DoUpdateUI();
}

References settings().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void EffectDtmf::Validator::PopulateOrExchange	(	ShuttleGui &	S,
		const EffectSettings &	settings,
		double	projectRate
	)

Definition at line 325 of file DtmfGen.cpp.

{
   // Reference to our copy of this effect's special settings
   auto &dtmfSettings = mSettings;
 
   // Do NOT hold a reference to EffectSettings, just use it to find initial
   // duration values.  (It came from EffectSettingsAccess so its stable address
   // can't be relied on.)
 
   // dialog will be passed values from effect
   // Effect retrieves values from saved config
   // Dialog will take care of using them to initialize controls
   // If there is a selection, use that duration, otherwise use
   // value from saved config: this is useful is user wants to
   // replace selection with dtmf sequence
 
   S.AddSpace(0, 5);
   S.StartMultiColumn(2, wxCENTER);
   {
      mDtmfSequenceT =
      S
         .Validator([&dtmfSettings]{
            wxTextValidator vldDtmf(
               wxFILTER_INCLUDE_CHAR_LIST, &dtmfSettings.dtmfSequence);
            vldDtmf.SetIncludes(wxArrayString(WXSIZEOF(kSymbols), kSymbols));
            return vldDtmf;
         })
         .AddTextBox(XXO("DTMF &sequence:"), wxT(""), 10);
      BindTo(*mDtmfSequenceT, wxEVT_TEXT, &Validator::OnSequence);
 
      // A control with no event handler but the validator causes updates
      // when TransferData functions are called
      S
         .Validator<FloatingPointValidator<double>>(
            3, &dtmfSettings.dtmfAmplitude, NumValidatorStyle::NO_TRAILING_ZEROES,
            Amplitude.min, Amplitude.max)
         .AddTextBox(XXO("&Amplitude (0-1):"), wxT(""), 10);
 
      S.AddPrompt(XXO("&Duration:"));
      auto &extra = settings.extra;
      mDtmfDurationT = safenew
         NumericTextCtrl(S.GetParent(), wxID_ANY,
                         NumericConverter::TIME,
                         extra.GetDurationFormat(),
                         extra.GetDuration(),
                         projectRate,
                         NumericTextCtrl::Options{}
                            .AutoPos(true));
      S.Name(XO("Duration"))
         .AddWindow(mDtmfDurationT);
      BindTo(*mDtmfDurationT, wxEVT_TEXT, &Validator::OnDuration);
 
      S.AddFixedText(XO("&Tone/silence ratio:"), false);
      mDtmfDutyCycleS =
      S
         .Style(wxSL_HORIZONTAL | wxEXPAND)
         .MinSize( { -1, -1 } )
         .AddSlider( {},
                     dtmfSettings.dtmfDutyCycle * DutyCycle.scale,
                     DutyCycle.max * DutyCycle.scale,
                     DutyCycle.min * DutyCycle.scale);
      BindTo(*mDtmfDutyCycleS, wxEVT_SLIDER, &Validator::OnDutyCycle);
   }
   S.EndMultiColumn();
 
   S.StartMultiColumn(2, wxCENTER);
   {
      S.AddFixedText(XO("Duty cycle:"), false);
      mDtmfDutyT =
      S.AddVariableText(XO("%.1f %%")
         .Format( dtmfSettings.dtmfDutyCycle ), false);
      
      S.AddFixedText(XO("Tone duration:"), false);
      mDtmfSilenceT =
      /* i18n-hint milliseconds */
      S.AddVariableText(XO("%.0f ms")
         .Format( dtmfSettings.dtmfTone * 1000.0 ), false);
 
      S.AddFixedText(XO("Silence duration:"), false);
      mDtmfToneT =
      /* i18n-hint milliseconds */
      S.AddVariableText(XO("%0.f ms")
         .Format( dtmfSettings.dtmfSilence * 1000.0 ), false);
   }
   S.EndMultiColumn();
}

References EffectDtmf::Amplitude, NumericTextCtrl::Options::AutoPos(), EffectDtmf::DutyCycle, kSymbols, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, OnDuration(), OnDutyCycle(), OnSequence(), S, safenew, EffectParameter< Structure, Member, Type, Value >::scale, settings(), NumericConverter::TIME, wxT(), XO(), and XXO().

Here is the call graph for this function:

UpdateUI()

bool EffectDtmf::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 433 of file DtmfGen.cpp.

{
   const auto &settings = mAccess.Get();
   auto &dtmfSettings = mSettings;
 
   // Copy into our settings
   mSettings = GetSettings(settings);
 
   mDtmfDutyCycleS->SetValue(dtmfSettings.dtmfDutyCycle * DutyCycle.scale);
 
   mDtmfDurationT->SetValue(settings.extra.GetDuration());
 
   DoUpdateUI();
 
   return true;
}

References EffectDtmf::DutyCycle, EffectWithSettings< DtmfSettings, PerTrackEffect >::GetSettings(), EffectParameter< Structure, Member, Type, Value >::scale, and settings().

Here is the call graph for this function:

ValidateUI()

bool EffectDtmf::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 450 of file DtmfGen.cpp.

{
   mAccess.ModifySettings([this](EffectSettings &settings){
      auto &dtmfSettings = mSettings;
      dtmfSettings.dtmfDutyCycle =
         (double) mDtmfDutyCycleS->GetValue() / DutyCycle.scale;
      settings.extra.SetDuration(mDtmfDurationT->GetValue());
 
      // recalculate to make sure all values are up-to-date. This is especially
      // important if the user did not change any values in the dialog
      dtmfSettings.Recalculate(settings);
      return nullptr;
   });
 
   return true;
}

References EffectDtmf::DutyCycle, EffectParameter< Structure, Member, Type, Value >::scale, and settings().

Here is the call graph for this function:

Member Data Documentation

mDtmfDurationT

NumericTextCtrl* EffectDtmf::Validator::mDtmfDurationT

Definition at line 319 of file DtmfGen.cpp.

mDtmfDutyCycleS

wxSlider* EffectDtmf::Validator::mDtmfDutyCycleS

Definition at line 318 of file DtmfGen.cpp.

mDtmfDutyT

wxStaticText* EffectDtmf::Validator::mDtmfDutyT

Definition at line 322 of file DtmfGen.cpp.

mDtmfSequenceT

wxTextCtrl* EffectDtmf::Validator::mDtmfSequenceT

Definition at line 317 of file DtmfGen.cpp.

mDtmfSilenceT

wxStaticText* EffectDtmf::Validator::mDtmfSilenceT

Definition at line 321 of file DtmfGen.cpp.

mDtmfToneT

wxStaticText* EffectDtmf::Validator::mDtmfToneT

Definition at line 320 of file DtmfGen.cpp.

mSettings

DtmfSettings EffectDtmf::Validator::mSettings

Definition at line 315 of file DtmfGen.cpp.

---

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

• DtmfGen.cpp