Inheritance diagram for EffectBassTreble::Validator:

Collaboration diagram for EffectBassTreble::Validator:

Public Member Functions
	Validator (EffectUIClientInterface &effect, EffectSettingsAccess &access, const EffectBassTrebleSettings &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)

void	OnBassText (wxCommandEvent &evt)

void	OnTrebleText (wxCommandEvent &evt)

void	OnGainText (wxCommandEvent &evt)

void	OnBassSlider (wxCommandEvent &evt)

void	OnTrebleSlider (wxCommandEvent &evt)

void	OnGainSlider (wxCommandEvent &evt)

void	OnLinkCheckbox (wxCommandEvent &evt)

void	UpdateGain (double oldVal, int control)

void	EnableApplyFromValidate ()

bool	EnableApplyFromTransferDataFromWindow ()

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
wxWeakRef< wxWindow >	mUIParent {}

EffectBassTrebleSettings	mSettings

wxSlider *	mBassS

wxSlider *	mTrebleS

wxSlider *	mGainS

wxTextCtrl *	mBassT

wxTextCtrl *	mTrebleT

wxTextCtrl *	mGainT

wxCheckBox *	mLinkCheckBox

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 55 of file BassTreble.cpp.

Constructor & Destructor Documentation

◆ Validator()

EffectBassTreble::Validator::Validator	(	EffectUIClientInterface &	effect,
		EffectSettingsAccess &	access,
		const EffectBassTrebleSettings &	settings
	)

inline

Definition at line 58 of file BassTreble.cpp.

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

◆ ~Validator()

virtual EffectBassTreble::Validator::~Validator ( )

virtualdefault

Member Function Documentation

◆ EnableApplyFromTransferDataFromWindow()

bool EffectBassTreble::Validator::EnableApplyFromTransferDataFromWindow ( )

inline

Definition at line 101 of file BassTreble.cpp.

   {
      return EnableApply(
         mUIParent, mUIParent->TransferDataFromWindow());
   }

References EffectUIValidator::EnableApply(), and mUIParent.

Here is the call graph for this function:

◆ EnableApplyFromValidate()

void EffectBassTreble::Validator::EnableApplyFromValidate ( )

inline

Definition at line 96 of file BassTreble.cpp.

   {
      EnableApply(mUIParent, mUIParent->Validate());
   }

References EffectUIValidator::EnableApply(), and mUIParent.

Here is the call graph for this function:

◆ GetEffect()

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

inline

Definition at line 65 of file BassTreble.cpp.

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

Effect

Base class for many of the effects in Audacity.

Definition: Effect.h:62

EffectUIValidator::mEffect

EffectUIClientInterface & mEffect

Definition: EffectPlugin.h:296

References EffectUIValidator::mEffect.

◆ OnBassSlider()

void EffectBassTreble::Validator::OnBassSlider ( wxCommandEvent & evt )

Definition at line 572 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   double oldBass = ms.mBass;
   ms.mBass = (double) evt.GetInt() / Bass.scale;
   mBassT->GetValidator()->TransferToWindow();
 
   if (ms.mLink)
      UpdateGain(oldBass, kBass);
 
   EnableApplyFromValidate();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References EffectBassTreble::Bass, kBass, EffectParameter< Structure, Member, Type, Value >::scale, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnBassText()

void EffectBassTreble::Validator::OnBassText ( wxCommandEvent & evt )

Definition at line 517 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   double oldBass = ms.mBass;
 
   if (!EnableApplyFromTransferDataFromWindow())
   {
      return;
   }
 
   if (ms.mLink)
      UpdateGain(oldBass, kBass);
 
   mBassS->SetValue((int) (ms.mBass * Bass.scale));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References EffectBassTreble::Bass, kBass, EffectParameter< Structure, Member, Type, Value >::scale, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnGainSlider()

void EffectBassTreble::Validator::OnGainSlider ( wxCommandEvent & evt )

Definition at line 606 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   ms.mGain = (double) evt.GetInt() / Gain.scale;
   mGainT->GetValidator()->TransferToWindow();
 
   EnableApplyFromValidate();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References EffectBassTreble::Gain, EffectParameter< Structure, Member, Type, Value >::scale, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnGainText()

void EffectBassTreble::Validator::OnGainText ( wxCommandEvent & evt )

Definition at line 557 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   if (!EnableApplyFromTransferDataFromWindow())
   {
      return;
   }
 
   mGainS->SetValue((int) (ms.mGain * Gain.scale));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References EffectBassTreble::Gain, EffectParameter< Structure, Member, Type, Value >::scale, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnLinkCheckbox()

void EffectBassTreble::Validator::OnLinkCheckbox ( wxCommandEvent & evt )

Definition at line 619 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   ms.mLink = mLinkCheckBox->GetValue();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTrebleSlider()

void EffectBassTreble::Validator::OnTrebleSlider ( wxCommandEvent & evt )

Definition at line 589 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   double oldTreble = ms.mTreble;
   ms.mTreble = (double) evt.GetInt() / Treble.scale;
   mTrebleT->GetValidator()->TransferToWindow();
 
   if (ms.mLink)
      UpdateGain(oldTreble, kTreble);
 
   EnableApplyFromValidate();
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References kTreble, EffectParameter< Structure, Member, Type, Value >::scale, EffectBassTreble::Treble, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnTrebleText()

void EffectBassTreble::Validator::OnTrebleText ( wxCommandEvent & evt )

Definition at line 537 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   double oldTreble = ms.mTreble;
 
   if (!EnableApplyFromTransferDataFromWindow())
   {
      return;
   }
 
   if (ms.mLink)
      UpdateGain(oldTreble, kTreble);
 
   mTrebleS->SetValue((int) (ms.mTreble * Treble.scale));
 
   ValidateUI();
   Publish(EffectSettingChanged{});
}

References kTreble, EffectParameter< Structure, Member, Type, Value >::scale, EffectBassTreble::Treble, and Effect::ValidateUI().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PopulateOrExchange()

void EffectBassTreble::Validator::PopulateOrExchange ( ShuttleGui & S )

Definition at line 282 of file BassTreble.cpp.

{
   mUIParent = S.GetParent();
   auto& ms = mSettings;
 
   S.SetBorder(5);
   S.AddSpace(0, 5);
 
   S.StartStatic(XO("Tone controls"));
   {
      S.StartMultiColumn(3, wxEXPAND);
      {
         S.SetStretchyCol(2);
 
         // Bass control
         mBassT = S
            .Name(XO("Bass (dB):"))
            .Validator<FloatingPointValidator<double>>(
               1, &ms.mBass, NumValidatorStyle::DEFAULT, Bass.min, Bass.max)
            .AddTextBox(XXO("Ba&ss (dB):"), L"", 10);
         BindTo(*mBassT, wxEVT_TEXT, &Validator::OnBassText);
 
         mBassS = S
            .Name(XO("Bass"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {}, 0, Bass.max * Bass.scale, Bass.min * Bass.scale);
         BindTo(*mBassS, wxEVT_SLIDER, &Validator::OnBassSlider);
 
         // Treble control
         mTrebleT = S
            .Validator<FloatingPointValidator<double>>(
               1, &ms.mTreble, NumValidatorStyle::DEFAULT, Treble.min, Treble.max)
            .AddTextBox(XXO("&Treble (dB):"), L"", 10);
         BindTo(*mTrebleT, wxEVT_TEXT, &Validator::OnTrebleText);
 
         mTrebleS = S
            .Name(XO("Treble"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {}, 0, Treble.max * Treble.scale, Treble.min * Treble.scale);
         BindTo(*mTrebleS, wxEVT_SLIDER, &Validator::OnTrebleSlider);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();
 
   S.StartStatic(XO("Output"));
   {
      S.StartMultiColumn(3, wxEXPAND);
      {
         S.SetStretchyCol(2);
 
         // Gain control
         mGainT = S
            .Validator<FloatingPointValidator<double>>(
               1, &ms.mGain, NumValidatorStyle::DEFAULT, Gain.min, Gain.max)
            .AddTextBox(XXO("&Volume (dB):"), L"", 10);
         BindTo(*mGainT, wxEVT_TEXT, &Validator::OnGainText);
 
         mGainS = S
            .Name(XO("Level"))
            .Style(wxSL_HORIZONTAL)
            .AddSlider( {}, 0, Gain.max * Gain.scale, Gain.min * Gain.scale);
         BindTo(*mGainS, wxEVT_SLIDER, &Validator::OnGainSlider);
      }
      S.EndMultiColumn();
 
      S.StartMultiColumn(2, wxCENTER);
      {
         // Link checkbox
         mLinkCheckBox =
         S
            .AddCheckBox(XXO("&Link Volume control to Tone controls"),
               Link.def);
         BindTo(*mLinkCheckBox, wxEVT_CHECKBOX, &Validator::OnLinkCheckbox);
      }
      S.EndMultiColumn();
   }
   S.EndStatic();   
}

References EffectBassTreble::Bass, EffectParameter< Structure, Member, Type, Value >::def, EffectBassTreble::Gain, EffectBassTreble::Link, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::min, Effect::mUIParent, OnBassSlider(), OnBassText(), OnGainSlider(), OnGainText(), OnLinkCheckbox(), OnTrebleSlider(), OnTrebleText(), S, EffectParameter< Structure, Member, Type, Value >::scale, EffectBassTreble::Treble, XO(), and XXO().

Here is the call graph for this function:

◆ UpdateGain()

void EffectBassTreble::Validator::UpdateGain	(	double	oldVal,
		int	control
	)

Definition at line 629 of file BassTreble.cpp.

{
   auto& ms = mSettings;
 
   double newVal;
   oldVal = (oldVal > 0)? oldVal / 2.0 : oldVal / 4.0;
 
   if (control == kBass)
      newVal = (ms.mBass > 0)? ms.mBass / 2.0 : ms.mBass / 4.0;
   else
      newVal = (ms.mTreble > 0)? ms.mTreble / 2.0 : ms.mTreble / 4.0;
 
   ms.mGain -= newVal - oldVal;
   ms.mGain = std::min(Gain.max, std::max(Gain.min, ms.mGain));
 
   mGainS->SetValue(ms.mGain);
   mGainT->GetValidator()->TransferToWindow();
 
}

References EffectBassTreble::Gain, kBass, EffectParameter< Structure, Member, Type, Value >::max, min(), and EffectParameter< Structure, Member, Type, Value >::min.

Here is the call graph for this function:

◆ UpdateUI()

bool EffectBassTreble::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 362 of file BassTreble.cpp.

{
   // get the settings from the MessageBuffer and write them to our local copy
   const auto& settings = mAccess.Get();
 
   mSettings = GetSettings(settings);
 
   Effect& actualEffect = static_cast<Effect&>(mEffect);
 
   if (! mUIParent->TransferDataToWindow())
   {
      return false;
   }
 
   mBassS->       SetValue((int)(mSettings.mBass * Bass.scale));
   mTrebleS->     SetValue((int)(mSettings.mTreble *Treble.scale));
   mGainS->       SetValue((int)(mSettings.mGain * Gain.scale));
   mLinkCheckBox->SetValue(mSettings.mLink);
 
   return true;
}

References EffectBassTreble::Bass, EffectBassTreble::Gain, EffectWithSettings< EffectBassTrebleSettings, PerTrackEffect >::GetSettings(), Effect::mUIParent, EffectParameter< Structure, Member, Type, Value >::scale, settings(), and EffectBassTreble::Treble.

Here is the call graph for this function:

◆ ValidateUI()

bool EffectBassTreble::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 652 of file BassTreble.cpp.

{
   // This bit was copied from the original override of the effect's TransferDataFromWindow
   Effect& actualEffect = static_cast<Effect&>(mEffect);   
   if (! mUIParent->Validate() || !mUIParent->TransferDataFromWindow())
   {
      return false;
   }
 
 
   mAccess.ModifySettings
   (
      [this](EffectSettings& settings)
   {
      // pass back the modified settings to the MessageBuffer
      //
      EffectBassTreble::GetSettings(settings) = mSettings;
 
      return nullptr;
   }
   );
 
   return true;
}

References EffectWithSettings< EffectBassTrebleSettings, PerTrackEffect >::GetSettings(), Effect::mUIParent, and settings().

Here is the call graph for this function:

Member Data Documentation

◆ mBassS

wxSlider* EffectBassTreble::Validator::mBassS

Definition at line 75 of file BassTreble.cpp.

◆ mBassT

wxTextCtrl* EffectBassTreble::Validator::mBassT

Definition at line 79 of file BassTreble.cpp.

◆ mGainS

wxSlider* EffectBassTreble::Validator::mGainS

Definition at line 77 of file BassTreble.cpp.

◆ mGainT

wxTextCtrl* EffectBassTreble::Validator::mGainT

Definition at line 81 of file BassTreble.cpp.

◆ mLinkCheckBox

wxCheckBox* EffectBassTreble::Validator::mLinkCheckBox

Definition at line 83 of file BassTreble.cpp.

◆ mSettings

EffectBassTrebleSettings EffectBassTreble::Validator::mSettings

Definition at line 73 of file BassTreble.cpp.

◆ mTrebleS

wxSlider* EffectBassTreble::Validator::mTrebleS

Definition at line 76 of file BassTreble.cpp.

◆ mTrebleT

wxTextCtrl* EffectBassTreble::Validator::mTrebleT

Definition at line 80 of file BassTreble.cpp.

◆ mUIParent

wxWeakRef<wxWindow> EffectBassTreble::Validator::mUIParent {}

Definition at line 72 of file BassTreble.cpp.

Referenced by EnableApplyFromTransferDataFromWindow(), and EnableApplyFromValidate().

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

BassTreble.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Validator()

◆ ~Validator()

Member Function Documentation

◆ EnableApplyFromTransferDataFromWindow()

◆ EnableApplyFromValidate()

◆ GetEffect()

◆ OnBassSlider()

◆ OnBassText()

◆ OnGainSlider()

◆ OnGainText()

◆ OnLinkCheckbox()

◆ OnTrebleSlider()

◆ OnTrebleText()

◆ PopulateOrExchange()

◆ UpdateGain()

◆ UpdateUI()

◆ ValidateUI()

Member Data Documentation

◆ mBassS

◆ mBassT

◆ mGainS

◆ mGainT

◆ mLinkCheckBox

◆ mSettings

◆ mTrebleS

◆ mTrebleT

◆ mUIParent