<!-- $XConsortium: FontLstK.sgm /main/9 1996/09/08 20:43:49 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN232.rsml.1">
<RefMeta>
<RefEntryTitle>XmFontListEntryCreate</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmFontListEntryCreate</Function></RefName>
<RefPurpose>A font list function that creates a font list entry
<IndexTerm>
<Primary>XmFontListEntryCreate</Primary>
</IndexTerm><IndexTerm>
<Primary>font list functions</Primary>
<Secondary>XmFontListEntryCreate</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>XmFontListEntry <Function>XmFontListEntryCreate</Function></FuncDef>
<!--<ParamDef><Replaceable>tag, type, font</Replaceable></ParamDef>-->
<ParamDef>char *<Parameter>tag</Parameter></ParamDef>
<ParamDef>XmFontType <Parameter>type</Parameter></ParamDef>
<ParamDef>XtPointer <Parameter>font</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmFontListEntryCreate</Function> creates a font list entry that
contains either a font or font set and is identified by a tag.
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>tag</Emphasis></Term>
<ListItem>
<Para>Specifies a NULL terminated string for the tag of the font
list entry. The tag may be specified as <SystemItem Class="Resource">XmFONTLIST_DEFAULT_TAG</SystemItem>,
which is used to identify the default font list element in a
font list.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">type</Symbol></Term>
<ListItem>
<Para>Specifies whether the <Symbol Role="Variable">font</Symbol> argument is a font structure or
a font set. Valid values are <SystemItem Class="Constant">XmFONT_IS_FONT</SystemItem> and
<SystemItem Class="Constant">XmFONT_IS_FONTSET</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">font</Symbol></Term>
<ListItem>
<Para>Specifies either an <Symbol>XFontSet</Symbol> returned by <Symbol>XCreateFontSet</Symbol> or
a pointer to an <Symbol>XFontStruct</Symbol> returned by <Function>XLoadQueryFont</Function>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The toolkit does not copy the X Font structure specified by the
<Symbol Role="Variable">font</Symbol> argument. Therefore, an application programmer must not
free <Symbol>XFontStruct</Symbol> or <Symbol>XFontSet</Symbol> until all font lists and/or font
entries that reference it have been freed.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a font list entry.
The function allocates space to hold the
returned font list entry. The application is responsible for managing the
allocated space. The application can recover the allocated space by calling
<Function>XmFontListEntryFree</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmFontList;,
&cdeman.XmFontListAppendEntry;,
&cdeman.XmFontListEntryFree;,
&cdeman.XmFontListEntryGetFont;,
&cdeman.XmFontListEntryGetTag;,
&cdeman.XmFontListEntryLoad;, and
&cdeman.XmFontListRemoveEntry;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
