FreeBSD Manual Pages
XmRendition(3) Library Functions Manual XmRendition(3) NAME XmRendition -- The Rendition registry SYNOPSIS #include <Xm/Xm.h> XmRendition DESCRIPTION XmRendition is a pseudo widget used for the rendering of XmStrings. Xm- Rendition has two parts: XmStringTag and rendering information. The Xm- StringTag part can be matched with an XmStringTag associated with a LO- CALE, CHARSET, or RENDITION[BEGIN|END] component within XmString. The rendering information contains information about the font or fontset, colors, tabs, and lines to be used in rendering a text component. If a resource in a rendition is unspecified, usually by setting it to XmAS_IS or XmUNSPECIFIED_PIXEL, then the value to be used for that re- source is the value of the immediately preceeding rendition in Xm- String. 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 de- fault value will be used. Classes XmRendition does not inherit from any widget class. New Resources The following table defines a set of widget resources used by the pro- grammer to specify data. To reference a resource by name or by class in a .Xdefaults file, remove the XmN or XmC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xde- faults file, remove the Xm prefix and use the remaining letters (in ei- ther 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 XmRenditionUpdate (S), retrieved by using XmRenditionRetrieve (G), or is not applicable (N/A). +------------------------------------------------------------------------------------------------+ | | XmRendition Resource Set | | | | Name | Class | Type | Default | Access | +------------------------+------------------------+---------------+---------------------+--------+ | XmNrenditionBackground | XmCRenditionBackground | Pixel | XmUNSPECIFIED_PIXEL | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNfont | XmCFont | XtPointer | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNfontName | XmCFontName | String | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNfontType | XmCFontType | XmFontType | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNrenditionForeground | XmCRenditionForeground | Pixel | XmUNSPECIFIED_PIXEL | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNloadModel | XmCLoadModel | unsigned char | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNstrikethruType | XmCStrikethruType | unsigned char | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNtabList | XmCTabList | XmTabList | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ | XmNtag | XmCTag | XmStringTag | "" | G | +------------------------+------------------------+---------------+---------------------+--------+ | XmNunderlineType | XmCUnderlineType | unsigned char | XmAS_IS | CSG | +------------------------+------------------------+---------------+---------------------+--------+ +------------------------+------------------------+---------------+---------------------+--------+ XmNrenditionBackground Specifies the background drawing color. A value of XmUNSPECI- FIED_PIXEL indicates that the background is not specified for this rendition. XmNfont Specifies the actual font or fontset to be used by this ren- dition. The value of this resource, if set to other than XmAS_IS, will be used regardless of the settings of the other font resources. Setting this resource will force XmNloadModel to be XmLOAD_IMMEDIATE. If this resource is not initially set, then it will be set subsequently by the rendition when- ever the font or fontset specified by XmNfontName is loaded. If both XmNfontName and XmNfont are specified in a resource file, the XmNfont specification will take precedence. XmNfontName 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 XmAS_IS indicates that the font is not specified for this rendition. If both XmNfontName and XmNfont are specified in a resource file, the XmNfont speci- fication will take precedence. XmNfontType Specifies whether the XmNfontName resource refers to a font name or to a base font name list. Valid values are Xm- FONT_IS_FONT and XmFONT_IS_FONTSET. XmNrenditionForeground Specifies the foreground drawing color. A value of XmUNSPECI- FIED_PIXEL indicates that the foreground is not specified for this rendition. XmNloadModel Specifies whether the font or fontset specified by XmNfont- Name is to be loaded when the rendition is created (Xm- LOAD_IMMEDIATE) or only when the font is required to render an XmString segment (XmLOAD_DEFERRED). Note that specifying XmLOAD_IMMEDIATE for XmNloadModel is valid only if XmNfont- Name is specified, in which case the specified font will be loaded on creation, or if XmNfont is specified, in which case the font is already loaded. XmLOAD_DEFERRED is only valid when XmNfontName is specified. XmNstrikethruType Specifies the type of line to be used to strike through a text segment. Valid values are XmNO_LINE, XmSINGLE_LINE, Xm- DOUBLE_LINE, XmSINGLE_DASHED_LINE, and XmDOUBLE_DASHED_LINE. A value of XmAS_IS indicates that the strike-through type is not specified for this rendition. XmNtabList Specifies the tab list to be used in rendering compound strings containing tab components. XmNtag Specifies the tag string to be used in matching the rendi- tions with other renditions or with XmStringTag components in XmStrings. This resource must always be specified. That is, NULL is not a legal value but the empty string is. This re- source is automatically set to the value of the tag parameter in the XmRenditionCreate call. XmNunderlineType Specifies the type of line to be used to underline a text segment. Valid values are XmNO_LINE, XmSINGLE_LINE, XmDOU- BLE_LINE, XmSINGLE_DASHED_LINE, and XmDOUBLE_DASHED_LINE. A value of XmAS_IS indicates that the underline type is not specified for this rendition. RELATED XmRenditionCreate(3), XmRenditionFree(3), XmRenditionRetrieve(3), Xm- RenditionUpdate(3), and XmString(3). XmRendition(3)
NAME | SYNOPSIS | DESCRIPTION | RELATED
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmRendition&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>