PfQueryFonts()

Construct a list of fonts

Synopsis:

#include <photon/Pf.h>

int PfQueryFonts( long symbol, 
                  unsigned flags, 
                  FontDetails list[], 
                  int n );

Library:

ph

Description:

This function constructs a list of all fonts that may be used to render the character specified by the symbol parameter. For example, use 'A' to get a list of normal/Latin fonts, or 0x3A9 (omega) to get a list of Greek fonts. (See PkKeyDef.h or ISO/EIC 10646-1 for a list of symbols.)

The list of fonts is further filtered by the flags parameter, which may contain any combination of the following:

PHFONT_SCALABLE

Select scalable fonts.

PHFONT_BITMAP

Select bitmapped fonts.

PHFONT_PROP

Select proportional fonts.

PHFONT_FIXED

Select fixed-width fonts.

PHFONT_ALL_FONTS

Select all fonts.

PHFONT_DONT_SHOW_LEGACY

Exclude legacy fonts. This flag overrides PHFONT_ALL_FONTS.

Up to n matching font family entries are placed in the user-provided list.

If n is 0 and list is NULL, PfQueryFonts() returns the number of matching fonts but doesn't try to fill in the list. You can use this feature to determine the number of items to allocate for the list.

FontDetails structure

The entries in the list are of type FontDetails, and contain the following fields:

FontDescription desc

Textual name of the font family (e.g. Helvetica).

FontName stem

Base stem of the font family (e.g. helv).

short losize

Lowest point size available for this font. If losize and hisize are both 0, the font is scalable.

short hisize

Highest point size available for this font. If hisize and losize are both 0, the font is scalable.

unsigned short flags

Various stylistic/attribute flags for this font family:

• PHFONT_INFO_ALIAS -- the entry is a mapping or virtual font, like TextFont.
• PHFONT_INFO_BLDITC -- bold italic style.
• PHFONT_INFO_BOLD -- bold style.
• PHFONT_INFO_FIXED -- fixed-width font.
• PHFONT_INFO_ITALIC -- italic style.
• PHFONT_INFO_PLAIN -- plain/regular style.
• PHFONT_INFO_PROP -- proportional-width font.

Use PfGenerateFontName() and the information in the FontDetails structure to build a font name that you can pass to functions such as PgSetFont().

Returns:

The number of matching fonts found, or -1 on error.

Classification:

Photon

See also:

PfGenerateFontName(), PfQueryFontInfo(), PgSetFont()

PtFontSel (in the Photon Widget Reference)

Fonts chapter of the Photon Programmer's Guide