Audacity 3.2.0
Public Member Functions | Private Attributes | List of all members
LadspaEffectOptionsDialog Class Referencefinal

#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
wxTabTraversalWrapperoperator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapperoperator= (wxTabTraversalWrapper &&)=delete

Private Attributes

const EffectDefinitionInterfacemEffect
bool mUseLatency {}

Detailed Description

Definition at line 18 of file LadspaEffectOptionsDialog.h.

Constructor & Destructor Documentation

◆ LadspaEffectOptionsDialog()

LadspaEffectOptionsDialog::LadspaEffectOptionsDialog ( const EffectDefinitionInterface effect)

Definition at line 21 of file LadspaEffectOptionsDialog.cpp.

23 : wxDialogWrapper{ nullptr, wxID_ANY, XO("LADSPA Effect Options") }
24 , mEffect{ effect }
@ eIsCreating
Definition: ShuttleGui.h:37
#define S(N)
Definition: ToChars.cpp:64
const EffectDefinitionInterface & mEffect
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:625
static bool LoadUseLatency(const EffectDefinitionInterface &effect)
Get the preference for using latency.

References XO().

Here is the call graph for this function:

◆ ~LadspaEffectOptionsDialog()

LadspaEffectOptionsDialog::~LadspaEffectOptionsDialog ( )

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.

74 if (!Validate())
75 {
76 return;
77 }
80 // Note this call re-visits the controls, not to create them but to fetch
81 // the values, in this case mUseLatency
86 EndModal(wxID_OK);
@ eIsGettingFromDialog
Definition: ShuttleGui.h:38
static bool SaveUseLatency(const EffectDefinitionInterface &effect, bool value)
Set the preference for using latency.

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.

37 S.SetBorder(5);
38 S.StartHorizontalLay(wxEXPAND, 1);
39 {
40 S.StartVerticalLay(false);
41 {
42 S.StartStatic(XO("Latency Compensation"));
43 {
44 S.AddVariableText( XO(
45"As part of their processing, some LADSPA effects must delay returning "
46"audio to Audacity. When not compensating for this delay, you will "
47"notice that small silences have been inserted into the audio. "
48"Enabling this option will provide that compensation, but it may "
49"not work for all LADSPA effects."),
50 false, 0, 650);
52 S.StartHorizontalLay(wxALIGN_LEFT);
53 {
54 S.TieCheckBox(XXO("Enable &compensation"),
56 }
57 S.EndHorizontalLay();
58 }
59 S.EndStatic();
60 }
61 S.EndVerticalLay();
62 }
63 S.EndHorizontalLay();
65 S.AddStandardButtons();
67 Layout();
68 Fit();
69 Center();
XXO("&Cut/Copy/Paste Toolbar")

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

Definition at line 29 of file LadspaEffectOptionsDialog.h.

Referenced by OnOk().

◆ mUseLatency

bool LadspaEffectOptionsDialog::mUseLatency {}

Definition at line 30 of file LadspaEffectOptionsDialog.h.

Referenced by OnOk(), and PopulateOrExchange().

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