GUIDOLib  1.7.7
Guido Engine Internal Documentation
ARComposer.h
1 #ifndef ARComposer_H
2 #define ARComposer_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 "ARText.h"
19 
20 /*@mkdoc
21 
22 @group:Text
23 
24 @tagname:\composer
25 @tagalias:
26 @tagtype:P
27 @tagnotation:the composer name
28 @tagdesc
29 @tagend
30 
31 The composer name is displayed on top of the first page, right aligned to the score first system.
32 
33 @params:
34 @param:name:string:the composer name:*none*:false
35 @param:pageformat:string:a page location:53:true
36 @fontparams:
37 @paramdesc
38 **pageformat** works similarly to [\title](#title).
39 
40 See the [Mozart](@EXAMPLES/mozart581/) example.<br />
41 See the [Fauré](@EXAMPLES/faure/) example.<br />
42 See the [Jazz](@EXAMPLES/allthethings/) example.
43 @paramend
44 
45 */
46 
49 class ARComposer : public ARText
50 {
51  public:
52  ARComposer();
53  virtual ~ARComposer() {}
54 
55  const char* getName() const;
56  const char* getPageFormat() const;
57 
58  virtual int getOrder() const { return kComposerOrder; }
59  virtual const char* getParamsStr() const { return kARComposerParams; };
60  virtual const char* getTagName() const { return "ARComposer"; };
61  virtual std::string getGMNName() const { return "\\composer"; };
62 
63  virtual void setTagParameters (const TagParameterMap& params);
64 
65  private:
66  const TagParameterString * fName = 0;
67  const TagParameterString * fPageformat = 0;
68 };
69 
70 
71 #endif
ARComposer::~ARComposer
virtual ~ARComposer()
Definition: ARComposer.h:53
ARComposer
not yet documented
Definition: ARComposer.h:49
ARComposer::getTagName
virtual const char * getTagName() const
Definition: ARComposer.h:60
ARComposer::ARComposer
ARComposer()
ARComposer::getName
const char * getName() const
ARComposer::setTagParameters
virtual void setTagParameters(const TagParameterMap &params)
ARComposer::getPageFormat
const char * getPageFormat() const
ARComposer::getParamsStr
virtual const char * getParamsStr() const
Definition: ARComposer.h:59
ARMusicalTag::kComposerOrder
Definition: ARMusicalTag.h:40
TagParameterString
A string-type tag parameter.
Definition: TagParameterString.h:25
ARComposer::getOrder
virtual int getOrder() const
Definition: ARComposer.h:58
ARComposer::getGMNName
virtual std::string getGMNName() const
Definition: ARComposer.h:61
TagParameterMap
A list of tag parameters represented as a map.
Definition: TagParameterMap.h:31
ARText
The text tag.
Definition: ARText.h:49

Guido Project Copyright © 2019 Grame-CNCM