Browsing music pages

Functions
int	GuidoCountVoices (CARHandler inHandleAR)
	Gives the number of score pages of the graphic representation.
int	GuidoGetPageCount (CGRHandler inHandleGR)
	Gives the number of score pages of the graphic representation.
int	GuidoGetSystemCount (CGRHandler inHandleGR, int page)
	Gives the number of systems on a given page.
GuidoErrCode	GuidoDuration (CGRHandler inHandleGR, GuidoDate *date)
	Returns the music duration of a score.
int	GuidoFindEventPage (CGRHandler inHandleGR, const GuidoDate &date)
	Finds the page which has an event (note or rest) at a given date.
int	GuidoFindPageAt (CGRHandler inHandleGR, const GuidoDate &date)
	Finds the page which contain a given date.
GuidoErrCode	GuidoGetPageDate (CGRHandler inHandleGR, int pageNum, GuidoDate *date)
	Gives the time location of a Page.

---

Detailed Description

The Guido Engine produces pages of music and therefore, the graphic representation consists in a collection of pages. The following functions are intended to access these pages by page number as well as by date. Page numbers start at 1.

---

Function Documentation

int GuidoCountVoices

(

CARHandler

inHandleAR )

Gives the number of score pages of the graphic representation.

Parameters:

inHandleAR

a Guido opaque handle to a AR structure.

Returns:

the number of voices or a guido error code.

int GuidoGetPageCount

(

CGRHandler

inHandleGR )

Gives the number of score pages of the graphic representation.

Parameters:

inHandleGR

a Guido opaque handle to a GR structure.

Returns:

a number of pages or a guido error code.

int GuidoGetSystemCount	(	CGRHandler	inHandleGR,
		int	page
	)

Gives the number of systems on a given page.

Parameters:

inHandleGR	a Guido opaque handle to a GR structure.
page	a page number (starts at 1).

Returns:

the systems count on the given page or a guido error code.

GuidoErrCode GuidoDuration	(	CGRHandler	inHandleGR,
		GuidoDate *	date
	)

Returns the music duration of a score.

The duration is expressed as a fractional value where 1 represents a whole note.

Parameters:

inHandleGR	a Guido opaque handle to a GR structure.
date	on output: the duration expressed as a fractional value

Returns:

a Guido error code.

int GuidoFindEventPage	(	CGRHandler	inHandleGR,
		const GuidoDate &	date
	)

Finds the page which has an event (note or rest) at a given date.

Bug:

returns page + 1 when input date falls on the last system.

Parameters:

inHandleGR	a Guido opaque handle to a GR structure.
date	the target date.

Returns:

a page number if greater than 0, 0 if no page found,

int GuidoFindPageAt	(	CGRHandler	inHandleGR,
		const GuidoDate &	date
	)

Finds the page which contain a given date.

Bug:

returns page + 1 when input date falls on the last system.

Parameters:

inHandleGR	a Guido opaque handle to a GR structure.
date	the target date.

Returns:

a page number if greater than 0, 0 if no page found,

GuidoErrCode GuidoGetPageDate	(	CGRHandler	inHandleGR,
		int	pageNum,
		GuidoDate *	date
	)

Gives the time location of a Page.

Parameters:

inHandleGR	a Guido opaque handle to a GR structure.
pageNum	a page number (starts at 1).
date	on output: the page date if the page number is valid

Returns:

a Guido error code.