'\" t
...\" RendA.sgm /main/10 1996/09/08 20:56:54 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmRendition" "library call"
.SH "NAME"
\fBXmRendition\fR \(em The Rendition registry
.iX "XmRendition"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
XmRendition
.fi
.SH "DESCRIPTION"
.PP
\fBXmRendition\fR is a pseudo widget used for the rendering of
\fBXmString\fRs\&. \fBXmRendition\fR has two parts:
\fBXmStringTag\fR and rendering information\&. The \fBXmStringTag\fR part
can be matched with an \fBXmStringTag\fR associated with a
\fBLOCALE\fP, \fBCHARSET\fP, or \fBRENDITION[BEGIN|END]\fP component
within \fBXmString\fR\&.
The rendering information contains
information about the font or fontset, colors, tabs, and lines to be
used in rendering a text component\&.
.PP
If a resource in a rendition is unspecified, usually by setting it to
\fBXmAS_IS\fP or \fBXmUNSPECIFIED_PIXEL\fP,
then the value to be used for that resource is the value of the
immediately preceeding rendition in \fBXmString\fR\&. 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\&.
.SS "Classes"
.PP
\fBXmRendition\fR does not inherit from any widget class\&.
.SS "New Resources"
.PP
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 \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or \fBXmC\fP
prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP 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 \fBXmRenditionUpdate\fP (S), retrieved by using
\fBXmRenditionRetrieve\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmRendition Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNrenditionBackgroundXmCRenditionBackgroundPixelXmUNSPECIFIED_PIXELCSG
_____
XmNfontXmCFontXtPointerXmAS_ISCSG
_____
XmNfontNameXmCFontNameStringXmAS_ISCSG
_____
XmNfontTypeXmCFontTypeXmFontTypeXmAS_ISCSG
_____
XmNrenditionForegroundXmCRenditionForegroundPixelXmUNSPECIFIED_PIXELCSG
_____
XmNloadModelXmCLoadModelunsigned charXmAS_ISCSG
_____
XmNstrikethruTypeXmCStrikethruTypeunsigned charXmAS_ISCSG
_____
XmNtabListXmCTabListXmTabListXmAS_ISCSG
_____
XmNtagXmCTagXmStringTag""G
_____
XmNunderlineTypeXmCUnderlineTypeunsigned charXmAS_ISCSG
_____
.TE
.IP "\fBXmNrenditionBackground\fP" 10
Specifies the background drawing color\&. A value of
\fBXmUNSPECIFIED_PIXEL\fP indicates that the background is not
specified for this rendition\&.
.IP "\fBXmNfont\fP" 10
Specifies the actual font or fontset to be used by this rendition\&. The
value of this resource, if set to other than \fBXmAS_IS\fP, will be
used regardless of the settings of the other font resources\&. Setting
this resource will force \fBXmNloadModel\fP to be
\fBXmLOAD_IMMEDIATE\fP\&. If this resource is not initially set, then
it will be set subsequently by the rendition whenever the font or
fontset specified by \fBXmNfontName\fP is loaded\&. If both
\fBXmNfontName\fP and \fBXmNfont\fP are specified in a resource file,
the \fBXmNfont\fP specification will take precedence\&.
.IP "\fBXmNfontName\fP" 10
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 \fBXmAS_IS\fP indicates that the font is not specified for
this rendition\&. If both \fBXmNfontName\fP and \fBXmNfont\fP are
specified in a resource file, the \fBXmNfont\fP specification will
take precedence\&.
.IP "\fBXmNfontType\fP" 10
Specifies whether the
\fBXmNfontName\fP resource refers to a font name or to a base font name
list\&. Valid values are \fBXmFONT_IS_FONT\fP and
\fBXmFONT_IS_FONTSET\fP\&.
.IP "\fBXmNrenditionForeground\fP" 10
Specifies the foreground drawing color\&. A value of
\fBXmUNSPECIFIED_PIXEL\fP indicates that the foreground is not
specified for this rendition\&.
.IP "\fBXmNloadModel\fP" 10
Specifies whether the font or fontset specified by \fBXmNfontName\fP
is to be loaded when the rendition is created (\fBXmLOAD_IMMEDIATE\fP)
or only when the font is required to render an \fBXmString\fR segment
(\fBXmLOAD_DEFERRED\fP)\&.
Note that specifying \fBXmLOAD_IMMEDIATE\fP for \fBXmNloadModel\fP is
valid only if \fBXmNfontName\fP is specified, in which case the
specified font will be loaded on creation, or if \fBXmNfont\fP is
specified, in which case the font is already loaded\&.
\fBXmLOAD_DEFERRED\fP is only valid when \fBXmNfontName\fP is
specified\&.
.IP "\fBXmNstrikethruType\fP" 10
Specifies the type of line to be used to strike through a text
segment\&. Valid values are \fBXmNO_LINE\fP, \fBXmSINGLE_LINE\fP,
\fBXmDOUBLE_LINE\fP, \fBXmSINGLE_DASHED_LINE\fP, and
\fBXmDOUBLE_DASHED_LINE\fP\&. A value of \fBXmAS_IS\fP indicates that
the strike-through type is not specified for this rendition\&.
.IP "\fBXmNtabList\fP" 10
Specifies the tab list to be used in rendering compound strings
containing tab components\&.
.IP "\fBXmNtag\fP" 10
Specifies the tag string to be used in matching the renditions with
other renditions or with \fBXmStringTag\fR components in
\fBXmStrings\fP\&. 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 \fItag\fP parameter in
the \fBXmRenditionCreate\fP call\&.
.IP "\fBXmNunderlineType\fP" 10
Specifies the type of line to be used to underline a text segment\&.
Valid values are \fBXmNO_LINE\fP, \fBXmSINGLE_LINE\fP,
\fBXmDOUBLE_LINE\fP, \fBXmSINGLE_DASHED_LINE\fP, and
\fBXmDOUBLE_DASHED_LINE\fP\&. A value of \fBXmAS_IS\fP indicates that
the underline type is not specified for this rendition\&.
.SH "RELATED"
.PP
\fBXmRenditionCreate\fP(3),
\fBXmRenditionFree\fP(3),
\fBXmRenditionRetrieve\fP(3),
\fBXmRenditionUpdate\fP(3), and
\fBXmString\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:28