CAFingering Class Reference

Finger marks. More...

#include <fingering.h>

Inheritance diagram for CAFingering:

Inheritance graph
[legend]

List of all members.

Public Types

enum  CAFingerNumber {
  First = 1, Second = 2, Third = 3, Fourth = 4,
  Fifth = 5, Thumb, LHeel, RHeel,
  LToe, RToe, Undefined
}

Public Member Functions

 CAFingering (CAFingerNumber finger, CANote *m, bool italic=false)
 CAFingering (QList< CAFingerNumber > fingers, CANote *m, bool italic=false)
virtual ~CAFingering ()
CAMusElementclone ()
int compare (CAMusElement *elt)
CAFingerNumber finger ()
void setFinger (CAFingerNumber f)
QList< CAFingerNumber > & fingerList ()
void addFinger (CAFingerNumber f)
void removeFingerAt (int idx)
bool isOriginal ()
void setOriginal (bool original)

Static Public Member Functions

static const QString fingerNumberToString (CAFingerNumber n)
static CAFingerNumber fingerNumberFromString (const QString s)

Private Attributes

QList< CAFingerNumber_fingerList
bool _original


Detailed Description

Finger marks.

Copyright (c) 2007, Matevž Jekovec, Canorus development team All Rights Reserved. See AUTHORS for a complete list of authors.

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

This class represents fingering beside or above/below the note. Fingering can include a single finger number or multiple fingers (change fingering on one note).

The finger numbers can be written with italic style (original author's fingering when making an arrangment) or regular. This property is stored in original().

Definition at line 16 of file fingering.h.


Member Enumeration Documentation

enum CAFingering::CAFingerNumber

Enumerator:
First 
Second 
Third 
Fourth 
Fifth 
Thumb 
LHeel 
RHeel 
LToe 
RToe 
Undefined 

Definition at line 18 of file fingering.h.


Constructor & Destructor Documentation

CAFingering::CAFingering ( CAFingerNumber  finger,
CANote m,
bool  italic = false 
)

Definition at line 23 of file fingering.cpp.

References addFinger(), CAMark::setCommon(), and setOriginal().

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

CAFingering::CAFingering ( QList< CAFingerNumber fingers,
CANote m,
bool  italic = false 
)

Definition at line 30 of file fingering.cpp.

References _fingerList, CAMark::setCommon(), and setOriginal().

Here is the call graph for this function:

CAFingering::~CAFingering (  )  [virtual]

Definition at line 37 of file fingering.cpp.


Member Function Documentation

CAMusElement * CAFingering::clone (  )  [virtual]

Clones a music element with exact properties including the context.

Reimplemented from CAMark.

Definition at line 40 of file fingering.cpp.

References CAMark::associatedElement(), CAFingering(), fingerList(), and isOriginal().

Here is the call graph for this function:

int CAFingering::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.

Reimplemented from CAMark.

Definition at line 44 of file fingering.cpp.

References CAMark::Fingering, fingerList(), isOriginal(), CAMusElement::Mark, and CAMusElement::musElementType().

Here is the call graph for this function:

CAFingerNumber CAFingering::finger (  )  [inline]

Definition at line 39 of file fingering.h.

References _fingerList, and Undefined.

Referenced by CAMainWin::updateFingeringToolBar().

Here is the caller graph for this function:

void CAFingering::setFinger ( CAFingerNumber  f  )  [inline]

Definition at line 40 of file fingering.h.

References _fingerList.

Referenced by CAMainWin::on_uiFinger_toggled().

QList<CAFingerNumber>& CAFingering::fingerList (  )  [inline]

Definition at line 41 of file fingering.h.

References _fingerList.

Referenced by clone(), compare(), CADrawableMark::draw(), and CACanorusMLExport::exportMarks().

Here is the caller graph for this function:

void CAFingering::addFinger ( CAFingerNumber  f  )  [inline]

Definition at line 42 of file fingering.h.

References _fingerList.

Referenced by CAFingering().

Here is the caller graph for this function:

void CAFingering::removeFingerAt ( int  idx  )  [inline]

Definition at line 43 of file fingering.h.

References _fingerList.

bool CAFingering::isOriginal (  )  [inline]

Definition at line 45 of file fingering.h.

References _original.

Referenced by clone(), compare(), CACanorusMLExport::exportMarks(), and CAMainWin::updateFingeringToolBar().

Here is the caller graph for this function:

void CAFingering::setOriginal ( bool  original  )  [inline]

Definition at line 46 of file fingering.h.

References _original.

Referenced by CAFingering(), and CAMainWin::on_uiFingeringOriginal_toggled().

Here is the caller graph for this function:

const QString CAFingering::fingerNumberToString ( CAFingerNumber  n  )  [static]

Definition at line 62 of file fingering.cpp.

References Fifth, First, Fourth, LHeel, LToe, RHeel, RToe, Second, Third, Thumb, and Undefined.

Referenced by CACanorusMLExport::exportMarks().

Here is the caller graph for this function:

CAFingering::CAFingerNumber CAFingering::fingerNumberFromString ( const QString  s  )  [static]

Definition at line 89 of file fingering.cpp.

References Fifth, First, Fourth, LHeel, LToe, RHeel, RToe, Second, Third, Thumb, and Undefined.

Referenced by CACanorusMLImport::importMark().

Here is the caller graph for this function:


Member Data Documentation

QList<CAFingerNumber> CAFingering::_fingerList [private]

Definition at line 52 of file fingering.h.

Referenced by addFinger(), CAFingering(), finger(), fingerList(), removeFingerAt(), and setFinger().

bool CAFingering::_original [private]

Definition at line 53 of file fingering.h.

Referenced by isOriginal(), and setOriginal().


The documentation for this class was generated from the following files:
Generated on Sat Feb 9 13:14:09 2008 for Canorus by  doxygen 1.5.3