Classes | Typedefs | Enumerations | Functions

GUIDOEngine.h File Reference

Go to the source code of this file.

Classes

struct  GuidoInitDesc
 The GuidoInitDesc data structure contains all information required by GuidoInit() More...
struct  GPaintStruct
 A structure to keep information about clipping and redrawing regions. More...
struct  GuidoOnDrawDesc
 Contains all graphic-related information required by GuidoOnDraw() More...
struct  GuidoDate
struct  GuidoLayoutSettings
struct  GuidoPageFormat

Typedefs

typedef struct NodeAR * ARHandler
typedef struct NodeGR * GRHandler
typedef struct NodeAR * CARHandler
typedef struct NodeGR * CGRHandler
typedef struct GuidoLayoutSettings GuidoLayoutSettings

Enumerations

enum  {
  kNoBB, kPageBB, kSystemsBB = 2, kSystemsSliceBB = 4,
  kStavesBB = 8, kMeasureBB = 0x10, kEventsBB = 0x20
}
 

Bounding boxes drawing control constants.

More...
enum  GuidoErrCode {
  guidoNoErr = 0, guidoErrParse = -1, guidoErrMemory = -2, guidoErrFileAccess = -3,
  guidoErrUserCancel = -4, guidoErrNoMusicFont = -5, guidoErrNoTextFont = -6, guidoErrBadParameter = -7,
  guidoErrInvalidHandle = -8, guidoErrNotInitialized = -9, guidoErrActionFailed = -10
}
 

The guido error codes list.

More...
enum  { kAutoDistrib = 1, kAlwaysDistrib = 2, kNeverDistrib = 3 }

Functions

GuidoErrCode GuidoInit (GuidoInitDesc *desc)
void GuidoShutdown ()
GuidoErrCode GuidoParseFile (const char *filename, ARHandler *ar)
GuidoErrCode GuidoParseString (const char *str, ARHandler *ar)
GuidoErrCode GuidoAR2GR (ARHandler ar, const GuidoLayoutSettings *settings, GRHandler *gr)
GuidoErrCode GuidoAR2RProportional (ARHandler ar, int width, int height, const GuidoDate &start, const GuidoDate &end, bool drawdur, VGDevice *dev)
GuidoErrCode GuidoUpdateGR (GRHandler gr, const GuidoLayoutSettings *settings)
void GuidoFreeAR (ARHandler ar)
void GuidoFreeGR (GRHandler gr)
const char * GuidoGetErrorString (GuidoErrCode errCode)
int GuidoGetParseErrorLine ()
void GuidoGetDefaultLayoutSettings (GuidoLayoutSettings *settings)
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.
GuidoErrCode GuidoOnDraw (GuidoOnDrawDesc *desc)
 Draws one page of score into a graphic device.
GuidoErrCode GuidoSVGExport (const GRHandler handle, int page, std::ostream &out, const char *fontfile)
 Exports one page of score to SVG.
GuidoErrCode GuidoAbstractExport (const GRHandler handle, int page, std::ostream &out)
 Exports an abstract representation of GUIDO draw commands.
GuidoErrCode GuidoBinaryExport (const GRHandler handle, int page, std::ostream &out)
 Exports an representation of GUIDO draw commands in a data-reduced dsl.
void GuidoDrawBoundingBoxes (int bbMap)
 Control bounding boxes drawing.
int GuidoGetDrawBoundingBoxes ()
 Gives bounding boxes drawing state.
void GuidoGetPageFormat (CGRHandler inHandleGR, int pageNum, GuidoPageFormat *format)
 Gives a score page format.
void GuidoSetDefaultPageFormat (const GuidoPageFormat *format)
 Sets the default score page format.
void GuidoGetDefaultPageFormat (GuidoPageFormat *format)
 Gives the default score page format.
float GuidoUnit2CM (float val)
 Converts internal Guido units into centimeters.
float GuidoCM2Unit (float val)
 Converts centimeters into internal Guido units.
float GuidoUnit2Inches (float val)
 Converts internal Guido units into inches.
float GuidoInches2Unit (float val)
 Converts inches into internal Guido units.
GuidoErrCode GuidoResizePageToMusic (GRHandler inHandleGR)
 Resize the page sizes to the music size.
void GuidoGetVersionNums (int *major, int *minor, int *sub)
 Gives the library version number as three integers.
const char * GuidoGetVersionStr ()
 Gives the library version number as a string.
GuidoErrCode GuidoCheckVersionNums (int major, int minor, int sub)
 Checks a required library version number.
float GuidoGetLineSpace ()
 Gives the distance between two staff lines.
GuidoErrCode GuidoMarkVoice (ARHandler inHandleAR, int voicenum, const GuidoDate &date, const GuidoDate &duration, unsigned char red, unsigned char green, unsigned char blue)
 Gives a color to all notes of a voice between a given time interval.
GuidoErrCode GuidoSetSymbolPath (ARHandler inHandleAR, const std::vector< std::string > &inPaths)
 Makes the correspondance between an ARMusic and a path.
GuidoErrCode GuidoGetSymbolPath (const ARHandler inHandleAR, std::vector< std::string > &inPathVector)
 Returns the path corresponding to an AR.
void AddGGSOutput (const char *s)
void AddGuidoOutput (const char *s)

Typedef Documentation

typedef struct NodeAR* ARHandler
typedef struct NodeGR* GRHandler
typedef struct NodeAR* CARHandler
typedef struct NodeGR* CGRHandler

Settings for the graphic score layout.


Enumeration Type Documentation

anonymous enum

Bounding boxes drawing control constants.

Enumerator:
kNoBB 
kPageBB 
kSystemsBB 
kSystemsSliceBB 
kStavesBB 
kMeasureBB 
kEventsBB 
anonymous enum
Enumerator:
kAutoDistrib 
kAlwaysDistrib 
kNeverDistrib 

Function Documentation

void AddGGSOutput ( const char *  s )
void AddGuidoOutput ( const char *  s )