LadspaEffectOptionsDialog Class Reference

#include <LadspaEffectOptionsDialog.h>

Inheritance diagram for LadspaEffectOptionsDialog:

Collaboration diagram for LadspaEffectOptionsDialog:

Public Member Functions
	LadspaEffectOptionsDialog (const EffectDefinitionInterface &effect)
virtual	~LadspaEffectOptionsDialog ()
void	PopulateOrExchange (ShuttleGui &S)
void	OnOk (wxCommandEvent &evt)
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Attributes
const EffectDefinitionInterface &	mEffect
bool	mUseLatency {}

Detailed Description

Definition at line 18 of file LadspaEffectOptionsDialog.h.

Constructor & Destructor Documentation

LadspaEffectOptionsDialog()

LadspaEffectOptionsDialog::LadspaEffectOptionsDialog ( const EffectDefinitionInterface &  effect )

explicit

Definition at line 21 of file LadspaEffectOptionsDialog.cpp.

   : wxDialogWrapper{ nullptr, wxID_ANY, XO("LADSPA Effect Options") }
   , mEffect{ effect }
   , mUseLatency{ LadspaInstance::LoadUseLatency(mEffect) }
{
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
}

References XO().

Here is the call graph for this function:

~LadspaEffectOptionsDialog()

LadspaEffectOptionsDialog::~LadspaEffectOptionsDialog ( )

virtual

Definition at line 31 of file LadspaEffectOptionsDialog.cpp.

{
}

Member Function Documentation

OnOk()

void LadspaEffectOptionsDialog::OnOk

(

wxCommandEvent &

evt

)

Definition at line 72 of file LadspaEffectOptionsDialog.cpp.

{
   if (!Validate())
   {
      return;
   }
 
   ShuttleGui S(this, eIsGettingFromDialog);
   // Note this call re-visits the controls, not to create them but to fetch
   // the values, in this case mUseLatency
   PopulateOrExchange(S);
 
   LadspaInstance::SaveUseLatency(mEffect, mUseLatency);
 
   EndModal(wxID_OK);
}

References eIsGettingFromDialog, mEffect, mUseLatency, PopulateOrExchange(), S, and LadspaInstance::SaveUseLatency().

Here is the call graph for this function:

PopulateOrExchange()

void LadspaEffectOptionsDialog::PopulateOrExchange

(

ShuttleGui &

S

)

Definition at line 35 of file LadspaEffectOptionsDialog.cpp.

{
   S.SetBorder(5);
   S.StartHorizontalLay(wxEXPAND, 1);
   {
      S.StartVerticalLay(false);
      {
         S.StartStatic(XO("Latency Compensation"));
         {
            S.AddVariableText( XO(
"As part of their processing, some LADSPA effects must delay returning "
"audio to Audacity. When not compensating for this delay, you will "
"notice that small silences have been inserted into the audio. "
"Enabling this option will provide that compensation, but it may "
"not work for all LADSPA effects."),
               false, 0, 650);
 
            S.StartHorizontalLay(wxALIGN_LEFT);
            {
               S.TieCheckBox(XXO("Enable &compensation"),
                             mUseLatency);
            }
            S.EndHorizontalLay();
         }
         S.EndStatic();
      }
      S.EndVerticalLay();
   }
   S.EndHorizontalLay();
 
   S.AddStandardButtons();
 
   Layout();
   Fit();
   Center();
}

References mUseLatency, S, XO(), and XXO().

Referenced by OnOk().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mEffect

const EffectDefinitionInterface& LadspaEffectOptionsDialog::mEffect

private

Definition at line 29 of file LadspaEffectOptionsDialog.h.

Referenced by OnOk().

mUseLatency

bool LadspaEffectOptionsDialog::mUseLatency {}

private

Definition at line 30 of file LadspaEffectOptionsDialog.h.

Referenced by OnOk(), and PopulateOrExchange().

---

The documentation for this class was generated from the following files:

• LadspaEffectOptionsDialog.h
• LadspaEffectOptionsDialog.cpp