Git init
[external/pango1.0.git] / docs / tmpl / x-fonts.sgml
1 <!-- ##### SECTION Title ##### -->
2 Deprecated X font backend
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Font handling and rendering with the deprecated X font backend
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 The functions and macros in this section are for use with the old
10 X font backend which used server-side bitmap fonts. This font backend
11 is no longer supported, and attempts to use it will produce
12 unpredictable results. Use the <link linkend="pango-Xft-Fonts-and-Rendering">Xft</link>
13 or <link linkend="pango-Cairo-Rendering">Cairo</link> backend instead.
14 </para>
15
16 <!-- ##### SECTION See_Also ##### -->
17 <para>
18
19 </para>
20
21 <!-- ##### SECTION Stability_Level ##### -->
22
23
24 <!-- ##### MACRO PANGO_RENDER_TYPE_X ##### -->
25 <para>
26 A string constant identifying the X renderer. The associated quark (see 
27 g_quark_from_string()) is used to identify the renderer in pango_find_map(). 
28 </para>
29
30
31
32 <!-- ##### FUNCTION pango_x_get_context ##### -->
33 <para>
34
35 </para>
36
37 @display: 
38 @Returns: 
39
40
41 <!-- ##### FUNCTION pango_x_context_set_funcs ##### -->
42 <para>
43
44 </para>
45
46 @context: 
47 @get_gc_func: 
48 @free_gc_func: 
49
50
51 <!-- ##### USER_FUNCTION PangoGetGCFunc ##### -->
52 <para>
53 Specifies the type of the function used to create a new GC for a given
54 color. 
55 </para>
56
57 @context: a #PangoContext.
58 @color: the color to create a new GC for.
59 @base_gc: the GC to base the new GC on.
60 @Returns: the new GC.
61
62
63 <!-- ##### USER_FUNCTION PangoFreeGCFunc ##### -->
64 <para>
65 Specifies the type of the function used to free a GC created with 
66 the corresponding #PangoGetGCFunc function.
67 </para>
68
69 @context: a #PangoContext.
70 @gc: the GC to free.
71
72
73 <!-- ##### FUNCTION pango_x_render ##### -->
74 <para>
75
76 </para>
77
78 @display: 
79 @d: 
80 @gc: 
81 @font: 
82 @glyphs: 
83 @x: 
84 @y: 
85
86
87 <!-- ##### FUNCTION pango_x_render_layout_line ##### -->
88 <para>
89
90 </para>
91
92 @display: 
93 @drawable: 
94 @gc: 
95 @line: 
96 @x: 
97 @y: 
98
99
100 <!-- ##### FUNCTION pango_x_render_layout ##### -->
101 <para>
102
103 </para>
104
105 @display: 
106 @drawable: 
107 @gc: 
108 @layout: 
109 @x: 
110 @y: 
111
112
113 <!-- ##### TYPEDEF PangoXSubfont ##### -->
114 <para>
115 The #PangoXSubFont type is an integer ID that identifies one
116 particular X font within the fonts referenced in a #PangoFont.
117 </para>
118
119
120 <!-- ##### MACRO PANGO_X_MAKE_GLYPH ##### -->
121 <para>
122 Make a glyph index from a #PangoXSubFont index and a index
123 of a character with the corresponding X font.
124 </para>
125
126 @subfont: a #PangoXSubfont index
127 @index_: the index of a character within an X font.
128
129
130 <!-- ##### MACRO PANGO_X_GLYPH_SUBFONT ##### -->
131 <para>
132 Extract the subfont index from a glyph index.
133 </para>
134
135 @glyph: a #PangoGlyphIndex
136
137
138 <!-- ##### MACRO PANGO_X_GLYPH_INDEX ##### -->
139 <para>
140 Extract the character index within the X font from a
141 glyph index.
142 </para>
143
144 @glyph: a #PangoGlyphIndex
145
146
147 <!-- ##### FUNCTION pango_x_load_font ##### -->
148 <para>
149
150 </para>
151
152 @display: 
153 @spec: 
154 @Returns: 
155
156
157 <!-- ##### FUNCTION pango_x_get_unknown_glyph ##### -->
158 <para>
159
160 </para>
161
162 @font: 
163 @Returns: 
164
165
166 <!-- ##### FUNCTION pango_x_has_glyph ##### -->
167 <para>
168
169 </para>
170
171 @font: 
172 @glyph: 
173 @Returns: 
174
175
176 <!-- ##### FUNCTION pango_x_list_subfonts ##### -->
177 <para>
178
179 </para>
180
181 @font: 
182 @charsets: 
183 @n_charsets: 
184 @subfont_ids: 
185 @subfont_charsets: 
186 @Returns: 
187
188
189 <!-- ##### FUNCTION pango_x_font_map_for_display ##### -->
190 <para>
191
192 </para>
193
194 @display: 
195 @Returns: 
196
197
198 <!-- ##### FUNCTION pango_x_shutdown_display ##### -->
199 <para>
200
201 </para>
202
203 @display: 
204
205
206 <!-- ##### FUNCTION pango_x_font_map_get_font_cache ##### -->
207 <para>
208
209 </para>
210
211 @font_map: 
212 @Returns: 
213
214
215 <!-- ##### FUNCTION pango_x_font_subfont_xlfd ##### -->
216 <para>
217
218 </para>
219
220 @font: 
221 @subfont_id: 
222 @Returns: 
223
224
225 <!-- ##### FUNCTION pango_x_find_first_subfont ##### -->
226 <para>
227
228 </para>
229
230 @font: 
231 @charsets: 
232 @n_charsets: 
233 @rfont: 
234 @Returns: 
235
236
237 <!-- ##### FUNCTION pango_x_font_get_unknown_glyph ##### -->
238 <para>
239
240 </para>
241
242 @font: 
243 @wc: 
244 @Returns: 
245
246
247 <!-- ##### FUNCTION pango_x_apply_ligatures ##### -->
248 <para>
249
250 </para>
251
252 @font: 
253 @subfont: 
254 @glyphs: 
255 @n_glyphs: 
256 @clusters: 
257 @Returns: 
258
259
260 <!-- ##### FUNCTION pango_x_fallback_shape ##### -->
261 <para>
262
263 </para>
264
265 @font: 
266 @glyphs: 
267 @text: 
268 @n_chars: 
269
270
271 <!-- ##### STRUCT PangoXFontCache ##### -->
272 <para>
273 A #PangoXFontCache caches
274 <type>XFontStructs</type> for a single display by their XLFD name. 
275 </para>
276
277
278 <!-- ##### FUNCTION pango_x_font_cache_new ##### -->
279 <para>
280
281 </para>
282
283 @display: 
284 @Returns: 
285
286
287 <!-- ##### FUNCTION pango_x_font_cache_free ##### -->
288 <para>
289
290 </para>
291
292 @cache: 
293
294
295 <!-- ##### FUNCTION pango_x_font_cache_load ##### -->
296 <para>
297
298 </para>
299
300 @cache: 
301 @xlfd: 
302 @Returns: 
303
304
305 <!-- ##### FUNCTION pango_x_font_cache_unload ##### -->
306 <para>
307
308 </para>
309
310 @cache: 
311 @fs: 
312
313