EffectUI Namespace Reference

Functions
bool	DoEffect (const PluginID &ID, AudacityProject &project, unsigned flags)
AUDACITY_DLL_API DialogFactoryResults	DialogFactory (wxWindow &parent, EffectBase &host, EffectUIServices &client, EffectSettingsAccess &access)

Function Documentation

DialogFactory()

DialogFactoryResults EffectUI::DialogFactory	(	wxWindow &	parent,
		EffectBase &	host,
		EffectUIServices &	client,
		EffectSettingsAccess &	access
	)

Definition at line 1112 of file EffectUI.cpp.

{
   // Make sure there is an associated project, whose lifetime will
   // govern the lifetime of the dialog, even when the dialog is
   // non-modal, as for realtime effects
   auto project = FindProjectFromWindow(&parent);
   if ( !project )
      return {};
   std::shared_ptr<EffectInstance> pInstance;
   Destroy_ptr<EffectUIHost> dlg{ safenew EffectUIHost{ &parent,
      *project, host, client, pInstance, access } };
   if (!pInstance) {
      dlg->SetClosed();
      return {};
   }
   if (dlg->Initialize()) {
      auto pEditor = dlg->GetEditor();
      // release() is safe because parent will own it
      return { dlg.release(), pInstance, pEditor };
   }
   return {};
}

References FindProjectFromWindow(), project, and safenew.

Referenced by DoEffect(), and MacroCommands::PromptForParamsFor().

Here is the call graph for this function:

Here is the caller graph for this function:

DoEffect()

bool EffectUI::DoEffect	(	const PluginID &	ID,
		AudacityProject &	project,
		unsigned	flags
	)

Definition at line 30 of file DoEffect.cpp.

{
   auto getShowEffectHostInterfaceCb =
      [window = &GetProjectFrame(project)](
         Effect& effect, std::shared_ptr<EffectInstance>& pInstance,
         SimpleEffectSettingsAccess& access) {
         const auto pServices = dynamic_cast<EffectUIServices*>(&effect);
         return pServices && pServices->ShowHostInterface(
                                effect, *window, EffectUI::DialogFactory,
                                pInstance, access, true);
      };
   auto selectAllIfNoneCb = [&]() {
      SelectUtilities::SelectAllIfNone(project);
   };
   return AudacityApplicationLogic::DoEffect(
      ID, project, flags, std::move(getShowEffectHostInterfaceCb),
      StopPlaybackCb(project), std::move(selectAllIfNoneCb));
}

References DialogFactory(), AudacityApplicationLogic::DoEffect(), GetProjectFrame(), project, SelectUtilities::SelectAllIfNone(), EffectUIServices::ShowHostInterface(), and anonymous_namespace{DoEffect.cpp}::StopPlaybackCb().

Referenced by MacroCommands::ApplyEffectCommand(), CommandDispatch::HandleTextualCommand(), EffectUIHost::OnApply(), anonymous_namespace{PluginMenus.cpp}::OnEffect(), NyqBench::OnGo(), anonymous_namespace{PluginMenus.cpp}::OnRepeatLastAnalyzer(), anonymous_namespace{PluginMenus.cpp}::OnRepeatLastEffect(), anonymous_namespace{PluginMenus.cpp}::OnRepeatLastGenerator(), anonymous_namespace{BatchProcessDialog.cpp}::OnRepeatLastTool(), and anonymous_namespace{TrackMenus.cpp}::OnStereoToMono().

Here is the call graph for this function:

Here is the caller graph for this function: