![]() |
Audacity 3.2.0
|
#include <EffectUI.h>
Public Member Functions | |
EffectUIHost (wxWindow *parent, AudacityProject &project, EffectPlugin &effect, EffectUIClientInterface &client, std::shared_ptr< EffectInstance > &pInstance, EffectSettingsAccess &access, const std::shared_ptr< RealtimeEffectState > &pPriorState={}) | |
virtual | ~EffectUIHost () |
bool | TransferDataToWindow () override |
bool | TransferDataFromWindow () override |
int | ShowModal () override |
bool | Initialize () |
EffectUIValidator * | GetValidator () const |
bool | HandleCommandKeystrokes () override |
void | SetClosed () |
![]() | |
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 () |
![]() | |
wxTabTraversalWrapper (Args &&... args) | |
wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete | |
wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete | |
wxTabTraversalWrapper & | operator= (const wxTabTraversalWrapper &)=delete |
wxTabTraversalWrapper & | operator= (wxTabTraversalWrapper &&)=delete |
![]() | |
virtual | ~TopLevelKeystrokeHandlingWindow () |
virtual bool | HandleCommandKeystrokes () |
Private Member Functions | |
std::shared_ptr< EffectInstance > | InitializeInstance () |
wxPanel * | BuildButtonBar (wxWindow *parent, bool graphicalUI) |
void | BuildButtonBar (ShuttleGui &S, bool graphicalUI) |
void | OnInitDialog (wxInitDialogEvent &evt) |
void | OnErase (wxEraseEvent &evt) |
void | OnPaint (wxPaintEvent &evt) |
void | OnClose (wxCloseEvent &evt) |
void | OnApply (wxCommandEvent &evt) |
void | DoCancel () |
void | OnCancel (wxCommandEvent &evt) |
void | OnDebug (wxCommandEvent &evt) |
void | OnMenu (wxCommandEvent &evt) |
void | OnEnable (wxCommandEvent &evt) |
void | OnPlay (wxCommandEvent &evt) |
void | OnPlayback (AudioIOEvent) |
void | OnCapture (AudioIOEvent) |
void | OnUserPreset (wxCommandEvent &evt) |
void | OnFactoryPreset (wxCommandEvent &evt) |
void | OnDeletePreset (wxCommandEvent &evt) |
void | OnSaveAs (wxCommandEvent &evt) |
void | OnImport (wxCommandEvent &evt) |
void | OnExport (wxCommandEvent &evt) |
void | OnOptions (wxCommandEvent &evt) |
void | OnDefaults (wxCommandEvent &evt) |
void | OnIdle (wxIdleEvent &evt) |
void | OnCharHook (wxKeyEvent &evt) |
bool | IsOpenedFromEffectPanel () const |
void | UpdateControls () |
wxBitmap | CreateBitmap (const char *const xpm[], bool up, bool pusher) |
void | LoadUserPresets () |
void | CleanupRealtime () |
void | StopPlayback () |
Definition at line 42 of file EffectUI.h.
EffectUIHost::EffectUIHost | ( | wxWindow * | parent, |
AudacityProject & | project, | ||
EffectPlugin & | effect, | ||
EffectUIClientInterface & | client, | ||
std::shared_ptr< EffectInstance > & | pInstance, | ||
EffectSettingsAccess & | access, | ||
const std::shared_ptr< RealtimeEffectState > & | pPriorState = {} |
||
) |
Definition at line 227 of file EffectUI.cpp.
References EffectPlugin::GetDefinition(), ComponentInterface::GetName(), mpInstance, and wxDialogWrapper::SetName().
|
virtual |
Definition at line 263 of file EffectUI.cpp.
References mpValidator.
|
private |
Definition at line 340 of file EffectUI.cpp.
References _, eDebugID, EffectTypeAnalyze, EffectTypeTool, EffectDefinitionInterface::EnablesDebug(), EffectPlugin::GetDefinition(), EffectDefinitionInterface::GetType(), EffectPlugin::IsBatchProcessing(), IsOpenedFromEffectPanel(), kEnableID, kMenuID, kPlayID, mApplyBtn, mDebugBtn, mEffectUIHost, mEnableBtn, mEnabled, mIsBatch, mIsGUI, mMenuBtn, mPlayToggleBtn, mpTempProjectState, mRealtimeDisabledBM, mRealtimeEnabledBM, mSupportsRealtime, S, XO(), and XXO().
|
private |
|
private |
Definition at line 1170 of file EffectUI.cpp.
References AudioIO::Get(), IsOpenedFromEffectPanel(), mAudioIOSubscription, mEffectStateSubscription, mInitialized, mProject, mpTempProjectState, mSupportsRealtime, AudioIO::RemoveState(), and Observer::Subscription::Reset().
Referenced by OnClose().
|
private |
Definition at line 1025 of file EffectUI.cpp.
|
private |
Definition at line 605 of file EffectUI.cpp.
References CurrentSettingsGroup(), EffectPlugin::GetDefinition(), mDismissed, mEffectUIHost, mHadPriorState, mpAccess, and settings().
Referenced by OnCancel(), and OnClose().
|
inline |
|
overridevirtual |
By default returns true, meaning that keystrokes should be handled by associated CommandManager.
Reimplemented from TopLevelKeystrokeHandlingWindow.
Definition at line 480 of file EffectUI.cpp.
bool EffectUIHost::Initialize | ( | ) |
Definition at line 420 of file EffectUI.cpp.
References ThemeBase::Bitmap(), BuildButtonBar(), eIsCreating, IsOpenedFromEffectPanel(), LoadUserPresets(), mApplyBtn, mClient, mEnabled, mIsGUI, mpAccess, mParent, mpInstance, mpOutputs, mpValidator, mRealtimeDisabledBM, mRealtimeEnabledBM, EffectUIClientInterface::PopulateUI(), RTL_WORKAROUND, S, safenew, theTheme, and UpdateControls().
|
private |
Definition at line 1106 of file EffectUI.cpp.
References AudioIO::AddState(), EffectOn, AudioIO::Get(), GetID(), EffectInstanceFactory::MakeInstance(), mAudioIOSubscription, mCapturing, mDisableTransport, mEffectStateSubscription, mEffectUIHost, mEnableBtn, mEnabled, mInitialized, mpAccess, mpAccess2, mPlaying, mProject, mpTempProjectState, mRealtimeDisabledBM, mRealtimeEnabledBM, mSupportsRealtime, mwState, Observer::Publisher< Message, NotifyAll >::Subscribe(), AudioIOEvent::type, and UpdateControls().
|
private |
Definition at line 1020 of file EffectUI.cpp.
References mpTempProjectState, and mSupportsRealtime.
Referenced by BuildButtonBar(), CleanupRealtime(), Initialize(), OnCharHook(), and UpdateControls().
|
private |
Definition at line 1094 of file EffectUI.cpp.
References PluginSettings::GetConfigSubgroups(), EffectPlugin::GetDefinition(), mEffectUIHost, mUserPresets, PluginSettings::Private, and UserPresetsGroup().
Referenced by Initialize(), OnDeletePreset(), OnImport(), OnMenu(), and OnSaveAs().
|
private |
Definition at line 540 of file EffectUI.cpp.
References AlwaysEnabledFlag, CurrentSettingsGroup(), EffectUI::DoEffect(), EffectTypeGenerate, EffectTypeTool, ViewInfo::Get(), MenuManager::Get(), EffectPlugin::GetDefinition(), GetID(), ComponentInterface::GetName(), EffectDefinitionInterface::GetType(), NotifyingSelectedRegion::isPoint(), EffectManager::kConfigured, mApplyBtn, mDismissed, mEffectUIHost, mIsBatch, mpAccess, mPlaying, mProject, MenuManager::ReportIfActionNotAllowed(), EffectSettingsManager::SaveUserPreset(), ViewInfo::selectedRegion, StopPlayback(), TimeSelectedFlag(), TransferDataFromWindow(), and WaveTracksSelectedFlag().
Referenced by OnDebug().
|
private |
Definition at line 626 of file EffectUI.cpp.
References DoCancel().
Referenced by OnCharHook().
|
private |
Definition at line 817 of file EffectUI.cpp.
References mCapturing, mDisableTransport, mProject, AudioIOEvent::on, AudioIOEvent::pProject, and UpdateControls().
|
private |
Definition at line 1002 of file EffectUI.cpp.
References IsOpenedFromEffectPanel(), OnCancel(), and wxEVT_COMMAND_BUTTON_CLICKED.
|
private |
Definition at line 521 of file EffectUI.cpp.
References CleanupRealtime(), DoCancel(), mPlaying, mpValidator, and StopPlayback().
|
private |
Definition at line 632 of file EffectUI.cpp.
References OnApply().
|
private |
Definition at line 984 of file EffectUI.cpp.
References EffectPlugin::GetDefinition(), mEffectUIHost, mpAccess, settings(), and TransferDataToWindow().
|
private |
Definition at line 856 of file EffectUI.cpp.
References AudacityMessageBox(), EffectPlugin::GetDefinition(), kDeletePresetID, LoadUserPresets(), mEffectUIHost, mUserPresets, preset, PluginSettings::Private, PluginSettings::RemoveConfigSubgroup(), UserPresetsGroup(), and XO().
|
private |
Definition at line 740 of file EffectUI.cpp.
References mEnabled, mwState, and UpdateControls().
|
private |
Definition at line 509 of file EffectUI.cpp.
|
private |
Definition at line 967 of file EffectUI.cpp.
References EffectUIClientInterface::ExportPresets(), mClient, mpAccess, and TransferDataFromWindow().
|
private |
ignore failure
Definition at line 845 of file EffectUI.cpp.
References EffectPlugin::GetDefinition(), kFactoryPresetsID, mEffectUIHost, mpAccess, settings(), and TransferDataToWindow().
|
private |
Definition at line 995 of file EffectUI.cpp.
References mpAccess.
|
private |
Definition at line 955 of file EffectUI.cpp.
References EffectUIClientInterface::ImportPresets(), LoadUserPresets(), mClient, mpAccess, settings(), and TransferDataToWindow().
|
private |
Definition at line 486 of file EffectUI.cpp.
|
private |
Definition at line 648 of file EffectUI.cpp.
References _, EffectUIClientInterface::CanExportPresets(), TranslatableString::empty(), cloud::factory, EffectPlugin::GetDefinition(), EffectSettingsManager::GetFactoryPresets(), anonymous_namespace{EffectUI.cpp}::GetVersionForDisplay(), EffectUIClientInterface::HasOptions(), kDefaultsID, kDeletePresetDummyID, kDeletePresetID, kDummyID, kExportID, kFactoryPresetsID, kImportID, kMenuID, kOptionsID, kSaveAsID, kUserPresetsDummyID, kUserPresetsID, label, LoadUserPresets(), mClient, mEffectUIHost, mUserPresets, and BasicMenu::Handle::Popup().
|
private |
Definition at line 977 of file EffectUI.cpp.
References mClient, and EffectUIClientInterface::ShowOptions().
|
private |
Definition at line 514 of file EffectUI.cpp.
|
private |
Definition at line 751 of file EffectUI.cpp.
References ViewInfo::Get(), ProjectAudioManager::Get(), ProjectAudioIO::GetDefaultOptions(), mEffectUIHost, mpAccess, mPlaying, mPlayPos, mProject, mRegion, mSupportsRealtime, normalPlay, EffectPlugin::Preview(), SelectedRegion::setTimes(), StopPlayback(), SelectedRegion::t0(), SelectedRegion::t1(), and TransferDataFromWindow().
|
private |
Definition at line 797 of file EffectUI.cpp.
References ViewInfo::Get(), mDisableTransport, mPlaying, mPlayPos, mProject, mRegion, AudioIOEvent::on, AudioIOEvent::pProject, ViewInfo::selectedRegion, SelectedRegion::t0(), and UpdateControls().
|
private |
Definition at line 875 of file EffectUI.cpp.
References eIsCreating, TranslatableString::empty(), EffectPlugin::GetDefinition(), LoadUserPresets(), make_iterator_range(), mEffectUIHost, mpAccess, mUserPresets, name, S, EffectSettingsManager::SaveUserPreset(), TransferDataFromWindow(), UserPresetsGroup(), XO(), and XXO().
|
private |
Definition at line 832 of file EffectUI.cpp.
References EffectPlugin::GetDefinition(), kUserPresetsID, mEffectUIHost, mpAccess, mUserPresets, preset, settings(), TransferDataToWindow(), and UserPresetsGroup().
|
inline |
Definition at line 69 of file EffectUI.h.
|
override |
Definition at line 324 of file EffectUI.cpp.
References EffectTypeGenerate, EffectPlugin::GetDefinition(), EffectDefinitionInterface::GetType(), mApplyBtn, mEffectUIHost, and XXO().
|
private |
Definition at line 1191 of file EffectUI.cpp.
References AudioIO::Get(), ProjectAudioManager::Get(), mPlaying, mPlayPos, and mProject.
Referenced by OnApply(), OnClose(), and OnPlay().
|
override |
Do validations of any wxValidator objects
Do transfers of any wxValidator objects
Do other custom validation and transfer actions
Definition at line 285 of file EffectUI.cpp.
References EffectTypeGenerate, EffectPlugin::GetDefinition(), mEffectUIHost, mpAccess, mpValidator, settings(), and EffectPlugin::TransferDataFromWindow().
Referenced by OnApply(), OnExport(), OnPlay(), and OnSaveAs().
|
override |
Do other appearance updates
Do validators
Definition at line 275 of file EffectUI.cpp.
References mEffectUIHost, mpAccess, mpValidator, and EffectPlugin::TransferDataToWindow().
Referenced by OnDefaults(), OnFactoryPreset(), OnImport(), and OnUserPreset().
|
private |
Definition at line 1058 of file EffectUI.cpp.
References _, IsOpenedFromEffectPanel(), mApplyBtn, mCapturing, mDisableTransport, mEnableBtn, mEnabled, mIsBatch, mPlaying, mPlayToggleBtn, mRealtimeDisabledBM, mRealtimeEnabledBM, and mSupportsRealtime.
Referenced by Initialize(), InitializeInstance(), OnCapture(), OnEnable(), and OnPlayback().
|
private |
Definition at line 136 of file EffectUI.h.
Referenced by BuildButtonBar(), Initialize(), OnApply(), ShowModal(), and UpdateControls().
|
private |
Definition at line 116 of file EffectUI.h.
Referenced by CleanupRealtime(), and InitializeInstance().
|
private |
Definition at line 149 of file EffectUI.h.
Referenced by InitializeInstance(), OnCapture(), and UpdateControls().
|
private |
Definition at line 121 of file EffectUI.h.
Referenced by Initialize(), OnExport(), OnImport(), OnMenu(), and OnOptions().
|
private |
Definition at line 139 of file EffectUI.h.
Referenced by BuildButtonBar().
|
private |
Definition at line 147 of file EffectUI.h.
Referenced by InitializeInstance(), OnCapture(), OnPlayback(), and UpdateControls().
|
private |
Definition at line 154 of file EffectUI.h.
Referenced by DoCancel(), and OnApply().
|
private |
Definition at line 116 of file EffectUI.h.
Referenced by CleanupRealtime(), and InitializeInstance().
|
private |
Definition at line 120 of file EffectUI.h.
Referenced by BuildButtonBar(), DoCancel(), InitializeInstance(), LoadUserPresets(), OnApply(), OnDefaults(), OnDeletePreset(), OnFactoryPreset(), OnMenu(), OnPlay(), OnSaveAs(), OnUserPreset(), ShowModal(), TransferDataFromWindow(), and TransferDataToWindow().
|
private |
Definition at line 138 of file EffectUI.h.
Referenced by BuildButtonBar(), InitializeInstance(), and UpdateControls().
|
private |
Definition at line 145 of file EffectUI.h.
Referenced by BuildButtonBar(), Initialize(), InitializeInstance(), OnEnable(), and UpdateControls().
|
private |
Definition at line 155 of file EffectUI.h.
Referenced by DoCancel().
|
private |
Definition at line 131 of file EffectUI.h.
Referenced by CleanupRealtime(), and InitializeInstance().
|
private |
Definition at line 134 of file EffectUI.h.
Referenced by BuildButtonBar(), OnApply(), and UpdateControls().
|
private |
Definition at line 133 of file EffectUI.h.
Referenced by BuildButtonBar(), and Initialize().
|
private |
Definition at line 137 of file EffectUI.h.
Referenced by BuildButtonBar().
|
private |
Definition at line 124 of file EffectUI.h.
Referenced by DoCancel(), Initialize(), InitializeInstance(), OnApply(), OnDefaults(), OnExport(), OnFactoryPreset(), OnIdle(), OnImport(), OnPlay(), OnSaveAs(), OnUserPreset(), TransferDataFromWindow(), and TransferDataToWindow().
|
private |
Definition at line 125 of file EffectUI.h.
Referenced by InitializeInstance().
|
private |
Definition at line 119 of file EffectUI.h.
Referenced by Initialize().
|
private |
Definition at line 123 of file EffectUI.h.
|
private |
Definition at line 162 of file EffectUI.h.
Referenced by EffectUIHost(), and Initialize().
|
private |
Definition at line 148 of file EffectUI.h.
Referenced by InitializeInstance(), OnApply(), OnClose(), OnPlay(), OnPlayback(), StopPlayback(), and UpdateControls().
|
private |
Definition at line 152 of file EffectUI.h.
Referenced by OnPlay(), OnPlayback(), and StopPlayback().
|
private |
Definition at line 140 of file EffectUI.h.
Referenced by BuildButtonBar(), and UpdateControls().
|
private |
Definition at line 163 of file EffectUI.h.
Referenced by Initialize().
|
private |
Definition at line 118 of file EffectUI.h.
Referenced by CleanupRealtime(), InitializeInstance(), OnApply(), OnCapture(), OnPlay(), OnPlayback(), and StopPlayback().
|
private |
Definition at line 128 of file EffectUI.h.
Referenced by BuildButtonBar(), CleanupRealtime(), InitializeInstance(), and IsOpenedFromEffectPanel().
|
private |
Definition at line 165 of file EffectUI.h.
Referenced by GetValidator(), Initialize(), OnClose(), TransferDataFromWindow(), TransferDataToWindow(), and ~EffectUIHost().
|
private |
Definition at line 143 of file EffectUI.h.
Referenced by BuildButtonBar(), Initialize(), InitializeInstance(), and UpdateControls().
|
private |
Definition at line 142 of file EffectUI.h.
Referenced by BuildButtonBar(), Initialize(), InitializeInstance(), and UpdateControls().
|
private |
Definition at line 151 of file EffectUI.h.
Referenced by OnPlay(), and OnPlayback().
|
private |
Definition at line 132 of file EffectUI.h.
Referenced by BuildButtonBar(), CleanupRealtime(), InitializeInstance(), IsOpenedFromEffectPanel(), OnPlay(), and UpdateControls().
|
private |
Definition at line 130 of file EffectUI.h.
Referenced by LoadUserPresets(), OnDeletePreset(), OnMenu(), OnSaveAs(), and OnUserPreset().
|
private |
Definition at line 126 of file EffectUI.h.
Referenced by InitializeInstance(), and OnEnable().