man/XFontsOfFontSet.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XFontsOfFontSet __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XFontsOfFontSet, XBaseFontNameListOfFontSet, XLocaleOfFontSet, XContextDependentDrawing, XContextualDrawing, XDirectionalDependentDrawing \- obtain fontset information
 145 .SH SYNTAX
 146 .HP
 147 int XFontsOfFontSet\^(\^XFontSet \fIfont_set\fP\^, XFontStruct
 148 ***\fIfont_struct_list_return\fP\^, char ***\fIfont_name_list_return\fP\^);
 149 .HP
 150 char *XBaseFontNameListOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
 151 .HP
 152 char *XLocaleOfFontSet\^(\^XFontSet \fIfont_set\fP\^);
 153 .HP
 154 Bool XContextDependentDrawing\^(\^XFontSet \fIfont_set\fP\^);
 155 .HP
 156 Bool XContextualDrawing\^(\^XFontSet \fIfont_set\fP\^);
 157 .HP
 158 Bool XDirectionalDependentDrawing\^(\^XFontSet \fIfont_set\fP\^);
 159 .SH ARGUMENTS
 160 .IP \fIfont_set\fP 1i
 161 Specifies the font set.
 162 .IP \fIfont_name_list_return\fP 1i
 163 Returns the list of font names.
 164 .IP \fIfont_struct_list_return\fP 1i
 165 Returns the list of font structs.
 166 .SH DESCRIPTION
 167 The
 168 .ZN XFontsOfFontSet
 169 function returns a list of one or more
 170 .ZN XFontStructs
 171 and font names for the fonts used by the Xmb and Xwc layers
 172 for the given font set.
 173 A list of pointers to the
 174 .ZN XFontStruct
 175 structures is returned to font_struct_list_return.
 176 A list of pointers to null-terminated, fully specified font name strings
 177 in the locale of the font set is returned to font_name_list_return.
 178 The font_name_list order corresponds to the font_struct_list order.
 179 The number of
 180 .ZN XFontStruct
 181 structures and font names is returned as the value of the function.
 182 .LP
 183 Because it is not guaranteed that a given character will be imaged using a
 184 single font glyph,
 185 there is no provision for mapping a character or default string
 186 to the font properties, font ID, or direction hint for the font
 187 for the character.
 188 The client may access the
 189 .ZN XFontStruct
 190 list to obtain these values for all the fonts currently in use.
 191 .LP
 192 Xlib does not guarantee that fonts are loaded from the server
 193 at the creation of an
 194 .ZN XFontSet .
 195 Xlib may choose to cache font data, loading it only as needed to draw text
 196 or compute text dimensions.
 197 Therefore, existence of the per_char metrics in the
 198 .ZN XFontStruct
 199 structures in the
 200 .ZN XFontStructSet
 201 is undefined.
 202 Also, note that all properties in the
 203 .ZN XFontStruct
 204 structures are in the STRING encoding.
 205 .LP
 206 The
 207 .ZN XFontStruct
 208 and font name lists are owned by Xlib
 209 and should not be modified or freed by the client.
 210 They will be freed by a call to
 211 .ZN XFreeFontSet
 212 with the associated
 213 .ZN XFontSet .
 214 Until freed, their contents will not be modified by Xlib.
 215 .LP
 216 The
 217 .ZN XBaseFontNameListOfFontSet
 218 function returns the original base font name list supplied
 219 by the client when the
 220 .ZN XFontSet
 221 was created.
 222 A null-terminated string containing a list of
 223 comma-separated font names is returned
 224 as the value of the function.
 225 White space may appear immediately on either side of separating commas.
 226 .LP
 227 If
 228 .ZN XCreateFontSet
 229 obtained an XLFD name from the font properties for the font specified
 230 by a non-XLFD base name, the
 231 .ZN XBaseFontNameListOfFontSet
 232 function will return the XLFD name instead of the non-XLFD base name.
 233 .LP
 234 The base font name list is owned by Xlib and should not be modified or
 235 freed by the client.
 236 It will be freed by a call to
 237 .ZN XFreeFontSet
 238 with the associated
 239 .ZN XFontSet .
 240 Until freed, its contents will not be modified by Xlib.
 241 .LP
 242 The
 243 .ZN XLocaleOfFontSet
 244 function
 245 returns the name of the locale bound to the specified
 246 .ZN XFontSet ,
 247 as a null-terminated string.
 248 .LP
 249 The returned locale name string is owned by Xlib
 250 and should not be modified or freed by the client.
 251 It may be freed by a call to
 252 .ZN XFreeFontSet
 253 with the associated
 254 .ZN XFontSet .
 255 Until freed, it will not be modified by Xlib.
 256 .LP
 257 The
 258 .ZN XContextDependentDrawing
 259 function returns
 260 .ZN True
 261 if the drawing functions implement implicit text directionality or
 262 if text drawn with the font_set might include context-dependent drawing;
 263 otherwise, it returns
 264 .ZN False .
 265 .LP
 266 The
 267 .ZN XContextualDrawing
 268 function returns
 269 .ZN True
 270 if text drawn with the font set might include context-dependent drawing;
 271 otherwise, it returns
 272 .ZN False .
 273 .LP
 274 The
 275 .ZN XDirectionalDependentDrawing
 276 function returns
 277 .ZN True
 278 if the drawing functions implement implicit text directionality;
 279 otherwise, it returns
 280 .ZN False .
 281 .SH "SEE ALSO"
 282 XCreateFontSet(__libmansuffix__),
 283 XCreateOM(__libmansuffix__),
 284 XCreateOC(__libmansuffix__),
 285 XExtentsOfFontSet(__libmansuffix__),
 286 XFontSetExtents(__libmansuffix__)
 287 .br
 288 \fI\*(xL\fP