ApplyAndSendResponse is a DecoratoredCommand that performs the given command and then outputs a status message according to the result. It manages a CommandContext which is passed into its mCommand, so that result messages are routed back to the right place. More...

#include <Command.h>

Inheritance diagram for ApplyAndSendResponse:

[legend]

Collaboration diagram for ApplyAndSendResponse:

[legend]

Public Member Functions
	ApplyAndSendResponse (const OldStyleCommandPointer &cmd, std::unique_ptr< CommandOutputTargets > &target)

bool	Apply () override

bool	Apply (const CommandContext &context) override

Public Member Functions inherited from DecoratedCommand
	DecoratedCommand (const OldStyleCommandPointer &cmd)

virtual	~DecoratedCommand ()

ComponentInterfaceSymbol	GetSymbol () override

CommandSignature &	GetSignature () override

bool	SetParameter (const wxString &paramName, const wxVariant &paramValue) override

Public Member Functions inherited from OldStyleCommand
	OldStyleCommand (AudacityProject &project)

virtual	~OldStyleCommand ()

virtual ComponentInterfaceSymbol	GetSymbol ()=0

virtual CommandSignature &	GetSignature ()=0

virtual bool	SetParameter (const wxString &paramName, const wxVariant &paramValue)

virtual bool	Apply ()=0

virtual bool	Apply (const CommandContext &context)=0

Public Attributes
std::unique_ptr< const CommandContext >	mCtx

Public Attributes inherited from OldStyleCommand
AudacityProject &	mProject

Additional Inherited Members
Protected Attributes inherited from DecoratedCommand
OldStyleCommandPointer	mCommand

Detailed Description

ApplyAndSendResponse is a DecoratoredCommand that performs the given command and then outputs a status message according to the result. It manages a CommandContext which is passed into its mCommand, so that result messages are routed back to the right place.

Definition at line 65 of file Command.h.

Constructor & Destructor Documentation

◆ ApplyAndSendResponse()

ApplyAndSendResponse::ApplyAndSendResponse	(	const OldStyleCommandPointer &	cmd,
		std::unique_ptr< CommandOutputTargets > &	target
	)

Definition at line 122 of file Command.cpp.

      : DecoratedCommand(cmd),
       mCtx( std::make_unique<CommandContext>( cmd->mProject, std::move(target) ) )
{
}

Member Function Documentation

◆ Apply() [1/2]

bool ApplyAndSendResponse::Apply ( )

overridevirtual

Implements OldStyleCommand.

Definition at line 137 of file Command.cpp.

{
   // ApplyAndSendResponse IS a command.
   // It also HOLDS a command.
 
   // Mostly its functions forward to the recipient.
   // However it uses its OWN context, not the one of 
   // the command it holds.
   auto result = GuardedCall<bool>(
      [&] { 
      bool bResult = mCommand->Apply(*( mCtx.get()));
      return bResult; }
   );
   wxString response = wxT( "\n" );
 
   // PRL: it's all right to send untranslated strings to this channel
   // I don't see _("") used with literal strings.
   response += GetSymbol().Internal();
 
   // These three strings are deliberately not localised.
   // They are used in script responses and always happen in English.
   response += wxT(" finished: ");
   if (result)
   {
      response += wxT("OK");
   }
   else
   {
      response += wxT("Failed!");
   }
   mCtx->Status(response, true);
   return result;
}

References DecoratedCommand::GetSymbol(), ComponentInterfaceSymbol::Internal(), DecoratedCommand::mCommand, mCtx, and wxT().

Here is the call graph for this function:

◆ Apply() [2/2]

bool ApplyAndSendResponse::Apply ( const CommandContext & context )

overridevirtual

Implements OldStyleCommand.

Member Data Documentation

◆ mCtx

std::unique_ptr<const CommandContext> ApplyAndSendResponse::mCtx

Definition at line 72 of file Command.h.

Referenced by Apply().

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Additional Inherited Members