Functions

Browsing music pages
[Guido Engine Adapter]

Functions

int countVoices (CARHandler inHandleAR)
 Gives the number of score pages of the graphic representation.
int getPageCount (CGRHandler inHandleGR)
 Gives the number of score pages of the graphic representation.
int getSystemCount (CGRHandler inHandleGR, int page)
 Gives the number of systems on a given page.
GuidoDate duration (CGRHandler inHandleGR)
 Returns the music duration of a score.
int findEventPage (CGRHandler inHandleGR, const GuidoDate &date)
 Finds the page which has an event (note or rest) at a given date.
int findPageAt (CGRHandler inHandleGR, const GuidoDate &date)
 Finds the page which contain a given date.
GuidoDate getPageDate (CGRHandler inHandleGR, int pageNum)
 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 countVoices ( CARHandler  inHandleAR ) [inherited]

Gives the number of score pages of the graphic representation.

Parameters:
inHandleARa Guido opaque handle to a AR structure.
Returns:
the number of voices or a guido error code.
int getPageCount ( CGRHandler  inHandleGR ) [inherited]

Gives the number of score pages of the graphic representation.

Parameters:
inHandleGRa Guido opaque handle to a GR structure.
Returns:
a number of pages or a guido error code.
int getSystemCount ( CGRHandler  inHandleGR,
int  page 
) [inherited]

Gives the number of systems on a given page.

Parameters:
inHandleGRa Guido opaque handle to a GR structure.
pagea page number (starts at 1).
Returns:
the systems count on the given page or a guido error code.
GuidoDate duration ( CGRHandler  inHandleGR ) [inherited]

Returns the music duration of a score.

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

Parameters:
inHandleGRa Guido opaque handle to a GR structure.
Returns:
the duration expressed as a fractional value.
int findEventPage ( CGRHandler  inHandleGR,
const GuidoDate date 
) [inherited]

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:
inHandleGRa Guido opaque handle to a GR structure.
datethe target date.
Returns:
a page number if greater than 0, 0 if no page found,
int findPageAt ( CGRHandler  inHandleGR,
const GuidoDate date 
) [inherited]

Finds the page which contain a given date.

Bug:
returns page + 1 when input date falls on the last system.
Parameters:
inHandleGRa Guido opaque handle to a GR structure.
datethe target date.
Returns:
a page number if greater than 0, 0 if no page found,
GuidoDate getPageDate ( CGRHandler  inHandleGR,
int  pageNum 
) [inherited]

Gives the time location of a Page.

Parameters:
inHandleGRa Guido opaque handle to a GR structure.
pageNuma page number (starts at 1).
Returns:
a GuidoDate