GUIDOLib  1.7.7
Guido Engine Internal Documentation
ARAccolade.h
1 #ifndef ARAccol_H
2 #define ARAccol_H
3 
4 /*
5  GUIDO Library
6  Copyright (C) 2002 Holger Hoos, Juergen Kilian, Kai Renz
7  Copyright (C) 2002-2017 Grame
8 
9  This Source Code Form is subject to the terms of the Mozilla Public
10  License, v. 2.0. If a copy of the MPL was not distributed with this
11  file, You can obtain one at http://mozilla.org/MPL/2.0/.
12 
13  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
14  research@grame.fr
15 
16 */
17 
18 #include "ARMTParameter.h"
19 #include "TagParameterStrings.h"
20 #include "TagParameterString.h"
21 #include "TagParameterInt.h"
22 
23 /*@mkdoc
24 
25 @group:Layout
26 
27 @tagname:\accolade
28 @tagalias:\accol
29 @tagtype:P
30 @tagnotation:accolades grouping staves
31 @tagdesc
32 @tagend
33 
34 @params:
35 @param:id:integer:an identification number:*none*:false
36 @param:range:string:the accolade range:*none*:false
37 @param:type:string:straightBrace, standard, curlyBrace, thinBrace or none:standard:true
38 @paramdesc
39 - the accolade range describes the staves covered by the accolade. It's a string in the form "n-m" or "n",
40 where 'n' and 'm' are staves indexes (starting from 1)
41 - straightBrace and standard are equivalent
42 
43 See the [Barlines](@EXAMPLES/barlines/) example.
44 
45 @paramend
46 
47 */
48 
51 class ARAccolade : public ARMTParameter
52 {
53  public:
54  ARAccolade();
55  virtual ~ARAccolade() {}
56 
57  const TagParameterString * getIDString() const { return getParameter<TagParameterString>(kIDStr); }
58  const TagParameterInt * getIDInt() const { return getParameter<TagParameterInt>(kIDStr); }
59  const TagParameterString * getAccolRange() const { return getParameter<TagParameterString>(kRangeStr); }
60  const TagParameterString * getType() const { return getParameter<TagParameterString>(kTypeStr); }
61 
62  virtual bool IsStateTag() const { return true; }
63 
64  virtual int getOrder() const { return kAccoladeOrder; }
65  virtual const char* getParamsStr() const { return kARAccoladeParams; };
66  virtual const char* getTagName () const { return "ARAccolade"; };
67  virtual std::string getGMNName () const { return "\\accolade"; };
68 };
69 
70 #endif
ARAccolade::getGMNName
virtual std::string getGMNName() const
Definition: ARAccolade.h:67
ARAccolade::IsStateTag
virtual bool IsStateTag() const
Definition: ARAccolade.h:62
ARMTParameter
not yet documented
Definition: ARMTParameter.h:24
ARAccolade::getIDString
const TagParameterString * getIDString() const
Definition: ARAccolade.h:57
ARAccolade::getParamsStr
virtual const char * getParamsStr() const
Definition: ARAccolade.h:65
ARAccolade::getIDInt
const TagParameterInt * getIDInt() const
Definition: ARAccolade.h:58
ARAccolade
Accolade tag to group staves into accolades.
Definition: ARAccolade.h:51
ARAccolade::getTagName
virtual const char * getTagName() const
Definition: ARAccolade.h:66
ARAccolade::getOrder
virtual int getOrder() const
Definition: ARAccolade.h:64
TagParameterInt
not yet documented
Definition: TagParameterInt.h:24
ARMusicalTag::kAccoladeOrder
Definition: ARMusicalTag.h:40
ARAccolade::~ARAccolade
virtual ~ARAccolade()
Definition: ARAccolade.h:55
ARAccolade::getType
const TagParameterString * getType() const
Definition: ARAccolade.h:60
ARAccolade::ARAccolade
ARAccolade()
TagParameterString
A string-type tag parameter.
Definition: TagParameterString.h:25
ARAccolade::getAccolRange
const TagParameterString * getAccolRange() const
Definition: ARAccolade.h:59

Guido Project Copyright © 2019 Grame-CNCM