Represents a key signature sign in the staff. More...

#include <keysignature.h>

Inheritance diagram for CAKeySignature:

Public Types
enum	CAKeySignatureType { MajorMinor, Modus, Custom }
enum	CAModus { Ionian, Dorian, Phrygian, Lydian, Mixolydian, Aeolian, Locrian, Hypodorian, Hypolydian, Hypomixolydian, Hypophrygian }
Public Member Functions
	CAKeySignature (CADiatonicKey k, CAStaff *staff, int timeStart)
	CAKeySignature (CAModus m, CAStaff *staff, int timeStart)
	~CAKeySignature ()
CAKeySignature *	clone (CAContext *context=0)
CAStaff *	staff ()
CAKeySignatureType	keySignatureType ()
void	setKeySignatureType (CAKeySignatureType type)
CADiatonicKey	diatonicKey ()
CAModus	modus ()
void	setDiatonicKey (CADiatonicKey k)
void	setModus (CAModus modus)
signed char *	accidentals ()
int	compare (CAMusElement *elt)
Static Public Member Functions
static const QString	keySignatureTypeToString (CAKeySignatureType)
static CAKeySignatureType	keySignatureTypeFromString (const QString)
static const QString	modusToString (CAModus)
static CAModus	modusFromString (const QString)
Private Member Functions
void	updateAccidentals ()
Private Attributes
CAKeySignatureType	_keySignatureType
CAModus	_modus
CADiatonicKey	_diatonicKey
signed char	_accidentals [7]

Detailed Description

Represents a key signature sign in the staff.

Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.GPL for details.

    CAKeySignature represents a key signature sign (static accidentals) in the staff.
    The actual key signature key is stored (depends on type though - currently only major/minor
    diatonic keys are supported) in _diatonicKey.

    \sa CADiatonicKey

Member Enumeration Documentation

enum CAKeySignature::CAKeySignatureType

Type of the key signature:

MajorMinor Standard diatonic scale found by circle of fifths
Modus One of the moduses found in middle-age
Custom Custom scale. Modern scales, harmony of fourths, local scales

Enumerator:

MajorMinor
Modus
Custom

enum CAKeySignature::CAModus

Modus types:

Ionian
Dorian
Phrygian
Lydian
Mixolydian
Aeolian
Locrian
Hypodorian
Hypolydian
Hypomixolydian
Hypophrygian

Enumerator:

Ionian
Dorian
Phrygian
Lydian
Mixolydian
Aeolian
Locrian
Hypodorian
Hypolydian
Hypomixolydian
Hypophrygian

Constructor & Destructor Documentation

CAKeySignature::CAKeySignature	(	CADiatonicKey	k,
		CAStaff *	staff,
		int	timeStart
	)

Creates a new key signature of type MajorMinor, diatonic key dKey, parent staff and timeStart.

Number of accidentals is a signed number, positive for sharps, negative for flats. eg.

0 - C-Major
-1 - F-Major
+7 - Cis-Major etc.

References CAMusElement::KeySignature, MajorMinor, setDiatonicKey(), setKeySignatureType(), and CAMusElement::setMusElementType().

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

CAKeySignature::CAKeySignature	(	CAModus	m,
		CAStaff *	staff,
		int	timeStart
	)

    Creates a new key signature of type Modus, modus type \a m, parent \a staff and \a timeStart.

Todo:: Modus on different pitches

References CAMusElement::KeySignature, Modus, setKeySignatureType(), setModus(), and CAMusElement::setMusElementType().

Here is the call graph for this function:

CAKeySignature::~CAKeySignature ( )

Member Function Documentation

CAKeySignature::accidentals ( ) [inline]

Returns the array of accidentals for every level in the scale.

The levels can have the following values:

0 - natural
1 - sharp
2 - double sharp
...
-1 - flat
-2 - double flat
...

References _accidentals.

Referenced by CADrawableKeySignature::CADrawableKeySignature(), CADrawableStaff::getAccs(), and CAKeybdInput::matchPitchToKey().

Here is the caller graph for this function:

CAKeySignature * CAKeySignature::clone ( CAContext * context = 0 ) [virtual]

Clones a music element with exact properties including the context.

Implements CAMusElement.

References CAMusElement::addMark(), CAKeySignature(), diatonicKey(), keySignatureType(), MajorMinor, CAMusElement::markList(), and CAMusElement::timeStart().

Here is the call graph for this function:

int CAKeySignature::compare ( CAMusElement * elt ) [virtual]

Compares the music element with the given elt and returns number of differences in their properties. Returns 0, if the music elements are exact; -1 if the music element type differs; otherwise number greater than 0.

This method is usually used when opening a score document where music elements are written in various voices (eg. barlines), but are eventually merged and written only once per staff.

Implements CAMusElement.

References diatonicKey(), CAMusElement::KeySignature, keySignatureType(), MajorMinor, and CAMusElement::musElementType().

Here is the call graph for this function: