CommandType.h

Go to the documentation of this file.

/**********************************************************************
 
   Audacity - A Digital Audio Editor
   Copyright 1999-2009 Audacity Team
   License: wxwidgets
 
   Dan Horgan
 
******************************************************************//*******************************************************************/
 
#ifndef __COMMANDTYPE__
#define __COMMANDTYPE__
 
#include "CommandSignature.h"
#include "../commands/AudacityCommand.h"
 
class OldStyleCommand;
 
/**************************************************************/
using OldStyleCommandPointer = std::shared_ptr<OldStyleCommand>;
class CommandOutputTargets;
class CommandSignature;
class wxString;
 
#include <optional>
 
class AUDACITY_DLL_API OldStyleCommandType : public AudacityCommand
{
private:
   std::optional<CommandSignature> mSignature;
 
public:
   OldStyleCommandType();
   virtual ~OldStyleCommandType();
   ComponentInterfaceSymbol GetSymbol() const override;
   CommandSignature &GetSignature();
   wxString Describe(); // for debugging only ?
 
   // Subclasses should override the following:
   // =========================================
 
   // Return the name of the command type
   virtual ComponentInterfaceSymbol BuildName() const = 0;
 
   // names, validators and default values.
   virtual void BuildSignature(CommandSignature &signature) = 0;
 
   // Create a command instance with the specified output target
   virtual OldStyleCommandPointer Create(
      AudacityProject &project, std::unique_ptr<CommandOutputTargets> &&target) = 0;
};
 
#endif /* End of include guard: __COMMANDTYPE__ */