Method PromptUser

src/EffectAndCommandPluginManager.cpp:253–287

Shows an effect or command dialog so the user can specify settings for later ! It is used when defining a macro. It does not invoke the effect or command. */

 It is used when defining a macro.  It does not invoke the effect or command.
 */
bool EffectAndCommandPluginManager::PromptUser(
   const PluginID& ID, AudacityProject& project, DialogInvoker dialogInvoker)
{
   bool result = false;
   if (auto effect = dynamic_cast<Effect*>(EffectManager::Get().GetEffect(ID)))
   {
      auto empty = TrackList::Create(nullptr);
      auto pEffectBase = dynamic_cast<EffectBase*>(effect);
      if (pEffectBase)
         // This allows effects to call Init() safely
         pEffectBase->SetTracks(empty.get());
      Finally Do([&] {
         // reverse the side-effect
         if (pEffectBase)
            pEffectBase->SetTracks(nullptr);
      });

      std::shared_ptr<EffectInstance> pInstance;
      //! Show the effect dialog, only so that the user can choose settings,
      //! for instance to define a macro.
      if (const auto pSettings = EffectManager::Get().GetDefaultSettings(ID))
         result = dialogInvoker(*effect, *pSettings, pInstance);
      return result;
   }

   AudacityCommand* command = GetAudacityCommand(ID);

   if (command)
   {
      result = command->PromptUser(project);
      return result;
   }

   return result;
}