ARAccidental.h

#ifndef ARAcc_H
#define ARAcc_H
 
/*
  GUIDO Library
  Copyright (C) 2002  Holger Hoos, Juergen Kilian, Kai Renz
  Copyright (C) 2002-2017 Grame
 
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr
 
*/
 
#include "ARMTParameter.h"
#include "ARPositionTag.h"
 
/*@mkdoc
 
@group:Accidentals
 
@tagname:\accidental
@tagalias:\acc
@tagtype:R
@tagnotation:sharp, flat, natural, cautionary accidental
@tagdesc
The **\accidental** tag may be used for more precise control over accidentals. It supports common tag parameters.
Used without parameter, it forces the display of an accidental (flat, sharp or natural).
@tagend
 
@params:
@param:style:string:"cautionary" to enforce a cautionary accidental<br/>"none" to prevent an accidental display:*none*:true
@paramdesc
See the [Accidentals](@EXAMPLES/accidentals/) example.
@paramend
 
*/
 
class ARAccidental : public ARMTParameter, public ARPositionTag
{
    public:
        enum Style { kUnknown, kNone, kCautionary };
        
                 ARAccidental(const ARAccidental & acc);
                 ARAccidental();
        virtual ~ARAccidental() {}
 
        virtual ARMusicalObject * Copy() const  { return new ARAccidental(*this); }
 
        virtual const char* getParamsStr() const    { return kARAccidentalParams; };
        virtual const char* getTagName () const     { return "ARAccidental"; };
        virtual std::string getGMNName () const     { return "\\accidental"; };
 
        Style       getStyle() const;
};
 
#endif