XmFontListEntryGetFont

Section: Misc. Reference Manual Pages (library call) Local index Up

NAME

XmFontListEntryGetFont --- A font list function that retrieves font information from a font list entry

SYNOPSIS

#include <Xm/Xm.h>
XtPointer XmFontListEntryGetFont(
XmFontListEntry entry,
XmFontType *type_return);

DESCRIPTION

XmFontListEntryGetFont retrieves font information for a specified font list entry. If the font list entry contains a font, type_return returns XmFONT_IS_FONT and the function returns a pointer to an XFontStruct. If the font list entry contains a font set, type_return returns XmFONT_IS_FONTSET and the function returns the XFontSet.

entry: Specifies the font list entry.
type_return: Specifies a pointer to the type of the font element for the current entry. Valid values are XmFONT_IS_FONT and XmFONT_IS_FONTSET.

The returned XFontSet or XFontStruct is not a copy of the toolkit data and must not be freed.

RETURN

Returns an XFontSet or a pointer to an XFontStruct structure.

XmFontList(3), XmFontListEntryCreate(3), XmFontListEntryGetTag(3) XmFontListEntryLoad(3), and XmFontListNextEntry(3).