1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
// -*- c-basic-offset: 4 -*-
/*
Rosegarden-4
A sequencer and musical notation editor.
This program is Copyright 2000-2005
Guillaume Laurent <glaurent@telegraph-road.org>,
Chris Cannam <cannam@all-day-breakfast.com>,
Richard Bown <bownie@bownie.com>
The moral right of the authors to claim authorship of this work
has been asserted.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. See the file
COPYING included with this distribution for more information.
*/
#ifndef NOTATIONSTRINGS_H
#define NOTATIONSTRINGS_H
#include <qstring.h>
#include "NotationTypes.h"
/**
* String factory for note names, etc. used in the GUI
* Replaces use of base/NotationTypes.h strings which should
* be used only for non-user purposes.
*/
class NotationStrings
{
public:
NotationStrings();
~NotationStrings();
/**
* Get the name of a note. The default return values are American
* (e.g. quarter note, dotted sixteenth note). If the app is
* internationalised, you will get return names local to your
* region. Note that this includes English note names- set your
* LC_LANG to en_GB.
*/
static QString getNoteName(Rosegarden::Note note,
bool plural = false, bool triplet = false);
/**
* Get the UNTRANSLATED American name of a note. This may be
* useful if the user has specified that they'd prefer American
* names to local names.
*/
static QString getAmericanName(Rosegarden::Note note,
bool plural = false, bool triplet = false);
/**
* Get the short name of a note. The default return values are
* American (e.g. quarter, dotted 16th). If the app is
* internationalised, you will get return names local to your
* region. Note that this includes English note names- set your
* LC_LANG to en_GB.
*/
static QString getShortNoteName(Rosegarden::Note note,
bool plural = false, bool triplet = false);
/**
* Get the UNTRANSLATED reference name of a note or rest. This is the
* formal name used to name pixmap files and the like, so the exact
* values of these strings are pretty sensitive.
*/
static QString getReferenceName(Rosegarden::Note note, bool isRest = false);
typedef Rosegarden::Exception MalformedNoteName;
/**
* Get the note corresponding to the given string, which must be a
* reference name or an untranslated British, American or short name.
* May throw MalformedNoteName.
*/
static Rosegarden::Note getNoteForName(QString name);
/**
* Construct a label to describe the given duration as a note name in
* the proper locale. Uses the nearest available note to the duration
* and returns a non-zero value in errorReturn if it was not an exact
* match for the required duration.
*/
static QString makeNoteMenuLabel(Rosegarden::timeT duration,
bool brief,
Rosegarden::timeT &errorReturn,
bool plural = false);
private:
/**
* Return a string representing the dotted version of the input str.
*/
static QString addDots(QString s, int dots,
bool hyphenate, bool internationalize);
};
#endif // NOTATIONSTRINGS_H
|
