Represents a rest in the score. More...

#include <rest.h>

Inheritance diagram for CARest:

Public Types
enum	CARestType { Undefined = -1, Normal, Hidden }
Public Member Functions
	CARest (CARestType type, CAPlayableLength length, CAVoice *voice, int timeStart, int timeLength=-1)
	~CARest ()
CARest *	clone (CAVoice *voice=0)
CARestType	restType ()
void	setRestType (CARestType type)
int	compare (CAMusElement *elt)
Static Public Member Functions
static const QString	restTypeToString (CARestType)
static CARestType	restTypeFromString (const QString)
static QList< CARest * >	composeRests (int timeLength, int timeStart, CAVoice *voice=0, CARestType=Hidden)
Private Attributes
CARestType	_restType

Detailed Description

Represents a rest in the score.

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

    This class represents every rest in the score. It inherits the base class CAPlayable.

Member Enumeration Documentation

enum CARest::CARestType

Enumerator:

Undefined
Normal
Hidden

Constructor & Destructor Documentation

CARest::CARest	(	CARestType	type,
		CAPlayableLength	length,
		CAVoice *	voice,
		int	timeStart,
		int	timeLength = `-1`
	)

Creates a new rest with given type, playable length length in voice voice with starting time in the score timeStart and number of dots dotted. timeLength is calculated automatically from the playable length.

See also:: CARestType, CAPlayableLength, CAPlayable, CAVoice

References CAMusElement::_musElementType, _restType, and CAMusElement::Rest.

Referenced by clone(), and composeRests().

Here is the caller graph for this function:

CARest::~CARest ( )

Destroys the rest.

Member Function Documentation

CARest * CARest::clone ( CAVoice * voice = 0 ) [virtual]

Implements CAPlayable.

References CAMusElement::addMark(), CARest(), CAMusElement::markList(), CAPlayable::playableLength(), restType(), CAMusElement::timeLength(), and CAMusElement::timeStart().

Here is the call graph for this function:

int CARest::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(), CAPlayable::playableLength(), and CAMusElement::Rest.

Here is the call graph for this function:

QList< CARest * > CARest::composeRests	(	int	timeLength,
		int	timeStart,
		CAVoice *	voice = `0`,
		CARestType	type = `Hidden`
	)		`[static]`

Generates a list of new rests in the total length of timeLength. Rests are sorted from the shortes to the longest one. The first rest has the given timeStart. Passing voice and restType is optional.

This function is usually called when a gap between two voices with shared elements appear in one voice and the gap with custom length needs to be filled with rests.