CommandDispatch.h File Reference

#include "CommandFlag.h"
#include "Identifier.h"

Include dependency graph for CommandDispatch.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
AUDACITY_DLL_API bool	HandleTextualCommand (CommandManager &commandManager, const CommandID &Str, const CommandContext &context, CommandFlag flags, bool alwaysEnabled)

Function Documentation

HandleTextualCommand()

AUDACITY_DLL_API bool HandleTextualCommand	(	CommandManager &	commandManager,
		const CommandID &	Str,
		const CommandContext &	context,
		CommandFlag	flags,
		bool	alwaysEnabled
	)

Definition at line 19 of file CommandDispatch.cpp.

{
   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(), EffectManager::GetCommandIdentifier(), CommandManager::HandleTextualCommand(), EffectManager::kConfigured, and PluginTypeEffect.

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

Here is the call graph for this function:

Here is the caller graph for this function: