Master Commands

Functions
const GLCchar *	glcGetMasterListc (GLint inMaster, GLCenum inAttrib, GLint inIndex)
const GLCchar *	glcGetMasterMap (GLint inMaster, GLint inCode)
const GLCchar *	glcGetMasterc (GLint inMaster, GLCenum inAttrib)
GLint	glcGetMasteri (GLint inMaster, GLCenum inAttrib)
void	glcAppendCatalog (const GLCchar *inCatalog)
void	glcPrependCatalog (const GLCchar *inCatalog)
void	glcRemoveCatalog (GLint inIndex)

Detailed Description

Commands to create, manage and destroy masters.

A master is a representation of a font that is stored outside QuesoGLC in a standard format such as TrueType or Type1.

Every master has an associated character map. A character map is a table of entries that maps integer values to the name string that identifies the characters. Unlike fonts character maps, the character map of a master can not be modified.

QuesoGLC maps the font files into master objects that are visible through the GLC API. A group of font files from a single typeface family will be mapped into a single GLC master object that has multiple faces. For example, the files Courier.pfa, Courier-Bold.pfa, Courier-BoldOblique.pfa, and Courier-Oblique.pfa are visible through the GLC API as a single master with GLC_VENDOR="Adobe", GLC_FAMILY="Courier", GLC_MASTER_FORMAT="Type1", GLC_FACE_COUNT=4 and GLC_FACE_LIST=("Regular", "Bold", "Bold Oblique", "Oblique")

Some GLC commands have a parameter inMaster. This parameter is an offset from the the first element in the GLC master list. The command raises GLC_PARAMETER_ERROR if inMaster is less than zero or is greater than or equal to the value of the variable GLC_MASTER_COUNT.

Function Documentation

glcGetMasterListc()

const GLCchar * glcGetMasterListc	(	GLint	inMaster,
		GLCenum	inAttrib,
		GLint	inIndex )

This command returns a string from a string list that is an attribute of the master identified by inMaster.

The string list is identified by inAttrib. The command returns the string at offset inIndex from the first element in this string list. Below are the string list attributes associated with each GLC master and font and their element count attributes :

Master/font string list attributes

Name	Enumerant	Element count attribute
GLC_CHAR_LIST	0x0050	GLC_CHAR_COUNT
GLC_FACE_LIST	0x0051	GLC_FACE_COUNT

The command raises GLC_PARAMETER_ERROR if inIndex is less than zero or is greater than or equal to the value of the list element count attribute.

Parameters

inMaster	Master from which an attribute is needed.
inAttrib	String list that contains the desired attribute.
inIndex	Offset from the first element of the list associated with inAttrib.

Returns

The string at offset inIndex from the first element of the string list identified by inAttrib.

See also

glcGetMasterMap()

glcGetMasterc()

glcGetMasteri()

glcGetMasterMap()

const GLCchar * glcGetMasterMap	(	GLint	inMaster,
		GLint	inCode )

This command returns the string name of the character that the master identified by inMaster maps inCode to.

Every master has associated with it a master map, which is a table of entries that map integer values to the name string that identifies the character.

Every character code used in QuesoGLC is an element of the Unicode Character Database (UCD) defined by the standards ISO/IEC 10646:2003 and Unicode 4.0.1 (unless otherwise specified). A Unicode code point is denoted as U+hexcode, where hexcode is a sequence of hexadecimal digits. Each Unicode code point corresponds to a character that has a unique name string. For example, the code U+41 corresponds to the character LATIN CAPITAL LETTER A.

If the master does not map inCode, the command returns GLC_NONE.

Note

While you cannot change the map of a master, you can change the map of a font using glcFontMap().

Parameters

inMaster	The integer ID of the master from which to select the character.
inCode	The integer ID of character in the master map.

Returns

The string name of the character that inCode is mapped to.

See also

glcGetMasterListc()

glcGetMasterc()

glcGetMasteri()

glcGetMasterc()

const GLCchar * glcGetMasterc	(	GLint	inMaster,
		GLCenum	inAttrib )

This command returns a string attribute of the master identified by inMaster.

The table below lists the string attributes that are associated with each GLC master and font.

Master/font string attributes

Name	Enumerant
GLC_FAMILY	0x0060
GLC_MASTER_FORMAT	0x0061
GLC_VENDOR	0x0062
GLC_VERSION	0x0063
GLC_FULL_NAME_SGI	0x8002

Parameters

inMaster	The master for which an attribute value is needed.
inAttrib	The attribute for which the value is needed.

Returns

The value that is associated with the attribute inAttrib.

See also

glcGetMasteri()

glcGetMasterMap()

glcGetMasterListc()

glcGetMasteri()

GLint glcGetMasteri	(	GLint	inMaster,
		GLCenum	inAttrib )

This command returns an integer attribute of the master identified by inMaster.

The attribute is identified by inAttrib. The table below lists the integer attributes that are associated with each GLC master and font.

Master/font integer attributes

Name	Enumerant
GLC_CHAR_COUNT	0x0070
GLC_FACE_COUNT	0x0071
GLC_IS_FIXED_PITCH	0x0072
GLC_MAX_MAPPED_CODE	0x0073
GLC_MIN_MAPPED_CODE	0x0074

If the requested master attribute is GLC_IS_FIXED_PITCH then the command returns GL_TRUE if and only if each face of the master identified by inMaster has a fixed pitch.

Parameters

inMaster	The master for which an attribute value is needed.
inAttrib	The attribute for which the value is needed.

Returns

The value of the attribute inAttrib of the master identified by inMaster.

See also

glcGetMasterc()

glcGetMasterMap()

glcGetMasterListc()

glcAppendCatalog()

void glcAppendCatalog

(

const GLCchar *

inCatalog

)

This command appends the string inCatalog to the list GLC_CATALOG_LIST.

The catalog is represented as a zero-terminated string. The interpretation of this string is specified by the value that has been set using glcStringType().

A catalog is a path to a list of masters. A master is a representation of a font that is stored outside QuesoGLC in a standard format such as TrueType or Type1.

A catalog defines the list of masters that can be instantiated (that is, be used as fonts) in a GLC context.

A font is a styllistically consistent set of glyphs that can be used to render some set of characters. Each font has a family name (for example Palatino) and a state variable that selects one of the faces (for example regular, bold, italic, bold italic) that the font contains. A typeface is the combination of a family and a face (for example Palatino Bold).

Parameters

inCatalog

The catalog to append to the list GLC_CATALOG_LIST

See also

glcGetList() with argument GLC_CATALOG_LIST

glcGeti() with argument GLC_CATALOG_COUNT

glcPrependCatalog()

glcRemoveCatalog()

glcPrependCatalog()

void glcPrependCatalog

(

const GLCchar *

inCatalog

)

This command prepends the string inCatalog to the list GLC_CATALOG_LIST.

Parameters

inCatalog

The catalog to prepend to the list GLC_CATALOG_LIST

See also

glcAppendCatalog()

glcRemoveCatalog()

glcRemoveCatalog()

void glcRemoveCatalog

(

GLint

inIndex

)

This command removes a string from the list GLC_CATALOG_LIST.

It removes the string at offset inIndex from the first element in the list. The command raises GLC_PARAMETER_ERROR if inIndex is less than zero or is greater than or equal to the value of the variable GLC_CATALOG_COUNT.

QuesoGLC also destroys the masters that are defined in the corresponding catalog.

Parameters

inIndex

The string to remove from the catalog list GLC_CATALOG_LIST

See also

glcAppendCatalog()

glcPrependCatalog()