Inheritance diagram for EffectDtmf::Editor:

Collaboration diagram for EffectDtmf::Editor:

Public Member Functions
	Editor (const EffectUIServices &effect, EffectSettingsAccess &access, const DtmfSettings &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	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 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
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 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 33 of file DtmfGen.cpp.

Constructor & Destructor Documentation

◆ Editor()

EffectDtmf::Editor::Editor	(	const EffectUIServices &	effect,
		EffectSettingsAccess &	access,
		const DtmfSettings &	settings
	)

inline

Definition at line 36 of file DtmfGen.cpp.

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

◆ ~Editor()

virtual EffectDtmf::Editor::~Editor ( )

virtualdefault

Member Function Documentation

◆ DoUpdateUI()

void EffectDtmf::Editor::DoUpdateUI ( )

Definition at line 204 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:

◆ OnDuration()

void EffectDtmf::Editor::OnDuration ( wxCommandEvent & evt )

Definition at line 233 of file DtmfGen.cpp.

{
   mAccess.ModifySettings([this](EffectSettings &settings){
      auto &dtmfSettings = mSettings;
      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::Editor::OnDutyCycle ( wxCommandEvent & evt )

Definition at line 244 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 DtmfBase::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::Editor::OnSequence ( wxCommandEvent & evt )

Definition at line 222 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::Editor::PopulateOrExchange	(	ShuttleGui &	S,
		const EffectSettings &	settings,
		double	projectRate
	)

Definition at line 65 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);
            wxArrayString symbols;
            symbols.Alloc(DtmfBase::kSymbols.size());
            for (auto c : DtmfBase::kSymbols)
               symbols.Add(wxString::Format(wxT("%c"), c));
            vldDtmf.SetIncludes(symbols);
            return vldDtmf;
         })
         .AddTextBox(XXO("DTMF &sequence:"), wxT(""), 10);
      BindTo(*mDtmfSequenceT, wxEVT_TEXT, &Editor::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(FormatterContext::SampleRateContext(projectRate),
                         S.GetParent(), wxID_ANY,
                         NumericConverterType_TIME(),
                         extra.GetDurationFormat(),
                         extra.GetDuration(),
                         NumericTextCtrl::Options{}
                            .AutoPos(true));
      S.Name(XO("Duration"))
         .AddWindow(mDtmfDurationT);
      BindTo(*mDtmfDurationT, wxEVT_TEXT, &Editor::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, &Editor::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 DtmfBase::Amplitude, NumericTextCtrl::Options::AutoPos(), EffectEditor::BindTo(), DtmfBase::DutyCycle, DtmfBase::kSymbols, EffectParameter< Structure, Member, Type, Value >::max, mDtmfDurationT, mDtmfDutyCycleS, mDtmfDutyT, mDtmfSequenceT, mDtmfSilenceT, mDtmfToneT, EffectParameter< Structure, Member, Type, Value >::min, mSettings, NumericConverterType_TIME(), OnDuration(), OnDutyCycle(), OnSequence(), S, safenew, FormatterContext::SampleRateContext(), EffectParameter< Structure, Member, Type, Value >::scale, settings(), size, wxT(), XO(), and XXO().

Here is the call graph for this function:

◆ UpdateUI()

bool EffectDtmf::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 170 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 DtmfBase::DutyCycle, EffectWithSettings< DtmfSettings, PerTrackEffect >::GetSettings(), EffectParameter< Structure, Member, Type, Value >::scale, and settings().

Here is the call graph for this function:

◆ ValidateUI()

bool EffectDtmf::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 187 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;
}