Lyrics under the note. More...

#include <syllable.h>

Inheritance diagram for CASyllable:

Public Member Functions
	CASyllable (QString text, bool hyphen, bool melisma, CALyricsContext context, int timeStart, int timeLength, CAVoice voice=0)

	~CASyllable ()

void	clear ()

bool	hyphenStart ()

void	setHyphenStart (bool h)

bool	melismaStart ()

void	setMelismaStart (bool m)

QString	text ()

void	setText (QString text)

CAVoice *	associatedVoice ()

void	setAssociatedVoice (CAVoice *v)

CALyricsContext *	lyricsContext ()

CASyllable *	clone (CAContext *context)

int	compare (CAMusElement *)

Public Member Functions inherited from CAMusElement
	CAMusElement (CAContext *context, int timeStart, int timeLength=0)

virtual	~CAMusElement ()

CAMusElementType	musElementType ()

CAContext *	context ()

void	setContext (CAContext *context)

virtual int	timeStart () const

void	setTimeStart (int time)

virtual int	timeLength () const

void	setTimeLength (int length)

int	timeEnd ()

virtual int	realTimeStart ()

virtual int	realTimeLength ()

int	realTimeEnd ()

const QString	name ()

void	setName (const QString name)

const bool	isVisible ()

void	setVisible (const bool v)

const QColor	color ()

void	setColor (const QColor c)

const QList< CAMark * >	markList ()

void	addMark (CAMark *mark)

void	addMarks (QList< CAMark * > marks)

void	removeMark (CAMark *mark)

const QList< CANoteCheckerError * > &	noteCheckerErrorList ()

void	addNoteCheckerError (CANoteCheckerError *nce)

void	removeNoteCheckerError (CANoteCheckerError *nce)

bool	isPlayable ()

Private Attributes
bool	_hyphenStart

bool	_melismaStart

QString	_text

CAVoice *	_associatedVoice

Additional Inherited Members
Public Types inherited from CAMusElement
enum	CAMusElementType { Undefined = 0, Note, Rest, MidiNote, Barline, Clef, TimeSignature, KeySignature, Slur, Tuplet, Syllable, FunctionMark, FiguredBassMark, Mark }

Static Public Member Functions inherited from CAMusElement
static const QString	musElementTypeToString (CAMusElementType)

static CAMusElementType	musElementTypeFromString (const QString)

Protected Member Functions inherited from CAMusElement
void	setMusElementType (CAMusElementType type)

Protected Attributes inherited from CAMusElement
CAMusElementType	_musElementType

QList< CAMark * >	_markList

QList< CANoteCheckerError * >	_noteCheckerErrorList

CAContext *	_context

int	_timeStart

int	_timeLength

bool	_visible

QColor	_color

QString	_name

Detailed Description

Lyrics under the note.

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

This class represents one lyrics element above or below the note. It doesn't neccessarily consist of one syllable or even a word, but can contain multiple syllables and words (using an underscore _ or a dash -). Syllables are usually stored inside CALyricsContext.

Every lyrics element can finish with a hyphen (a horizontal middle line), with melisma (a horizontal underscore line) or without line at the end of the word.

Each syllable can have a custom associated voice, if set. Usually parent's (lyrics context) voice is taken.

Constructor & Destructor Documentation

◆ CASyllable()

CASyllable::CASyllable	(	QString	text,
		bool	hyphen,
		bool	melisma,
		CALyricsContext *	context,
		int	timeStart,
		int	timeLength,
		CAVoice *	voice = `0`
	)

Creates a new lyrics element with the given text, hyphenation hyphen and melisma properties, parent context, timeStart and timeLength. voice is a special per-syllable associated voice (default 0 - takes parent's voice).

References setAssociatedVoice(), setHyphenStart(), setMelismaStart(), CAMusElement::setMusElementType(), setText(), CAMusElement::Syllable, and text().

Referenced by clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~CASyllable()

CASyllable::~CASyllable ( )

Member Function Documentation

◆ associatedVoice()

CAVoice* CASyllable::associatedVoice ( )

inline

References _associatedVoice.

Referenced by clone().

Here is the caller graph for this function:

◆ clear()

void CASyllable::clear ( )

Clears the text and sets the default hyphen and melisma settings. This function is usually called when directly deleting the syllable - it shouldn't be actually removed, but only its text set to empty.

References setHyphenStart(), setMelismaStart(), and setText().

Referenced by CAMainWin::deleteSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone()

CASyllable * CASyllable::clone ( CAContext * context )

virtual

Clone the syllable using the given new context. If the given context is not a lyrics context, 0 is used instead.

Implements CAMusElement.

References CAMusElement::addMark(), associatedVoice(), CASyllable(), CAMusElement::context(), CAContext::contextType(), hyphenStart(), CAContext::LyricsContext, CAMusElement::markList(), melismaStart(), text(), CAMusElement::timeLength(), and CAMusElement::timeStart().

Referenced by CAMainWin::pasteAt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ compare()

int CASyllable::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 CAMusElement::musElementType(), and CAMusElement::Syllable.

Here is the call graph for this function: