CommandSignature.h

Go to the documentation of this file.

/**********************************************************************
 
   Audacity - A Digital Audio Editor
   Copyright 1999-2009 Audacity Team
   License: wxwidgets
 
   Dan Horgan
 
******************************************************************//*******************************************************************/
 
#ifndef __COMMANDSIGNATURE__
#define __COMMANDSIGNATURE__
 
#include "CommandMisc.h"
 
class wxString;
class wxVariant;
class Validator;
 
class AUDACITY_DLL_API CommandSignature
{
private:
   ParamValueMap mDefaults;
   ValidatorMap mValidators;
   CommandSignature(const CommandSignature &) PROHIBITED;
   CommandSignature& operator=(const CommandSignature &) PROHIBITED;
public:
   explicit CommandSignature();
   ~CommandSignature();
 
   // Add a parameter to the signature.
   //    name:  the parameter name (case-sensitive)
   //    dft:   a default value
   //    valid: a suitable validator (caller doesn't need to DELETE it)
   void AddParameter(const wxString &name,
                     const wxVariant &dft,
                     std::unique_ptr<Validator> &&valid);
 
   // Methods for accessing the signature
   ParamValueMap GetDefaults() const;
   Validator &GetValidator(const wxString &paramName);
};
 
#endif /* End of include guard: __COMMANDSIGNATURE__ */