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

#include <AudioUnitEffectOptionsDialog.h>

Inheritance diagram for AudioUnitEffectOptionsDialog:
Collaboration diagram for AudioUnitEffectOptionsDialog:

Public Member Functions

 AudioUnitEffectOptionsDialog (wxWindow *parent, bool &useLatencey, wxString &uiType)
virtual ~AudioUnitEffectOptionsDialog ()
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

bool & mUseLatency
wxString & mUIType
TranslatableString mUITypeString

Detailed Description

Definition at line 27 of file AudioUnitEffectOptionsDialog.h.

Constructor & Destructor Documentation

◆ AudioUnitEffectOptionsDialog()

AudioUnitEffectOptionsDialog::AudioUnitEffectOptionsDialog ( wxWindow *  parent,
bool &  useLatencey,
wxString &  uiType 

Definition at line 28 of file AudioUnitEffectOptionsDialog.cpp.

30: wxDialogWrapper(parent, wxID_ANY, XO("Audio Unit Effect Options"))
31, mUseLatency{ useLatency }
32, mUIType{ uiType }
33// Get the localization of the string for display to the user
@ eIsCreating
Definition: ShuttleGui.h:39
#define S(N)
Definition: ToChars.cpp:64
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:628

◆ ~AudioUnitEffectOptionsDialog()

AudioUnitEffectOptionsDialog::~AudioUnitEffectOptionsDialog ( )

Definition at line 40 of file AudioUnitEffectOptionsDialog.cpp.


Member Function Documentation

◆ OnOk()

void AudioUnitEffectOptionsDialog::OnOk ( wxCommandEvent &  evt)

Definition at line 106 of file AudioUnitEffectOptionsDialog.cpp.

108 if (!Validate())
109 return;
111 // This re-visits the controls, not to create them but to transfer values out
115 // un-translate the type
117 EndModal(wxID_OK);
@ eIsGettingFromDialog
Definition: ShuttleGui.h:40
const wxString & GET() const
Explicit conversion to wxString, meant to be ugly-looking and demanding of a comment why it's correct...
Definition: Identifier.h:66
Identifier MSGID() const
MSGID is the English lookup key in the catalog, not necessarily for user's eyes if locale is some oth...

References eIsGettingFromDialog, Identifier::GET(), TranslatableString::MSGID(), mUIType, mUITypeString, PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ PopulateOrExchange()

void AudioUnitEffectOptionsDialog::PopulateOrExchange ( ShuttleGui S)

Definition at line 44 of file AudioUnitEffectOptionsDialog.cpp.

46 S.SetBorder(5);
47 S.StartHorizontalLay(wxEXPAND, 1);
48 {
49 S.StartVerticalLay(false);
50 {
51 S.StartStatic(XO("Latency Compensation"));
52 {
53 S.AddVariableText(XO(
54"As part of their processing, some Audio Unit effects must delay returning "
55"audio to Audacity. When not compensating for this delay, you will "
56"notice that small silences have been inserted into the audio. "
57"Enabling this option will provide that compensation, but it may "
58"not work for all Audio Unit effects."),
59 false, 0, 650);
61 S.StartHorizontalLay(wxALIGN_LEFT);
62 {
63 S.TieCheckBox(XXO("Enable &compensation"),
65 }
66 S.EndHorizontalLay();
67 }
68 S.EndStatic();
70 S.StartStatic(XO("User Interface"));
71 {
72 S.AddVariableText(XO(
73"Select \"Full\" to use the graphical interface if supplied by the Audio Unit."
74" Select \"Generic\" to use the system supplied generic interface."
76" Select \"Basic\" for a basic text-only interface."
78" Reopen the effect for this to take effect."),
79 false, 0, 650);
81 S.StartHorizontalLay(wxALIGN_LEFT);
82 {
83 S.TieChoice(XXO("Select &interface"),
85 {
91 });
92 }
93 S.EndHorizontalLay();
94 }
95 S.EndStatic();
96 }
97 S.EndVerticalLay();
98 }
99 S.EndHorizontalLay();
100 S.AddStandardButtons();
101 Layout();
102 Fit();
103 Center();
static const auto BasicValue
static const auto FullValue
static const auto GenericValue
XXO("&Cut/Copy/Paste Toolbar")

References BasicValue, FullValue, GenericValue, mUITypeString, 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

◆ mUIType

wxString& AudioUnitEffectOptionsDialog::mUIType

Definition at line 37 of file AudioUnitEffectOptionsDialog.h.

Referenced by OnOk().

◆ mUITypeString

TranslatableString AudioUnitEffectOptionsDialog::mUITypeString

Definition at line 38 of file AudioUnitEffectOptionsDialog.h.

Referenced by OnOk(), and PopulateOrExchange().

◆ mUseLatency

bool& AudioUnitEffectOptionsDialog::mUseLatency

Definition at line 36 of file AudioUnitEffectOptionsDialog.h.

Referenced by PopulateOrExchange().

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