CommandDispatch Namespace Reference

Functions
AUDACITY_DLL_API bool	HandleTextualCommand (const CommandID &Str, const CommandContext &context, CommandFlag flags, bool alwaysEnabled)
AUDACITY_DLL_API bool	DoAudacityCommand (const PluginID &ID, const CommandContext &context, unsigned flags)
AUDACITY_DLL_API void	OnAudacityCommand (const CommandContext &ctx)

Function Documentation

DoAudacityCommand()

bool CommandDispatch::DoAudacityCommand	(	const PluginID &	ID,
		const CommandContext &	context,
		unsigned	flags
	)

DoAudacityCommand() takes a PluginID and executes the associated command.

At the moment flags are used only to indicate whether to prompt for parameters

Definition at line 59 of file CommandDispatch.cpp.

{
   auto &project = context.project;
   auto &window = GetProjectFrame(project);
   const PluginDescriptor *plug = PluginManager::Get().GetPlugin(ID);
   if (!plug)
      return false;
 
   if (flags & EffectManager::kConfigured)
   {
      ProjectAudioManager::Get( project ).Stop();
//    SelectAllIfNone();
   }
 
   EffectManager & em = EffectManager::Get();
   bool success = em.DoAudacityCommand(ID,
      context,
      &window,
      (flags & EffectManager::kConfigured) == 0);
 
   if (!success)
      return false;
 
/*
   if (em.GetSkipStateFlag())
      flags = flags | OnEffectFlags::kSkipState;
 
   if (!(flags & OnEffectFlags::kSkipState))
   {
      wxString shortDesc = em.GetCommandName(ID);
      wxString longDesc = em.GetCommandDescription(ID);
      PushState(longDesc, shortDesc);
   }
*/
   Viewport::Get(project).Redraw();
   return true;
}

References EffectManager::DoAudacityCommand(), PluginManager::Get(), EffectManager::Get(), Viewport::Get(), ProjectAudioManager::Get(), PluginManager::GetPlugin(), GetProjectFrame(), EffectManager::kConfigured, CommandContext::project, project, Viewport::Redraw(), and ProjectAudioManager::Stop().

Referenced by MacroCommands::ApplyEffectCommand(), and OnAudacityCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleTextualCommand()

bool CommandDispatch::HandleTextualCommand	(	const CommandID &	Str,
		const CommandContext &	context,
		CommandFlag	flags,
		bool	alwaysEnabled
	)

Definition at line 26 of file CommandDispatch.cpp.

{
   auto &commandManager = CommandManager::Get(context.project);
   switch ( commandManager.HandleTextualCommand(
      Str, context, flags, alwaysEnabled) ) {
   case CommandManager::CommandSuccess:
      return true;
   case CommandManager::CommandFailure:
      return false;
   case CommandManager::CommandNotFound:
   default:
      break;
   }
 
   // Not one of the singleton commands.
   // We could/should try all the list-style commands.
   // instead we only try the effects.
   EffectManager & em = EffectManager::Get();
   for (auto &plug : PluginManager::Get().PluginsOfType(PluginTypeEffect))
      if (em.GetCommandIdentifier(plug.GetID()) == Str)
         return EffectUI::DoEffect(
            plug.GetID(), context,
            EffectManager::kConfigured);
 
   return false;
}

References CommandManager::CommandFailure, CommandManager::CommandNotFound, CommandManager::CommandSuccess, EffectUI::DoEffect(), PluginManager::Get(), EffectManager::Get(), CommandManager::Get(), EffectManager::GetCommandIdentifier(), EffectManager::kConfigured, PluginTypeEffect, and CommandContext::project.

Referenced by MacroCommands::ApplyCommand(), ScreenshotCommand::CapturePreferences(), and ToolBarButtons::OnButton().

Here is the call graph for this function:

Here is the caller graph for this function:

OnAudacityCommand()

void CommandDispatch::OnAudacityCommand

(

const CommandContext &

ctx

)

Definition at line 98 of file CommandDispatch.cpp.

{
   // using GET in a log message for devs' eyes only
   wxLogDebug( "Command was: %s", ctx.parameter.GET());
   // Not configured, so prompt user.
   CommandDispatch::DoAudacityCommand(
      EffectManager::Get().GetEffectByIdentifier(ctx.parameter),
      ctx, EffectManager::kNone);
}

References DoAudacityCommand(), EffectManager::Get(), Identifier::GET(), EffectManager::kNone, and CommandContext::parameter.

Here is the call graph for this function: