1XmRendition(library call)                            XmRendition(library call)
2
3
4

NAME

6       XmRendition — The Rendition registry
7

SYNOPSIS

9       #include <Xm/Xm.h>
10       XmRendition
11

DESCRIPTION

13       XmRendition  is  a  pseudo  widget used for the rendering of XmStrings.
14       XmRendition has two parts: XmStringTag and rendering  information.  The
15       XmStringTag  part  can be matched with an XmStringTag associated with a
16       LOCALE, CHARSET, or  RENDITION[BEGIN|END]  component  within  XmString.
17       The  rendering  information  contains  information  about  the  font or
18       fontset, colors, tabs, and lines to be used in rendering a text  compo‐
19       nent.
20
21       If  a  resource in a rendition is unspecified, usually by setting it to
22       XmAS_IS or XmUNSPECIFIED_PIXEL, then the value  to  be  used  for  that
23       resource  is  the  value  of  the  immediately  preceeding rendition in
24       XmString. If that value is unspecified, then  the  preceding  value  is
25       used,  and so on. If no renditions specify a value for a resource, then
26       a default value will be used.
27
28   Classes
29       XmRendition does not inherit from any widget class.
30
31   New Resources
32       The following table defines a set of widget resources used by the  pro‐
33       grammer to specify data. To reference a resource by name or by class in
34       a .Xdefaults file, remove the XmN or XmC prefix and use  the  remaining
35       letters. To specify one of the defined values for a resource in a .Xde‐
36       faults file, remove the Xm prefix and use  the  remaining  letters  (in
37       either  lowercase  or  uppercase,  but  include any underscores between
38       words). The codes in the access column indicate if the  given  resource
39       can  be  set  at creation time (C), set by using XmRenditionUpdate (S),
40       retrieved by using XmRenditionRetrieve (G), or is not applicable (N/A).
41
42       ┌───────────────────────────────────────────────────────────────────────────────────────────────┐
43       │                       │           XmRendition R│esource Set     │                     │        │
44Name                   Class                  Type          Default             Access 
45       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
46       │XmNrenditionBackground │ XmCRenditionBackground │ Pixel         │ XmUNSPECIFIED_PIXEL │ CSG    │
47       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
48       │XmNfont                │ XmCFont                │ XtPointer     │ XmAS_IS             │ CSG    │
49       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
50       │XmNfontName            │ XmCFontName            │ String        │ XmAS_IS             │ CSG    │
51       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
52       │XmNfontType            │ XmCFontType            │ XmFontType    │ XmAS_IS             │ CSG    │
53       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
54       │XmNrenditionForeground │ XmCRenditionForeground │ Pixel         │ XmUNSPECIFIED_PIXEL │ CSG    │
55       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
56       │XmNloadModel           │ XmCLoadModel           │ unsigned char │ XmAS_IS             │ CSG    │
57       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
58       │XmNstrikethruType      │ XmCStrikethruType      │ unsigned char │ XmAS_IS             │ CSG    │
59       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
60       │XmNtabList             │ XmCTabList             │ XmTabList     │ XmAS_IS             │ CSG    │
61       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
62       │XmNtag                 │ XmCTag                 │ XmStringTag   │ ""                  │ G      │
63       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
64       │XmNunderlineType       │ XmCUnderlineType       │ unsigned char │ XmAS_IS             │ CSG    │
65       ├───────────────────────┼────────────────────────┼───────────────┼─────────────────────┼────────┤
66       └───────────────────────┴────────────────────────┴───────────────┴─────────────────────┴────────┘
67       XmNrenditionBackground
68                 Specifies the background drawing color. A value of XmUNSPECI‐
69                 FIED_PIXEL indicates that the background is not specified for
70                 this rendition.
71
72       XmNfont   Specifies the actual font or fontset to be used by this  ren‐
73                 dition.  The  value  of  this  resource, if set to other than
74                 XmAS_IS, will be used regardless of the settings of the other
75                 font resources. Setting this resource will force XmNloadModel
76                 to be XmLOAD_IMMEDIATE. If this  resource  is  not  initially
77                 set,  then it will be set subsequently by the rendition when‐
78                 ever the font or fontset specified by XmNfontName is  loaded.
79                 If  both  XmNfontName and XmNfont are specified in a resource
80                 file, the XmNfont specification will take precedence.
81
82       XmNfontName
83                 Specifies an X Logical Font Description (XLFD) string,  which
84                 is  interpreted  either as a font name or as a base font name
85                 list. A base font name list is a  comma-separated  and  NULL-
86                 terminated string. A value of XmAS_IS indicates that the font
87                 is not specified for this rendition. If both XmNfontName  and
88                 XmNfont  are specified in a resource file, the XmNfont speci‐
89                 fication will take precedence.
90
91       XmNfontType
92                 Specifies whether the XmNfontName resource refers to  a  font
93                 name   or  to  a  base  font  name  list.  Valid  values  are
94                 XmFONT_IS_FONT and XmFONT_IS_FONTSET.
95
96       XmNrenditionForeground
97                 Specifies the foreground drawing color. A value of XmUNSPECI‐
98                 FIED_PIXEL indicates that the foreground is not specified for
99                 this rendition.
100
101       XmNloadModel
102                 Specifies whether the font or fontset specified  by  XmNfont‐
103                 Name   is   to  be  loaded  when  the  rendition  is  created
104                 (XmLOAD_IMMEDIATE) or only when the font is required to  ren‐
105                 der  an XmString segment (XmLOAD_DEFERRED).  Note that speci‐
106                 fying XmLOAD_IMMEDIATE for XmNloadModel is valid only if XmN‐
107                 fontName  is specified, in which case the specified font will
108                 be loaded on creation, or if XmNfont is specified,  in  which
109                 case  the  font  is  already loaded.  XmLOAD_DEFERRED is only
110                 valid when XmNfontName is specified.
111
112       XmNstrikethruType
113                 Specifies the type of line to be used  to  strike  through  a
114                 text  segment.  Valid  values  are  XmNO_LINE, XmSINGLE_LINE,
115                 XmDOUBLE_LINE,     XmSINGLE_DASHED_LINE,      and      XmDOU‐
116                 BLE_DASHED_LINE.  A  value  of  XmAS_IS  indicates  that  the
117                 strike-through type is not specified for this rendition.
118
119       XmNtabList
120                 Specifies the tab list  to  be  used  in  rendering  compound
121                 strings containing tab components.
122
123       XmNtag    Specifies  the  tag  string to be used in matching the rendi‐
124                 tions with other renditions or with XmStringTag components in
125                 XmStrings.  This  resource must always be specified. That is,
126                 NULL is not a legal value but  the  empty  string  is.   This
127                 resource is automatically set to the value of the tag parame‐
128                 ter in the XmRenditionCreate call.
129
130       XmNunderlineType
131                 Specifies the type of line to be used  to  underline  a  text
132                 segment.   Valid  values are XmNO_LINE, XmSINGLE_LINE, XmDOU‐
133                 BLE_LINE, XmSINGLE_DASHED_LINE, and  XmDOUBLE_DASHED_LINE.  A
134                 value  of  XmAS_IS  indicates  that the underline type is not
135                 specified for this rendition.
136
138       XmRenditionCreate(3),    XmRenditionFree(3),    XmRenditionRetrieve(3),
139       XmRenditionUpdate(3), and XmString(3).
140
141
142
143                                                     XmRendition(library call)
Impressum