HelpCommand.h

Go to the documentation of this file.

/**********************************************************************
 
   Audacity - A Digital Audio Editor
   Copyright 1999-2018 Audacity Team
   License: wxwidgets
 
   Dan Horgan
   James Crook
 
******************************************************************//*******************************************************************/
 
#ifndef __HELPCOMMAND__
#define __HELPCOMMAND__
 
#include "CommandType.h"
#include "Command.h"
 
class HelpCommand : public AudacityCommand
{
public:
   static const ComponentInterfaceSymbol Symbol;
   int mFormat;
 
   // ComponentInterface overrides
   ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
   TranslatableString GetDescription() const override {return XO("Gives help on a command.");};
   template<bool Const> bool VisitSettings( SettingsVisitorBase<Const> &S );
   bool VisitSettings( SettingsVisitor & S ) override;
   bool VisitSettings( ConstSettingsVisitor & S ) override;
   void PopulateOrExchange(ShuttleGui & S) override;
   bool Apply(const CommandContext & context) override;
   bool ApplyInner(const CommandContext & context);
 
   // AudacityCommand overrides
   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#help";}
public:
   wxString mCommandName;
};
 
class CommentCommand : public AudacityCommand
{
public:
   static const ComponentInterfaceSymbol Symbol;
   int mFormat;
 
   // ComponentInterface overrides
   ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
   TranslatableString GetDescription() const override {return XO("For comments in a macro.");};
   template<bool Const> bool VisitSettings( SettingsVisitorBase<Const> &S );
   bool VisitSettings( SettingsVisitor & S ) override;
   bool VisitSettings( ConstSettingsVisitor & S ) override;
   void PopulateOrExchange(ShuttleGui & S) override;
   bool Apply(const CommandContext & context) override {
      return true;
   };
   // AudacityCommand overrides
   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#comment";}
public:
   wxString mComment;
};
 
 
#endif /* End of include guard: __HELPCOMMAND__ */