Main Page   Modules   Data Structures   Globals   Appendix  

Font
[GUI API]

Font object. More...

Variables: Keys of font property.

MSymbol Mfoundry
 Key of font property specifying foundry.

MSymbol Mfamily
 Key of font property specifying foundry.

MSymbol Mweight
 Key of font property specifying weight.

MSymbol Mstyle
 Key of font property specifying style.

MSymbol Mstretch
 Key of font property specifying stretch.

MSymbol Madstyle
 Key of font property specifying additional style.

MSymbol Mregistry
 Key of font property specifying registry.

MSymbol Msize
 Key of font property specifying size.

MSymbol Mresolution
 Key of font property specifying resolution.


Typedefs

typedef MFont MFont
 Type of fonts.


Functions

MFontmfont ()
 Create a new font.

MFontmfont_from_name (char *name)
 Create a new font from fontname.

MFontmfont_copy (MFont *font)
 Return a copy of a font.

char * mfont_name (MFont *font)
 Create a fontname from a font.

void * mfont_get_prop (MFont *font, MSymbol key)
 Get a property value of a font.

int mfont_put_prop (MFont *font, MSymbol key, void *val)
 Put a property value to a font.

MSymbolmfont_selection_priority ()
 Return the font selection priority.

int mfont_set_selection_priority (MSymbol *keys)
 Set the font selection priority.

MFontmfont_find (MFrame *frame, MFont *spec, int *score, int limited_size)
 Find a font.

int mfont_set_encoding (MFont *font, MSymbol encoding_name, MSymbol repertory_name)
 Set encoding of a font.


Variables

MPlistmfont_freetype_path
 List of font files and directories that contain font files.


Detailed Description

The m17n GUI API represents a font by an object of the type MFont. A font can have font properties. Like other types of properties, a font property consists of a key and a value. The key of a font property must be one of the following symbols:

Mfoundry, Mfamily, Mweight, Mstyle, Mstretch, Madstyle, Mregistry, Msize, Mresolution.

When the key of a font property is Msize or Mresolution, its value is an integer. Otherwise the value is a symbol. "The font property that belongs to font F and whose key is Mxxx" may be shortened to "the xxx property of F".

The value of a foundry property is a symbol representing font foundry information, e.g. adobe, misc, etc.

The value of a family property is a symbol representing font family information, e.g. times, helvetica, etc.

The value of a weight property is a symbol representing weight information, e.g. normal, bold, etc.

The value of a style property is a symbol representing slant information, e.g. normal, italic, etc.

The value of a stretch property is a symbol representing width information, e.g. normal, semicondensed, etc.

The value of an adstyle property is a symbol representing abstract font family information, e.g. serif, sans-serif, etc.

The value of a registry property is a symbol representing registry information, e.g. iso10646-1, iso8895-1, etc.

The value of a size property is an integer representing design size in the unit of 1/10 point.

The value of a resolution property is an integer representing assumed device resolution in the unit of dots per inch (dpi)

The m17n library uses font objects for two purposes: to receive font specification from an application program, and to present available fonts to an application program. When the m17n library presents an available font to an application program, all font properties have a concrete value.

The m17n library supports three kinds of fonts: Window system fonts, FreeType fonts, and OpenType fonts.


Typedef Documentation

typedef struct MFont MFont
 

The type MFont is the structure defining fonts. It contains information about the following properties of a font: foundry, family, weight, style, stretch, adstyle, registry, size, and resolution.

This structure is used both for specifying a font in a fontset and for storing information about available system fonts.

The internal structure is concealed from application code.

See Also:
mfont(), mfont_from_name(), mfont_find().


Function Documentation

MFont* mfont  ) 
 

The mfont() function creates a new font object that has no property.

Return value:
This function returns a pointer to the created font object.

MFont* mfont_from_name char *  name  ) 
 

The mfont_from_name() function creates a new font object. The properties are extracted fontname name.

How to extract properties is window system dependent. The m17n-X library parses name as XLFD (X Logical Font Description).

Return value:
If the operation was successful, this function returns a pointer to the created font. Otherwise it returns NULL.

MFont* mfont_copy MFont font  ) 
 

The mfont_copy() function returns a new copy of font.

char* mfont_name MFont font  ) 
 

The mfont_name() function creates a fontname string created from font.

The syntax of fontname is window system dependent. The m17n-X library returns a fontname conforming to XLFD (X Logical Font Description).

Return value:
This function returns the created fontname string, which is not freed unless the user explicitly does so by free().

void* mfont_get_prop MFont font,
MSymbol  key
 

The mfont_get_prop() function gets the value of key property of font. key must be one of the following symbols:

Mfamily, Mweight, Mstyle, Mstretch, Madstyle, Mregistry, Msize, Mresolution.

Return value:
If key is Mfamily, Mweight, Mstyle, Mstretch, Madstyle, or Mregistry, this function returns the corresponding value as a symbol. If the font does not have key property, it returns Mnil.
If key is Msize or Mresolution, this function returns the corresponding value as an integer. If the font does not have key property, it returns 0.

If key is something else, it returns NULL and assigns an error code to the external variable merror_code.

int mfont_put_prop MFont font,
MSymbol  key,
void *  val
 

The mfont_put_prop() function puts a font property whose key is key and value is val to font. key must be one of the following symbols:

Mfamily, Mweight, Mstyle, Mstretch, Madstyle, Mregistry, Msize, Mresolution.

If key is Msize of Mresolution, val must be an integer. Otherwise, val must be a symbol.

MSymbol* mfont_selection_priority  ) 
 

The mfont_selection_priority() function returns a newly created array of six symbols. The elements are the following keys of font properties ordered by priority.

Mfamily, Mweight, Mstyle, Mstretch, Madstyle, Msize.

The m17n library selects the best matching font according to the order of this array. A font that has a different value for a property of lower priority is preferred to a font that has a different value for a property of higher priority.

int mfont_set_selection_priority MSymbol keys  ) 
 

The mfont_set_selection_priority() function sets font selection priority according to keys, which is an array of six symbols. Each element must be one of the below. No two elements must be the same.

Mfamily, Mweight, Mstyle, Mstretch, Madstyle, Msize.

See the documentation of the function mfont_selection_priority() for details.

MFont* mfont_find MFrame frame,
MFont spec,
int *  score,
int  limited_size
 

The mfont_find() function returns a pointer to the available font that matches best the specification spec on frame frame.

score, if not NULL, must point to a place to store the score value that indicates how well the found font matches to spec. A smaller score means a better match.

int mfont_set_encoding MFont font,
MSymbol  encoding_name,
MSymbol  repertory_name
 

The mfont_set_encoding() function sets the encoding information of font.

If encoding_name is be a symbol representing a charset that has the same encoding as the font.

If repertory_name Mnil or a symbol representing a charset that has the same repertory as the font. If it is Mnil, whether a specific character is supported by the font is asked to each font driver.

Return value:
If the operation was successful, this function returns 0. Otherwise it returns -1 and assigns an error code to the external variable merror_code.


Variable Documentation

MSymbol Mfoundry
 

The variable Mfoundry is a symbol of name "foundry" and is used as a key of font property and face property. The property value must be a symbol whose name is a foundry name of a font.

MSymbol Mfamily
 

The variable Mfamily is a symbol of name "family" and is used as a key of font property and face property. The property value must be a symbol whose name is a family name of a font.

MSymbol Mweight
 

The variable Mweight is a symbol of name "weight" and is used as a key of font property and face property. The property value must be a symbol whose name is a weight name of a font (e.g "medium", "bold").

MSymbol Mstyle
 

The variable Mstyle is a symbol of name "style" and is used as a key of font property and face property. The property value must be a symbol whose name is a style name of a font (e.g "r", "i", "o").

MSymbol Mstretch
 

The variable Mstretch is a symbol of name "stretch" and is used as a key of font property and face property. The property value must be a symbol whose name is a stretch name of a font (e.g "normal", "condensed").

MSymbol Madstyle
 

The variable Madstyle is a symbol of name "adstyle" and is used as a key of font property and face property. The property value must be a symbol whose name is an additional style name of a font (e.g "serif", "", "sans").

MSymbol Mregistry
 

The variable Mregistry is a symbol of name "registry" and is used as a key of font property. The property value must be a symbol whose name is a registry name a font registry (e.g. "iso8859-1", "jisx0208.1983-0").

MSymbol Msize
 

The variable Msize is a symbol of name "size" and is used as a key of font property and face property. The property value must be an integer specifying a font design size in the unit of 1/10 point (on 100 dpi display).

MSymbol Mresolution
 

The variable Mresolution is a symbol of name "size" and is used as a key of font property and face property. The property value must be an integer to specifying a font resolution in the unit of dots per inch (dpi).

MPlist* mfont_freetype_path
 

The variable mfont_freetype_path is a plist of FreeType font files and directories that contain FreeType font files. Key of the element is Mstring, and the value is a string that represents a font file or a directory.

The macro M17N_INIT() sets up this variable to contain the sub-directory "fonts" of the m17n database and the environment variable "M17NDIR". The first call of mframe() creates the internal list of the actually available fonts from this variable. Thus, an application program, if necessary, must modify the variable before calling mframe(). If it is going to add a new element, value must be a string that can be safely freed.

If the m17n library is not configured to use the FreeType library, this variable is not used.


Top of this page

Main Page   Modules   Data Structures   Globals   Appendix  

mulemark mule-aist@m17n.org