<!-- $XConsortium: RendA.sgm /main/10 1996/09/08 20:56:54 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.MAN364.rsml.1">
<RefMeta>
<RefEntryTitle>XmRendition</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><StructName Role="typedef">XmRendition</StructName></RefName>
<RefPurpose>The Rendition registry
<IndexTerm>
<Primary>XmRendition</Primary>
</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-->
<RefSynopsisDiv>
<Synopsis>&npzwc;#include &lt;Xm/Xm.h>
XmRendition
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><StructName Role="typedef">XmRendition</StructName> is a pseudo widget used for the rendering of
<StructName Role="typedef">XmString</StructName>s. <StructName Role="typedef">XmRendition</StructName> has two parts:
<StructName Role="typedef">XmStringTag</StructName> and rendering information. The <StructName Role="typedef">XmStringTag</StructName> part
can be matched with an <StructName Role="typedef">XmStringTag</StructName> associated with a
<Symbol Role="Define">LOCALE</Symbol>, <Symbol Role="Define">CHARSET</Symbol>, or <Literal>RENDITION[BEGIN|END]</Literal> component
within <StructName Role="typedef">XmString</StructName>.
The rendering information contains
information about the font or fontset, colors, tabs, and lines to be
used in rendering a text component.
</Para>
<Para>If a resource in a rendition is unspecified, usually by setting it to
<SystemItem Class="Constant">XmAS_IS</SystemItem> or <SystemItem Class="Constant">XmUNSPECIFIED_PIXEL</SystemItem>,
then the value to be used for that resource is the value of the
immediately preceding rendition in <StructName Role="typedef">XmString</StructName>. If that value
is unspecified, then the preceding value is used, and so on. If
no renditions specify a value for a resource, then a default value
will be used.
</Para>
<RefSect2>
<Title>Classes</Title>
<Para><StructName Role="typedef">XmRendition</StructName> does not inherit from any widget class.
</Para>
</RefSect2>
<RefSect2>
<Title>New Resources</Title>
<Para>The following table defines a set of widget resources used by the
programmer to specify data. To reference a resource by name
or by class in a <Filename>.Xdefaults</Filename> file, remove the <SystemItem Class="Constant">XmN</SystemItem> or <SystemItem Class="Constant">XmC</SystemItem>
prefix and use the remaining letters. To specify one of the defined
values for a resource in a <Filename>.Xdefaults</Filename> file, remove the <SystemItem Class="Constant">Xm</SystemItem> prefix
and use the remaining letters (in either lowercase or uppercase, but include
any underscores between words). The codes in the access column
indicate if the given resource can be set at creation time (C),
set by using <Function>XmRenditionUpdate</Function> (S), retrieved by using
<Function>XmRenditionRetrieve</Function> (G), or is not applicable (N/A).
</Para>
<Para><!-- @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--></Para>
<InformalTable Frame="All" Remap="center" Orient="Port">
<TGroup Cols="5">
<ColSpec Rowsep="1" Colsep="1" Align="Left" Colname="1">
<ColSpec Rowsep="1" Colsep="1" Align="Left" Colname="2">
<ColSpec Rowsep="1" Colsep="1" Align="Left" Colname="3">
<ColSpec Rowsep="1" Colsep="1" Align="Left" Colname="4">
<ColSpec Rowsep="1" Align="Left" Colname="5">
<TBody>
<Row>
<Entry Align="Center" Nameend="5" Namest="1"><Literal>XmRendition Resource Set</Literal></Entry>
</Row>
<Row>
<Entry Rowsep="1"><Literal>Name</Literal></Entry>
<Entry Rowsep="1"><Literal>Class</Literal></Entry>
<Entry Rowsep="1"><Literal>Type</Literal></Entry>
<Entry Rowsep="1"><Literal>Default</Literal></Entry>
<Entry Rowsep="1"><Literal>Access</Literal></Entry>
</Row>
<Row>
<Entry>XmNrenditionBackground</Entry>
<Entry>XmCRenditionBackground</Entry>
<Entry>Pixel</Entry>
<Entry>XmUNSPECIFIED_PIXEL</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNfont</Entry>
<Entry>XmCFont</Entry>
<Entry>XtPointer</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNfontName</Entry>
<Entry>XmCFontName</Entry>
<Entry>String</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNfontType</Entry>
<Entry>XmCFontType</Entry>
<Entry>XmFontType</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNrenditionForeground</Entry>
<Entry>XmCRenditionForeground</Entry>
<Entry>Pixel</Entry>
<Entry>XmUNSPECIFIED_PIXEL</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNloadModel</Entry>
<Entry>XmCLoadModel</Entry>
<Entry>unsigned char</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNstrikethruType</Entry>
<Entry>XmCStrikethruType</Entry>
<Entry>unsigned char</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNtabList</Entry>
<Entry>XmCTabList</Entry>
<Entry>XmTabList</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
<Row>
<Entry>XmNtag</Entry>
<Entry>XmCTag</Entry>
<Entry>XmStringTag</Entry>
<Entry>""</Entry>
<Entry>G</Entry>
</Row>
<Row>
<Entry>XmNunderlineType</Entry>
<Entry>XmCUnderlineType</Entry>
<Entry>unsigned char</Entry>
<Entry>XmAS_IS</Entry>
<Entry>CSG</Entry>
</Row>
</TBody>
</TGroup>
</InformalTable>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNrenditionBackground</SystemItem></Term>
<ListItem>
<Para>Specifies the background drawing color. A value of
<SystemItem Class="Constant">XmUNSPECIFIED_PIXEL</SystemItem> indicates that the background is not
specified for this rendition.
<!-- .zA "feature, 5750, R2.0, Added XmNbackgroundState"--><!-- .LI "\*LXmNbackgroundState\*O"--><!-- Specifies whether the rendition background color overrides other internally--><!-- specified background colors.  Valid values are \*LXmAS_IS\*O and--><!-- \*LXmFORCE_COLOR\*O.--><!-- .zZ "feature, 5750, R2.0, Added XmNbackgroundState"--></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNfont</SystemItem></Term>
<ListItem>
<Para>Specifies the actual font or fontset to be used by this rendition. The
value of this resource, if set to other than <SystemItem Class="Constant">XmAS_IS</SystemItem>, will be
used regardless of the settings of the other font resources. Setting
this resource will force <SystemItem Class="Resource">XmNloadModel</SystemItem> to be
<SystemItem Class="Constant">XmLOAD_IMMEDIATE</SystemItem>. If this resource is not initially set, then
it will be set subsequently by the rendition whenever the font or
fontset specified by <SystemItem Class="Resource">XmNfontName</SystemItem> is loaded. If both
<SystemItem Class="Resource">XmNfontName</SystemItem> and <SystemItem Class="Resource">XmNfont</SystemItem> are specified in a resource file,
the <SystemItem Class="Resource">XmNfont</SystemItem> specification will take precedence.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNfontName</SystemItem></Term>
<ListItem>
<Para>Specifies an X Logical Font Description (XLFD) string, which is
interpreted either as a font name or as a base font name list. A base
font name list is a comma-separated and NULL-terminated string. A
value of <SystemItem Class="Constant">XmAS_IS</SystemItem> indicates that the font is not specified for
this rendition. If both <SystemItem Class="Resource">XmNfontName</SystemItem> and <SystemItem Class="Resource">XmNfont</SystemItem> are
specified in a resource file, the <SystemItem Class="Resource">XmNfont</SystemItem> specification will
take precedence.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNfontType</SystemItem></Term>
<ListItem>
<Para>Specifies whether the
<SystemItem Class="Resource">XmNfontName</SystemItem> resource refers to a font name or to a base font name
list. Valid values are <SystemItem Class="Constant">XmFONT_IS_FONT</SystemItem> and
<SystemItem Class="Constant">XmFONT_IS_FONTSET</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNrenditionForeground</SystemItem></Term>
<ListItem>
<Para>Specifies the foreground drawing color. A value of
<SystemItem Class="Constant">XmUNSPECIFIED_PIXEL</SystemItem> indicates that the foreground is not
specified for this rendition.
<!-- .zA "feature, 5750, R2.0, Added XmNforegroundState"--><!-- .LI "\*LXmNforegroundState\*O"--><!-- Specifies whether the rendition foreground color overrides other internally--><!-- specified foreground colors.  Valid values are \*LXmAS_IS\*O and--><!-- \*LXmFORCE_COLOR\*O.--><!-- .zZ "feature, 5750, R2.0, Added XmNforegroundState"--></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNloadModel</SystemItem></Term>
<ListItem>
<Para>Specifies whether the font or fontset specified by <SystemItem Class="Resource">XmNfontName</SystemItem>
is to be loaded when the rendition is created (<SystemItem Class="Constant">XmLOAD_IMMEDIATE</SystemItem>)
or only when the font is required to render an <StructName Role="typedef">XmString</StructName> segment
(<SystemItem Class="Constant">XmLOAD_DEFERRED</SystemItem>).
Note that specifying <SystemItem Class="Constant">XmLOAD_IMMEDIATE</SystemItem> for <SystemItem Class="Resource">XmNloadModel</SystemItem> is
valid only if <SystemItem Class="Resource">XmNfontName</SystemItem> is specified, in which case the
specified font will be loaded on creation, or if <SystemItem Class="Resource">XmNfont</SystemItem> is
specified, in which case the font is already loaded.
<SystemItem Class="Constant">XmLOAD_DEFERRED</SystemItem> is only valid when <SystemItem Class="Resource">XmNfontName</SystemItem> is
specified.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNstrikethruType</SystemItem></Term>
<ListItem>
<Para>Specifies the type of line to be used to strike through a text
segment. Valid values are <SystemItem Class="Constant">XmNO_LINE</SystemItem>, <SystemItem Class="Constant">XmSINGLE_LINE</SystemItem>,
<SystemItem Class="Constant">XmDOUBLE_LINE</SystemItem>, <SystemItem Class="Constant">XmSINGLE_DASHED_LINE</SystemItem>, and
<SystemItem Class="Constant">XmDOUBLE_DASHED_LINE</SystemItem>. A value of <SystemItem Class="Constant">XmAS_IS</SystemItem> indicates that
the strike-through type is not specified for this rendition.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNtabList</SystemItem></Term>
<ListItem>
<Para>Specifies the tab list to be used in rendering compound strings
containing tab components.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNtag</SystemItem></Term>
<ListItem>
<Para>Specifies the tag string to be used in matching the renditions with
other renditions or with <StructName Role="typedef">XmStringTag</StructName> components in
<Symbol>XmStrings</Symbol>. This resource must always be specified. That is,
NULL is not a legal value but the empty string is.
This resource is automatically set to the value of the <Emphasis>tag</Emphasis> parameter in
the <Function>XmRenditionCreate</Function> call.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Resource">XmNunderlineType</SystemItem></Term>
<ListItem>
<Para>Specifies the type of line to be used to underline a text segment.
Valid values are <SystemItem Class="Constant">XmNO_LINE</SystemItem>, <SystemItem Class="Constant">XmSINGLE_LINE</SystemItem>,
<SystemItem Class="Constant">XmDOUBLE_LINE</SystemItem>, <SystemItem Class="Constant">XmSINGLE_DASHED_LINE</SystemItem>, and
<SystemItem Class="Constant">XmDOUBLE_DASHED_LINE</SystemItem>. A value of <SystemItem Class="Constant">XmAS_IS</SystemItem> indicates that
the underline type is not specified for this rendition.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmRenditionCreate;,
&cdeman.XmRenditionFree;,
&cdeman.XmRenditionRetrieve;,
&cdeman.XmRenditionUpdate;, and
&cdeman.XmString;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
