Git init
[external/pango1.0.git] / docs / xml / x-fonts.xml
1 <refentry id="pango-X-Fonts-and-Rendering">
2 <refmeta>
3 <refentrytitle role="top_of_page" id="pango-X-Fonts-and-Rendering.top_of_page">Deprecated X font backend</refentrytitle>
4 <manvolnum>3</manvolnum>
5 <refmiscinfo>PANGO Library</refmiscinfo>
6 </refmeta>
7
8 <refnamediv>
9 <refname>Deprecated X font backend</refname>
10 <refpurpose>Font handling and rendering with the deprecated X font backend</refpurpose>
11 </refnamediv>
12
13 <refsynopsisdiv id="pango-X-Fonts-and-Rendering.synopsis" role="synopsis">
14 <title role="synopsis.title">Synopsis</title>
15
16 <synopsis>
17 #define             <link linkend="PANGO-RENDER-TYPE-X--CAPS">PANGO_RENDER_TYPE_X</link>
18 <link linkend="PangoContext">PangoContext</link> *      <link linkend="pango-x-get-context">pango_x_get_context</link>                 (<link linkend="Display">Display</link> *display);
19 <link linkend="void">void</link>                <link linkend="pango-x-context-set-funcs">pango_x_context_set_funcs</link>           (<link linkend="PangoContext">PangoContext</link> *context,
20                                                          <link linkend="PangoGetGCFunc">PangoGetGCFunc</link> get_gc_func,
21                                                          <link linkend="PangoFreeGCFunc">PangoFreeGCFunc</link> free_gc_func);
22 <link linkend="GC--CAPS">GC</link>                  (<link linkend="PangoGetGCFunc">*PangoGetGCFunc</link>)                   (<link linkend="PangoContext">PangoContext</link> *context,
23                                                          <link linkend="PangoColor">PangoColor</link> *color,
24                                                          <link linkend="GC--CAPS">GC</link> base_gc);
25 <link linkend="void">void</link>                (<link linkend="PangoFreeGCFunc">*PangoFreeGCFunc</link>)                  (<link linkend="PangoContext">PangoContext</link> *context,
26                                                          <link linkend="GC--CAPS">GC</link> gc);
27 <link linkend="void">void</link>                <link linkend="pango-x-render">pango_x_render</link>                      (<link linkend="Display">Display</link> *display,
28                                                          <link linkend="Drawable">Drawable</link> d,
29                                                          <link linkend="GC--CAPS">GC</link> gc,
30                                                          <link linkend="PangoFont">PangoFont</link> *font,
31                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
32                                                          <link linkend="gint">gint</link> x,
33                                                          <link linkend="gint">gint</link> y);
34 <link linkend="void">void</link>                <link linkend="pango-x-render-layout-line">pango_x_render_layout_line</link>          (<link linkend="Display">Display</link> *display,
35                                                          <link linkend="Drawable">Drawable</link> drawable,
36                                                          <link linkend="GC--CAPS">GC</link> gc,
37                                                          <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
38                                                          <link linkend="int">int</link> x,
39                                                          <link linkend="int">int</link> y);
40 <link linkend="void">void</link>                <link linkend="pango-x-render-layout">pango_x_render_layout</link>               (<link linkend="Display">Display</link> *display,
41                                                          <link linkend="Drawable">Drawable</link> drawable,
42                                                          <link linkend="GC--CAPS">GC</link> gc,
43                                                          <link linkend="PangoLayout">PangoLayout</link> *layout,
44                                                          <link linkend="int">int</link> x,
45                                                          <link linkend="int">int</link> y);
46 typedef             <link linkend="PangoXSubfont">PangoXSubfont</link>;
47 #define             <link linkend="PANGO-X-MAKE-GLYPH--CAPS">PANGO_X_MAKE_GLYPH</link>                  (subfont,index_)
48 #define             <link linkend="PANGO-X-GLYPH-SUBFONT--CAPS">PANGO_X_GLYPH_SUBFONT</link>               (glyph)
49 #define             <link linkend="PANGO-X-GLYPH-INDEX--CAPS">PANGO_X_GLYPH_INDEX</link>                 (glyph)
50 <link linkend="PangoFont">PangoFont</link> *         <link linkend="pango-x-load-font">pango_x_load_font</link>                   (<link linkend="Display">Display</link> *display,
51                                                          const <link linkend="gchar">gchar</link> *spec);
52 <link linkend="PangoGlyph">PangoGlyph</link>          <link linkend="pango-x-get-unknown-glyph">pango_x_get_unknown_glyph</link>           (<link linkend="PangoFont">PangoFont</link> *font);
53 <link linkend="gboolean">gboolean</link>            <link linkend="pango-x-has-glyph">pango_x_has_glyph</link>                   (<link linkend="PangoFont">PangoFont</link> *font,
54                                                          <link linkend="PangoGlyph">PangoGlyph</link> glyph);
55 <link linkend="int">int</link>                 <link linkend="pango-x-list-subfonts">pango_x_list_subfonts</link>               (<link linkend="PangoFont">PangoFont</link> *font,
56                                                          <link linkend="char">char</link> **charsets,
57                                                          <link linkend="int">int</link> n_charsets,
58                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> **subfont_ids,
59                                                          <link linkend="int">int</link> **subfont_charsets);
60 <link linkend="PangoFontMap">PangoFontMap</link> *      <link linkend="pango-x-font-map-for-display">pango_x_font_map_for_display</link>        (<link linkend="Display">Display</link> *display);
61 <link linkend="void">void</link>                <link linkend="pango-x-shutdown-display">pango_x_shutdown_display</link>            (<link linkend="Display">Display</link> *display);
62 <link linkend="PangoXFontCache">PangoXFontCache</link> *   <link linkend="pango-x-font-map-get-font-cache">pango_x_font_map_get_font_cache</link>     (<link linkend="PangoFontMap">PangoFontMap</link> *font_map);
63 <link linkend="char">char</link> *              <link linkend="pango-x-font-subfont-xlfd">pango_x_font_subfont_xlfd</link>           (<link linkend="PangoFont">PangoFont</link> *font,
64                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> subfont_id);
65 <link linkend="gboolean">gboolean</link>            <link linkend="pango-x-find-first-subfont">pango_x_find_first_subfont</link>          (<link linkend="PangoFont">PangoFont</link> *font,
66                                                          <link linkend="char">char</link> **charsets,
67                                                          <link linkend="int">int</link> n_charsets,
68                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> *rfont);
69 <link linkend="PangoGlyph">PangoGlyph</link>          <link linkend="pango-x-font-get-unknown-glyph">pango_x_font_get_unknown_glyph</link>      (<link linkend="PangoFont">PangoFont</link> *font,
70                                                          <link linkend="gunichar">gunichar</link> wc);
71 <link linkend="gboolean">gboolean</link>            <link linkend="pango-x-apply-ligatures">pango_x_apply_ligatures</link>             (<link linkend="PangoFont">PangoFont</link> *font,
72                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> subfont,
73                                                          <link linkend="gunichar">gunichar</link> **glyphs,
74                                                          <link linkend="int">int</link> *n_glyphs,
75                                                          <link linkend="int">int</link> **clusters);
76 <link linkend="void">void</link>                <link linkend="pango-x-fallback-shape">pango_x_fallback_shape</link>              (<link linkend="PangoFont">PangoFont</link> *font,
77                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
78                                                          const <link linkend="char">char</link> *text,
79                                                          <link linkend="int">int</link> n_chars);
80                     <link linkend="PangoXFontCache">PangoXFontCache</link>;
81 <link linkend="PangoXFontCache">PangoXFontCache</link> *   <link linkend="pango-x-font-cache-new">pango_x_font_cache_new</link>              (<link linkend="Display">Display</link> *display);
82 <link linkend="void">void</link>                <link linkend="pango-x-font-cache-free">pango_x_font_cache_free</link>             (<link linkend="PangoXFontCache">PangoXFontCache</link> *cache);
83 <link linkend="XFontStruct">XFontStruct</link> *       <link linkend="pango-x-font-cache-load">pango_x_font_cache_load</link>             (<link linkend="PangoXFontCache">PangoXFontCache</link> *cache,
84                                                          const <link linkend="char">char</link> *xlfd);
85 <link linkend="void">void</link>                <link linkend="pango-x-font-cache-unload">pango_x_font_cache_unload</link>           (<link linkend="PangoXFontCache">PangoXFontCache</link> *cache,
86                                                          <link linkend="XFontStruct">XFontStruct</link> *fs);
87 </synopsis>
88 </refsynopsisdiv>
89
90
91
92
93
94
95
96
97
98 <refsect1 id="pango-X-Fonts-and-Rendering.description" role="desc">
99 <title role="desc.title">Description</title>
100 <para>
101 The functions and macros in this section are for use with the old
102 X font backend which used server-side bitmap fonts. This font backend
103 is no longer supported, and attempts to use it will produce
104 unpredictable results. Use the <link linkend="pango-Xft-Fonts-and-Rendering">Xft</link>
105 or <link linkend="pango-Cairo-Rendering">Cairo</link> backend instead.
106 </para>
107 </refsect1>
108
109 <refsect1 id="pango-X-Fonts-and-Rendering.details" role="details">
110 <title role="details.title">Details</title>
111 <refsect2 id="PANGO-RENDER-TYPE-X--CAPS" role="macro" condition="deprecated:">
112 <title>PANGO_RENDER_TYPE_X</title>
113 <indexterm zone="PANGO-RENDER-TYPE-X--CAPS" role="deprecated"><primary sortas="PANGO_RENDER_TYPE_X">PANGO_RENDER_TYPE_X</primary></indexterm><programlisting>#define PANGO_RENDER_TYPE_X "PangoRenderX"
114 </programlisting>
115 <warning><para><literal>PANGO_RENDER_TYPE_X</literal> is deprecated and should not be used in newly-written code.</para></warning>
116 <para>
117 A string constant identifying the X renderer. The associated quark (see
118 <link linkend="g-quark-from-string"><function>g_quark_from_string()</function></link>) is used to identify the renderer in <link linkend="pango-find-map"><function>pango_find_map()</function></link>.
119 </para></refsect2>
120 <refsect2 id="pango-x-get-context" role="function" condition="deprecated">
121 <title>pango_x_get_context ()</title>
122 <indexterm zone="pango-x-get-context" role="deprecated"><primary sortas="pango_x_get_context">pango_x_get_context</primary></indexterm><programlisting><link linkend="PangoContext">PangoContext</link> *      pango_x_get_context                 (<link linkend="Display">Display</link> *display);</programlisting>
123 <warning><para><literal>pango_x_get_context</literal> has been deprecated since version 1.22 and should not be used in newly-written code. Use <link linkend="pango-x-font-map-for-display"><function>pango_x_font_map_for_display()</function></link> followed by
124 <link linkend="pango-font-map-create-context"><function>pango_font_map_create_context()</function></link> instead.</para></warning>
125 <para>
126 Retrieves a <link linkend="PangoContext"><type>PangoContext</type></link> appropriate for rendering with X fonts on the
127 given display.</para>
128 <para>
129 </para><variablelist role="params">
130 <varlistentry><term><parameter>display</parameter>&#160;:</term>
131 <listitem><simpara> an X display (As returned by <link linkend="XOpenDisplay"><function>XOpenDisplay()</function></link>.)
132 </simpara></listitem></varlistentry>
133 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="PangoContext"><type>PangoContext</type></link>.
134
135 </simpara></listitem></varlistentry>
136 </variablelist></refsect2>
137 <refsect2 id="pango-x-context-set-funcs" role="function" condition="deprecated:">
138 <title>pango_x_context_set_funcs ()</title>
139 <indexterm zone="pango-x-context-set-funcs" role="deprecated"><primary sortas="pango_x_context_set_funcs">pango_x_context_set_funcs</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_context_set_funcs           (<link linkend="PangoContext">PangoContext</link> *context,
140                                                          <link linkend="PangoGetGCFunc">PangoGetGCFunc</link> get_gc_func,
141                                                          <link linkend="PangoFreeGCFunc">PangoFreeGCFunc</link> free_gc_func);</programlisting>
142 <warning><para><literal>pango_x_context_set_funcs</literal> is deprecated and should not be used in newly-written code.</para></warning>
143 <para>
144 Sets the functions that will be used to get GC's in various colors when
145 rendering layouts with this context.</para>
146 <para>
147 </para><variablelist role="params">
148 <varlistentry><term><parameter>context</parameter>&#160;:</term>
149 <listitem><simpara> a <link linkend="PangoContext"><type>PangoContext</type></link>.
150 </simpara></listitem></varlistentry>
151 <varlistentry><term><parameter>get_gc_func</parameter>&#160;:</term>
152 <listitem><simpara> function called to create a new GC for a given color.
153 </simpara></listitem></varlistentry>
154 <varlistentry><term><parameter>free_gc_func</parameter>&#160;:</term>
155 <listitem><simpara> function called to free a GC created with <parameter>get_gc_func</parameter>.
156 </simpara></listitem></varlistentry>
157 </variablelist></refsect2>
158 <refsect2 id="PangoGetGCFunc" role="function" condition="deprecated:">
159 <title>PangoGetGCFunc ()</title>
160 <indexterm zone="PangoGetGCFunc" role="deprecated"><primary sortas="PangoGetGCFunc">PangoGetGCFunc</primary></indexterm><programlisting><link linkend="GC--CAPS">GC</link>                  (*PangoGetGCFunc)                   (<link linkend="PangoContext">PangoContext</link> *context,
161                                                          <link linkend="PangoColor">PangoColor</link> *color,
162                                                          <link linkend="GC--CAPS">GC</link> base_gc);</programlisting>
163 <warning><para><literal>PangoGetGCFunc</literal> is deprecated and should not be used in newly-written code.</para></warning>
164 <para>
165 Specifies the type of the function used to create a new GC for a given
166 color.
167 </para><variablelist role="params">
168 <varlistentry><term><parameter>context</parameter>&#160;:</term>
169 <listitem><simpara>a <link linkend="PangoContext"><type>PangoContext</type></link>.
170 </simpara></listitem></varlistentry>
171 <varlistentry><term><parameter>color</parameter>&#160;:</term>
172 <listitem><simpara>the color to create a new GC for.
173 </simpara></listitem></varlistentry>
174 <varlistentry><term><parameter>base_gc</parameter>&#160;:</term>
175 <listitem><simpara>the GC to base the new GC on.
176 </simpara></listitem></varlistentry>
177 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the new GC.
178 </simpara></listitem></varlistentry>
179 </variablelist></refsect2>
180 <refsect2 id="PangoFreeGCFunc" role="function" condition="deprecated:">
181 <title>PangoFreeGCFunc ()</title>
182 <indexterm zone="PangoFreeGCFunc" role="deprecated"><primary sortas="PangoFreeGCFunc">PangoFreeGCFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*PangoFreeGCFunc)                  (<link linkend="PangoContext">PangoContext</link> *context,
183                                                          <link linkend="GC--CAPS">GC</link> gc);</programlisting>
184 <warning><para><literal>PangoFreeGCFunc</literal> is deprecated and should not be used in newly-written code.</para></warning>
185 <para>
186 Specifies the type of the function used to free a GC created with
187 the corresponding <link linkend="PangoGetGCFunc"><type>PangoGetGCFunc</type></link> function.
188 </para><variablelist role="params">
189 <varlistentry><term><parameter>context</parameter>&#160;:</term>
190 <listitem><simpara>a <link linkend="PangoContext"><type>PangoContext</type></link>.
191 </simpara></listitem></varlistentry>
192 <varlistentry><term><parameter>gc</parameter>&#160;:</term>
193 <listitem><simpara>the GC to free.
194 </simpara></listitem></varlistentry>
195 </variablelist></refsect2>
196 <refsect2 id="pango-x-render" role="function" condition="deprecated:">
197 <title>pango_x_render ()</title>
198 <indexterm zone="pango-x-render" role="deprecated"><primary sortas="pango_x_render">pango_x_render</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_render                      (<link linkend="Display">Display</link> *display,
199                                                          <link linkend="Drawable">Drawable</link> d,
200                                                          <link linkend="GC--CAPS">GC</link> gc,
201                                                          <link linkend="PangoFont">PangoFont</link> *font,
202                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
203                                                          <link linkend="gint">gint</link> x,
204                                                          <link linkend="gint">gint</link> y);</programlisting>
205 <warning><para><literal>pango_x_render</literal> is deprecated and should not be used in newly-written code.</para></warning>
206 <para>
207 Renders a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> onto an X drawable.</para>
208 <para>
209 </para><variablelist role="params">
210 <varlistentry><term><parameter>display</parameter>&#160;:</term>
211 <listitem><simpara> the X display.
212 </simpara></listitem></varlistentry>
213 <varlistentry><term><parameter>d</parameter>&#160;:</term>
214 <listitem><simpara>       the drawable on which to draw string.
215 </simpara></listitem></varlistentry>
216 <varlistentry><term><parameter>gc</parameter>&#160;:</term>
217 <listitem><simpara>      the graphics context.
218 </simpara></listitem></varlistentry>
219 <varlistentry><term><parameter>font</parameter>&#160;:</term>
220 <listitem><simpara>    the font in which to draw the string.
221 </simpara></listitem></varlistentry>
222 <varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
223 <listitem><simpara>  the glyph string to draw.
224 </simpara></listitem></varlistentry>
225 <varlistentry><term><parameter>x</parameter>&#160;:</term>
226 <listitem><simpara>       the x position of start of string (in pixels).
227 </simpara></listitem></varlistentry>
228 <varlistentry><term><parameter>y</parameter>&#160;:</term>
229 <listitem><simpara>       the y position of baseline (in pixels).
230 </simpara></listitem></varlistentry>
231 </variablelist></refsect2>
232 <refsect2 id="pango-x-render-layout-line" role="function" condition="deprecated:">
233 <title>pango_x_render_layout_line ()</title>
234 <indexterm zone="pango-x-render-layout-line" role="deprecated"><primary sortas="pango_x_render_layout_line">pango_x_render_layout_line</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_render_layout_line          (<link linkend="Display">Display</link> *display,
235                                                          <link linkend="Drawable">Drawable</link> drawable,
236                                                          <link linkend="GC--CAPS">GC</link> gc,
237                                                          <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
238                                                          <link linkend="int">int</link> x,
239                                                          <link linkend="int">int</link> y);</programlisting>
240 <warning><para><literal>pango_x_render_layout_line</literal> is deprecated and should not be used in newly-written code.</para></warning>
241 <para>
242 Renders a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> onto an X drawable.</para>
243 <para>
244 </para><variablelist role="params">
245 <varlistentry><term><parameter>display</parameter>&#160;:</term>
246 <listitem><simpara>   the X display.
247 </simpara></listitem></varlistentry>
248 <varlistentry><term><parameter>drawable</parameter>&#160;:</term>
249 <listitem><simpara>  the drawable on which to draw.
250 </simpara></listitem></varlistentry>
251 <varlistentry><term><parameter>gc</parameter>&#160;:</term>
252 <listitem><simpara>        GC to use for uncolored drawing.
253 </simpara></listitem></varlistentry>
254 <varlistentry><term><parameter>line</parameter>&#160;:</term>
255 <listitem><simpara>      a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>.
256 </simpara></listitem></varlistentry>
257 <varlistentry><term><parameter>x</parameter>&#160;:</term>
258 <listitem><simpara>         the x position of start of string (in pixels).
259 </simpara></listitem></varlistentry>
260 <varlistentry><term><parameter>y</parameter>&#160;:</term>
261 <listitem><simpara>         the y position of baseline (in pixels).
262 </simpara></listitem></varlistentry>
263 </variablelist></refsect2>
264 <refsect2 id="pango-x-render-layout" role="function" condition="deprecated:">
265 <title>pango_x_render_layout ()</title>
266 <indexterm zone="pango-x-render-layout" role="deprecated"><primary sortas="pango_x_render_layout">pango_x_render_layout</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_render_layout               (<link linkend="Display">Display</link> *display,
267                                                          <link linkend="Drawable">Drawable</link> drawable,
268                                                          <link linkend="GC--CAPS">GC</link> gc,
269                                                          <link linkend="PangoLayout">PangoLayout</link> *layout,
270                                                          <link linkend="int">int</link> x,
271                                                          <link linkend="int">int</link> y);</programlisting>
272 <warning><para><literal>pango_x_render_layout</literal> is deprecated and should not be used in newly-written code.</para></warning>
273 <para>
274 Renders a <link linkend="PangoLayout"><type>PangoLayout</type></link> onto an X drawable.</para>
275 <para>
276 </para><variablelist role="params">
277 <varlistentry><term><parameter>display</parameter>&#160;:</term>
278 <listitem><simpara>   the X display.
279 </simpara></listitem></varlistentry>
280 <varlistentry><term><parameter>drawable</parameter>&#160;:</term>
281 <listitem><simpara>  the drawable on which to draw.
282 </simpara></listitem></varlistentry>
283 <varlistentry><term><parameter>gc</parameter>&#160;:</term>
284 <listitem><simpara>        GC to use for uncolored drawing.
285 </simpara></listitem></varlistentry>
286 <varlistentry><term><parameter>layout</parameter>&#160;:</term>
287 <listitem><simpara>    a <link linkend="PangoLayout"><type>PangoLayout</type></link>.
288 </simpara></listitem></varlistentry>
289 <varlistentry><term><parameter>x</parameter>&#160;:</term>
290 <listitem><simpara>         the x position of the left of the layout (in pixels).
291 </simpara></listitem></varlistentry>
292 <varlistentry><term><parameter>y</parameter>&#160;:</term>
293 <listitem><simpara>         the y position of the top of the layout (in pixels).
294 </simpara></listitem></varlistentry>
295 </variablelist></refsect2>
296 <refsect2 id="PangoXSubfont" role="typedef" condition="deprecated:">
297 <title>PangoXSubfont</title>
298 <indexterm zone="PangoXSubfont" role="deprecated"><primary sortas="PangoXSubfont">PangoXSubfont</primary></indexterm><programlisting>typedef guint16 PangoXSubfont;
299 </programlisting>
300 <warning><para><literal>PangoXSubfont</literal> is deprecated and should not be used in newly-written code.</para></warning>
301 <para>
302 The <link linkend="PangoXSubFont"><type>PangoXSubFont</type></link> type is an integer ID that identifies one
303 particular X font within the fonts referenced in a <link linkend="PangoFont"><type>PangoFont</type></link>.
304 </para></refsect2>
305 <refsect2 id="PANGO-X-MAKE-GLYPH--CAPS" role="macro" condition="deprecated:">
306 <title>PANGO_X_MAKE_GLYPH()</title>
307 <indexterm zone="PANGO-X-MAKE-GLYPH--CAPS" role="deprecated"><primary sortas="PANGO_X_MAKE_GLYPH">PANGO_X_MAKE_GLYPH</primary></indexterm><programlisting>#define PANGO_X_MAKE_GLYPH(subfont,index_) ((subfont)&lt;&lt;16 | (index_))
308 </programlisting>
309 <warning><para><literal>PANGO_X_MAKE_GLYPH</literal> is deprecated and should not be used in newly-written code.</para></warning>
310 <para>
311 Make a glyph index from a <link linkend="PangoXSubFont"><type>PangoXSubFont</type></link> index and a index
312 of a character with the corresponding X font.
313 </para><variablelist role="params">
314 <varlistentry><term><parameter>subfont</parameter>&#160;:</term>
315 <listitem><simpara>a <link linkend="PangoXSubfont"><type>PangoXSubfont</type></link> index
316 </simpara></listitem></varlistentry>
317 <varlistentry><term><parameter>index_</parameter>&#160;:</term>
318 <listitem><simpara>the index of a character within an X font.
319 </simpara></listitem></varlistentry>
320 </variablelist></refsect2>
321 <refsect2 id="PANGO-X-GLYPH-SUBFONT--CAPS" role="macro" condition="deprecated:">
322 <title>PANGO_X_GLYPH_SUBFONT()</title>
323 <indexterm zone="PANGO-X-GLYPH-SUBFONT--CAPS" role="deprecated"><primary sortas="PANGO_X_GLYPH_SUBFONT">PANGO_X_GLYPH_SUBFONT</primary></indexterm><programlisting>#define PANGO_X_GLYPH_SUBFONT(glyph) ((glyph)&gt;&gt;16)
324 </programlisting>
325 <warning><para><literal>PANGO_X_GLYPH_SUBFONT</literal> is deprecated and should not be used in newly-written code.</para></warning>
326 <para>
327 Extract the subfont index from a glyph index.
328 </para><variablelist role="params">
329 <varlistentry><term><parameter>glyph</parameter>&#160;:</term>
330 <listitem><simpara>a <link linkend="PangoGlyphIndex"><type>PangoGlyphIndex</type></link>
331 </simpara></listitem></varlistentry>
332 </variablelist></refsect2>
333 <refsect2 id="PANGO-X-GLYPH-INDEX--CAPS" role="macro" condition="deprecated:">
334 <title>PANGO_X_GLYPH_INDEX()</title>
335 <indexterm zone="PANGO-X-GLYPH-INDEX--CAPS" role="deprecated"><primary sortas="PANGO_X_GLYPH_INDEX">PANGO_X_GLYPH_INDEX</primary></indexterm><programlisting>#define PANGO_X_GLYPH_INDEX(glyph) ((glyph) &amp; 0xffff)
336 </programlisting>
337 <warning><para><literal>PANGO_X_GLYPH_INDEX</literal> is deprecated and should not be used in newly-written code.</para></warning>
338 <para>
339 Extract the character index within the X font from a
340 glyph index.
341 </para><variablelist role="params">
342 <varlistentry><term><parameter>glyph</parameter>&#160;:</term>
343 <listitem><simpara>a <link linkend="PangoGlyphIndex"><type>PangoGlyphIndex</type></link>
344 </simpara></listitem></varlistentry>
345 </variablelist></refsect2>
346 <refsect2 id="pango-x-load-font" role="function" condition="deprecated:">
347 <title>pango_x_load_font ()</title>
348 <indexterm zone="pango-x-load-font" role="deprecated"><primary sortas="pango_x_load_font">pango_x_load_font</primary></indexterm><programlisting><link linkend="PangoFont">PangoFont</link> *         pango_x_load_font                   (<link linkend="Display">Display</link> *display,
349                                                          const <link linkend="gchar">gchar</link> *spec);</programlisting>
350 <warning><para><literal>pango_x_load_font</literal> is deprecated and should not be used in newly-written code.</para></warning>
351 <para>
352 Loads up a logical font based on a "fontset" style text
353 specification. This is not remotely useful (Pango API's generally
354 work in terms of <link linkend="PangoFontDescription"><type>PangoFontDescription</type></link>) and the result may not
355 work correctly in all circumstances. Use of this function should
356 be avoided.</para>
357 <para>
358 </para><variablelist role="params">
359 <varlistentry><term><parameter>display</parameter>&#160;:</term>
360 <listitem><simpara> the X display.
361 </simpara></listitem></varlistentry>
362 <varlistentry><term><parameter>spec</parameter>&#160;:</term>
363 <listitem><simpara>    a comma-separated list of XLFD's.
364 </simpara></listitem></varlistentry>
365 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="PangoFont"><type>PangoFont</type></link>.
366 </simpara></listitem></varlistentry>
367 </variablelist></refsect2>
368 <refsect2 id="pango-x-get-unknown-glyph" role="function" condition="deprecated:">
369 <title>pango_x_get_unknown_glyph ()</title>
370 <indexterm zone="pango-x-get-unknown-glyph" role="deprecated"><primary sortas="pango_x_get_unknown_glyph">pango_x_get_unknown_glyph</primary></indexterm><programlisting><link linkend="PangoGlyph">PangoGlyph</link>          pango_x_get_unknown_glyph           (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
371 <warning><para><literal>pango_x_get_unknown_glyph</literal> is deprecated and should not be used in newly-written code.</para></warning>
372 <para>
373 Returns the index of a glyph suitable for drawing unknown characters;
374 you should generally use <link linkend="PANGO-GET-UNKNOWN-GLYPH--CAPS"><function>PANGO_GET_UNKNOWN_GLYPH()</function></link> instead,
375 since that may return a glyph that provides a better representation
376 of a particular char. (E.g., by showing hex digits, or a glyph
377 representative of a certain Unicode range.)</para>
378 <para>
379 </para><variablelist role="params">
380 <varlistentry><term><parameter>font</parameter>&#160;:</term>
381 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
382 </simpara></listitem></varlistentry>
383 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a glyph index into <parameter>font</parameter>.
384 </simpara></listitem></varlistentry>
385 </variablelist></refsect2>
386 <refsect2 id="pango-x-has-glyph" role="function" condition="deprecated:">
387 <title>pango_x_has_glyph ()</title>
388 <indexterm zone="pango-x-has-glyph" role="deprecated"><primary sortas="pango_x_has_glyph">pango_x_has_glyph</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_x_has_glyph                   (<link linkend="PangoFont">PangoFont</link> *font,
389                                                          <link linkend="PangoGlyph">PangoGlyph</link> glyph);</programlisting>
390 <warning><para><literal>pango_x_has_glyph</literal> is deprecated and should not be used in newly-written code.</para></warning>
391 <para>
392 Checks if the given glyph is present in a X font.</para>
393 <para>
394 </para><variablelist role="params">
395 <varlistentry><term><parameter>font</parameter>&#160;:</term>
396 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> which must be from the X backend.
397 </simpara></listitem></varlistentry>
398 <varlistentry><term><parameter>glyph</parameter>&#160;:</term>
399 <listitem><simpara> the index of a glyph in the font. (Formed
400         using the <link linkend="PANGO-X-MAKE-GLYPH--CAPS"><type>PANGO_X_MAKE_GLYPH</type></link> macro)
401 </simpara></listitem></varlistentry>
402 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the glyph is present.
403 </simpara></listitem></varlistentry>
404 </variablelist></refsect2>
405 <refsect2 id="pango-x-list-subfonts" role="function" condition="deprecated:">
406 <title>pango_x_list_subfonts ()</title>
407 <indexterm zone="pango-x-list-subfonts" role="deprecated"><primary sortas="pango_x_list_subfonts">pango_x_list_subfonts</primary></indexterm><programlisting><link linkend="int">int</link>                 pango_x_list_subfonts               (<link linkend="PangoFont">PangoFont</link> *font,
408                                                          <link linkend="char">char</link> **charsets,
409                                                          <link linkend="int">int</link> n_charsets,
410                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> **subfont_ids,
411                                                          <link linkend="int">int</link> **subfont_charsets);</programlisting>
412 <warning><para><literal>pango_x_list_subfonts</literal> is deprecated and should not be used in newly-written code.</para></warning>
413 <para>
414 Lists the subfonts of a given font. The result is ordered first by charset,
415 and then within each charset, by the order of fonts in the font specification.</para>
416 <para>
417 </para><variablelist role="params">
418 <varlistentry><term><parameter>font</parameter>&#160;:</term>
419 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
420 </simpara></listitem></varlistentry>
421 <varlistentry><term><parameter>charsets</parameter>&#160;:</term>
422 <listitem><simpara> the charsets to list subfonts for.
423 </simpara></listitem></varlistentry>
424 <varlistentry><term><parameter>n_charsets</parameter>&#160;:</term>
425 <listitem><simpara> the number of charsets in <parameter>charsets</parameter>.
426 </simpara></listitem></varlistentry>
427 <varlistentry><term><parameter>subfont_ids</parameter>&#160;:</term>
428 <listitem><simpara> location to store a pointer to an array of subfont IDs for each found subfont;
429               the result must be freed using <link linkend="g-free"><function>g_free()</function></link>.
430 </simpara></listitem></varlistentry>
431 <varlistentry><term><parameter>subfont_charsets</parameter>&#160;:</term>
432 <listitem><simpara> location to store a pointer to an array of subfont IDs for each found subfont;
433               the result must be freed using <link linkend="g-free"><function>g_free()</function></link>.
434 </simpara></listitem></varlistentry>
435 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> length of the arrays stored in <parameter>subfont_ids</parameter> and
436 <parameter>subfont_charsets</parameter>.
437 </simpara></listitem></varlistentry>
438 </variablelist></refsect2>
439 <refsect2 id="pango-x-font-map-for-display" role="function" condition="deprecated:">
440 <title>pango_x_font_map_for_display ()</title>
441 <indexterm zone="pango-x-font-map-for-display" role="deprecated"><primary sortas="pango_x_font_map_for_display">pango_x_font_map_for_display</primary></indexterm><programlisting><link linkend="PangoFontMap">PangoFontMap</link> *      pango_x_font_map_for_display        (<link linkend="Display">Display</link> *display);</programlisting>
442 <warning><para><literal>pango_x_font_map_for_display</literal> is deprecated and should not be used in newly-written code.</para></warning>
443 <para>
444 Returns a <link linkend="PangoXFontMap"><type>PangoXFontMap</type></link> for <parameter>display</parameter>. Font maps are cached and should
445 not be freed. If the font map for a display is no longer needed, it can
446 be released with <link linkend="pango-x-shutdown-display"><function>pango_x_shutdown_display()</function></link>.</para>
447 <para>
448 </para><variablelist role="params">
449 <varlistentry><term><parameter>display</parameter>&#160;:</term>
450 <listitem><simpara> an X <link linkend="Display"><type>Display</type></link>.
451 </simpara></listitem></varlistentry>
452 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="PangoXFontMap"><type>PangoXFontMap</type></link> for <parameter>display</parameter>.
453 </simpara></listitem></varlistentry>
454 </variablelist></refsect2>
455 <refsect2 id="pango-x-shutdown-display" role="function" condition="deprecated:">
456 <title>pango_x_shutdown_display ()</title>
457 <indexterm zone="pango-x-shutdown-display" role="deprecated"><primary sortas="pango_x_shutdown_display">pango_x_shutdown_display</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_shutdown_display            (<link linkend="Display">Display</link> *display);</programlisting>
458 <warning><para><literal>pango_x_shutdown_display</literal> is deprecated and should not be used in newly-written code.</para></warning>
459 <para>
460 Free cached resources for the given X display structure.</para>
461 <para>
462 </para><variablelist role="params">
463 <varlistentry><term><parameter>display</parameter>&#160;:</term>
464 <listitem><simpara> an X <link linkend="Display"><type>Display</type></link>
465 </simpara></listitem></varlistentry>
466 </variablelist></refsect2>
467 <refsect2 id="pango-x-font-map-get-font-cache" role="function" condition="deprecated:">
468 <title>pango_x_font_map_get_font_cache ()</title>
469 <indexterm zone="pango-x-font-map-get-font-cache" role="deprecated"><primary sortas="pango_x_font_map_get_font_cache">pango_x_font_map_get_font_cache</primary></indexterm><programlisting><link linkend="PangoXFontCache">PangoXFontCache</link> *   pango_x_font_map_get_font_cache     (<link linkend="PangoFontMap">PangoFontMap</link> *font_map);</programlisting>
470 <warning><para><literal>pango_x_font_map_get_font_cache</literal> is deprecated and should not be used in newly-written code.</para></warning>
471 <para>
472 Obtains the font cache associated with the given font map.</para>
473 <para>
474 </para><variablelist role="params">
475 <varlistentry><term><parameter>font_map</parameter>&#160;:</term>
476 <listitem><simpara> a <link linkend="PangoXFontMap"><type>PangoXFontMap</type></link>.
477 </simpara></listitem></varlistentry>
478 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link> of <parameter>font_map</parameter>.
479 </simpara></listitem></varlistentry>
480 </variablelist></refsect2>
481 <refsect2 id="pango-x-font-subfont-xlfd" role="function" condition="deprecated:">
482 <title>pango_x_font_subfont_xlfd ()</title>
483 <indexterm zone="pango-x-font-subfont-xlfd" role="deprecated"><primary sortas="pango_x_font_subfont_xlfd">pango_x_font_subfont_xlfd</primary></indexterm><programlisting><link linkend="char">char</link> *              pango_x_font_subfont_xlfd           (<link linkend="PangoFont">PangoFont</link> *font,
484                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> subfont_id);</programlisting>
485 <warning><para><literal>pango_x_font_subfont_xlfd</literal> is deprecated and should not be used in newly-written code.</para></warning>
486 <para>
487 Determines the X Logical Font Description for the specified
488 subfont.</para>
489 <para>
490 </para><variablelist role="params">
491 <varlistentry><term><parameter>font</parameter>&#160;:</term>
492 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> which must be from the X backend.
493 </simpara></listitem></varlistentry>
494 <varlistentry><term><parameter>subfont_id</parameter>&#160;:</term>
495 <listitem><simpara> the id of a subfont within the font.
496 </simpara></listitem></varlistentry>
497 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A newly-allocated string containing the XLFD for the
498 subfont. This string must be freed with <link linkend="g-free"><function>g_free()</function></link>.
499 </simpara></listitem></varlistentry>
500 </variablelist></refsect2>
501 <refsect2 id="pango-x-find-first-subfont" role="function" condition="deprecated:">
502 <title>pango_x_find_first_subfont ()</title>
503 <indexterm zone="pango-x-find-first-subfont" role="deprecated"><primary sortas="pango_x_find_first_subfont">pango_x_find_first_subfont</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_x_find_first_subfont          (<link linkend="PangoFont">PangoFont</link> *font,
504                                                          <link linkend="char">char</link> **charsets,
505                                                          <link linkend="int">int</link> n_charsets,
506                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> *rfont);</programlisting>
507 <warning><para><literal>pango_x_find_first_subfont</literal> is deprecated and should not be used in newly-written code.</para></warning>
508 <para>
509 Looks for subfonts with the <parameter>charset</parameter> charset,
510 in <parameter>font</parameter>, and puts the first one in *<parameter>rfont</parameter>.</para>
511 <para>
512 </para><variablelist role="params">
513 <varlistentry><term><parameter>font</parameter>&#160;:</term>
514 <listitem><simpara> A <link linkend="PangoFont"><type>PangoFont</type></link>.
515 </simpara></listitem></varlistentry>
516 <varlistentry><term><parameter>charsets</parameter>&#160;:</term>
517 <listitem><simpara> An array of charsets.
518 </simpara></listitem></varlistentry>
519 <varlistentry><term><parameter>n_charsets</parameter>&#160;:</term>
520 <listitem><simpara> The number of charsets in <parameter>charsets</parameter>.
521 </simpara></listitem></varlistentry>
522 <varlistentry><term><parameter>rfont</parameter>&#160;:</term>
523 <listitem><simpara> A pointer to a <link linkend="PangoXSubfont"><type>PangoXSubfont</type></link>.
524 </simpara></listitem></varlistentry>
525 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if *<parameter>rfont</parameter> now contains a font.
526 </simpara></listitem></varlistentry>
527 </variablelist></refsect2>
528 <refsect2 id="pango-x-font-get-unknown-glyph" role="function" condition="deprecated:">
529 <title>pango_x_font_get_unknown_glyph ()</title>
530 <indexterm zone="pango-x-font-get-unknown-glyph" role="deprecated"><primary sortas="pango_x_font_get_unknown_glyph">pango_x_font_get_unknown_glyph</primary></indexterm><programlisting><link linkend="PangoGlyph">PangoGlyph</link>          pango_x_font_get_unknown_glyph      (<link linkend="PangoFont">PangoFont</link> *font,
531                                                          <link linkend="gunichar">gunichar</link> wc);</programlisting>
532 <warning><para><literal>pango_x_font_get_unknown_glyph</literal> is deprecated and should not be used in newly-written code.</para></warning>
533 <para>
534 Returns the index of a glyph suitable for drawing <parameter>wc</parameter> as an
535 unknown character.
536 </para>
537 <para>
538 Use <link linkend="PANGO-GET-UNKNOWN-GLYPH--CAPS"><function>PANGO_GET_UNKNOWN_GLYPH()</function></link> instead.</para>
539 <para>
540 </para><variablelist role="params">
541 <varlistentry><term><parameter>font</parameter>&#160;:</term>
542 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
543 </simpara></listitem></varlistentry>
544 <varlistentry><term><parameter>wc</parameter>&#160;:</term>
545 <listitem><simpara> the Unicode character for which a glyph is needed.
546 </simpara></listitem></varlistentry>
547 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a glyph index into <parameter>font</parameter>.
548 </simpara></listitem></varlistentry>
549 </variablelist></refsect2>
550 <refsect2 id="pango-x-apply-ligatures" role="function" condition="deprecated:">
551 <title>pango_x_apply_ligatures ()</title>
552 <indexterm zone="pango-x-apply-ligatures" role="deprecated"><primary sortas="pango_x_apply_ligatures">pango_x_apply_ligatures</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_x_apply_ligatures             (<link linkend="PangoFont">PangoFont</link> *font,
553                                                          <link linkend="PangoXSubfont">PangoXSubfont</link> subfont,
554                                                          <link linkend="gunichar">gunichar</link> **glyphs,
555                                                          <link linkend="int">int</link> *n_glyphs,
556                                                          <link linkend="int">int</link> **clusters);</programlisting>
557 <warning><para><literal>pango_x_apply_ligatures</literal> is deprecated and should not be used in newly-written code.</para></warning>
558 <para>
559 Previously did subfont-specific ligation. Now a no-op.</para>
560 <para>
561 </para><variablelist role="params">
562 <varlistentry><term><parameter>font</parameter>&#160;:</term>
563 <listitem><simpara> unused
564 </simpara></listitem></varlistentry>
565 <varlistentry><term><parameter>subfont</parameter>&#160;:</term>
566 <listitem><simpara> unused
567 </simpara></listitem></varlistentry>
568 <varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
569 <listitem><simpara> unused
570 </simpara></listitem></varlistentry>
571 <varlistentry><term><parameter>n_glyphs</parameter>&#160;:</term>
572 <listitem><simpara> unused
573 </simpara></listitem></varlistentry>
574 <varlistentry><term><parameter>clusters</parameter>&#160;:</term>
575 <listitem><simpara> unused
576 </simpara></listitem></varlistentry>
577 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>, always.
578 </simpara></listitem></varlistentry>
579 </variablelist></refsect2>
580 <refsect2 id="pango-x-fallback-shape" role="function" condition="deprecated:">
581 <title>pango_x_fallback_shape ()</title>
582 <indexterm zone="pango-x-fallback-shape" role="deprecated"><primary sortas="pango_x_fallback_shape">pango_x_fallback_shape</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_fallback_shape              (<link linkend="PangoFont">PangoFont</link> *font,
583                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
584                                                          const <link linkend="char">char</link> *text,
585                                                          <link linkend="int">int</link> n_chars);</programlisting>
586 <warning><para><literal>pango_x_fallback_shape</literal> is deprecated and should not be used in newly-written code.</para></warning>
587 <para>
588 This is a simple fallback shaper, that can be used
589 if no subfont that supports a given script is found.
590 For every character in <parameter>text</parameter>, it puts the unknown glyph.</para>
591 <para>
592 </para><variablelist role="params">
593 <varlistentry><term><parameter>font</parameter>&#160;:</term>
594 <listitem><simpara> A <link linkend="PangoFont"><type>PangoFont</type></link>.
595 </simpara></listitem></varlistentry>
596 <varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
597 <listitem><simpara> A pointer to a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link>.
598 </simpara></listitem></varlistentry>
599 <varlistentry><term><parameter>text</parameter>&#160;:</term>
600 <listitem><simpara> UTF-8 string.
601 </simpara></listitem></varlistentry>
602 <varlistentry><term><parameter>n_chars</parameter>&#160;:</term>
603 <listitem><simpara> Number of UTF-8 seqs in <parameter>text</parameter>.
604 </simpara></listitem></varlistentry>
605 </variablelist></refsect2>
606 <refsect2 id="PangoXFontCache" role="struct" condition="deprecated:">
607 <title>PangoXFontCache</title>
608 <indexterm zone="PangoXFontCache" role="deprecated"><primary sortas="PangoXFontCache">PangoXFontCache</primary></indexterm><programlisting>typedef struct _PangoXFontCache PangoXFontCache;</programlisting>
609 <warning><para><literal>PangoXFontCache</literal> is deprecated and should not be used in newly-written code.</para></warning>
610 <para>
611 A <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link> caches
612 <type>XFontStructs</type> for a single display by their XLFD name.
613 </para></refsect2>
614 <refsect2 id="pango-x-font-cache-new" role="function" condition="deprecated:">
615 <title>pango_x_font_cache_new ()</title>
616 <indexterm zone="pango-x-font-cache-new" role="deprecated"><primary sortas="pango_x_font_cache_new">pango_x_font_cache_new</primary></indexterm><programlisting><link linkend="PangoXFontCache">PangoXFontCache</link> *   pango_x_font_cache_new              (<link linkend="Display">Display</link> *display);</programlisting>
617 <warning><para><literal>pango_x_font_cache_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
618 <para>
619 Creates a font cache for the specified display.</para>
620 <para>
621 </para><variablelist role="params">
622 <varlistentry><term><parameter>display</parameter>&#160;:</term>
623 <listitem><simpara> an X display.
624 </simpara></listitem></varlistentry>
625 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly allocated <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link>, which should be
626               freed with <link linkend="pango-x-font-cache-free"><function>pango_x_font_cache_free()</function></link>.
627 </simpara></listitem></varlistentry>
628 </variablelist></refsect2>
629 <refsect2 id="pango-x-font-cache-free" role="function" condition="deprecated:">
630 <title>pango_x_font_cache_free ()</title>
631 <indexterm zone="pango-x-font-cache-free" role="deprecated"><primary sortas="pango_x_font_cache_free">pango_x_font_cache_free</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_font_cache_free             (<link linkend="PangoXFontCache">PangoXFontCache</link> *cache);</programlisting>
632 <warning><para><literal>pango_x_font_cache_free</literal> is deprecated and should not be used in newly-written code.</para></warning>
633 <para>
634 Frees a <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link> and all associated memory. All fonts loaded
635 through this font cache will be freed along with the cache.</para>
636 <para>
637 </para><variablelist role="params">
638 <varlistentry><term><parameter>cache</parameter>&#160;:</term>
639 <listitem><simpara> a <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link>
640 </simpara></listitem></varlistentry>
641 </variablelist></refsect2>
642 <refsect2 id="pango-x-font-cache-load" role="function" condition="deprecated:">
643 <title>pango_x_font_cache_load ()</title>
644 <indexterm zone="pango-x-font-cache-load" role="deprecated"><primary sortas="pango_x_font_cache_load">pango_x_font_cache_load</primary></indexterm><programlisting><link linkend="XFontStruct">XFontStruct</link> *       pango_x_font_cache_load             (<link linkend="PangoXFontCache">PangoXFontCache</link> *cache,
645                                                          const <link linkend="char">char</link> *xlfd);</programlisting>
646 <warning><para><literal>pango_x_font_cache_load</literal> is deprecated and should not be used in newly-written code.</para></warning>
647 <para>
648 Loads a <link linkend="XFontStruct"><type>XFontStruct</type></link> from a X Logical Font Description. The
649 result may be newly loaded, or it may have been previously
650 stored.</para>
651 <para>
652 </para><variablelist role="params">
653 <varlistentry><term><parameter>cache</parameter>&#160;:</term>
654 <listitem><simpara> a <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link>
655 </simpara></listitem></varlistentry>
656 <varlistentry><term><parameter>xlfd</parameter>&#160;:</term>
657 <listitem><simpara> the X Logical Font Description to load.
658 </simpara></listitem></varlistentry>
659 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The font structure, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the font could
660 not be loaded. In order to free this structure, you must call
661 <link linkend="pango-x-font-cache-unload"><function>pango_x_font_cache_unload()</function></link>.
662 </simpara></listitem></varlistentry>
663 </variablelist></refsect2>
664 <refsect2 id="pango-x-font-cache-unload" role="function" condition="deprecated:">
665 <title>pango_x_font_cache_unload ()</title>
666 <indexterm zone="pango-x-font-cache-unload" role="deprecated"><primary sortas="pango_x_font_cache_unload">pango_x_font_cache_unload</primary></indexterm><programlisting><link linkend="void">void</link>                pango_x_font_cache_unload           (<link linkend="PangoXFontCache">PangoXFontCache</link> *cache,
667                                                          <link linkend="XFontStruct">XFontStruct</link> *fs);</programlisting>
668 <warning><para><literal>pango_x_font_cache_unload</literal> is deprecated and should not be used in newly-written code.</para></warning>
669 <para>
670 Frees a font structure previously loaded with <link linkend="pango-x-font-cache-load"><function>pango_x_font_cache_load()</function></link>.</para>
671 <para>
672 </para><variablelist role="params">
673 <varlistentry><term><parameter>cache</parameter>&#160;:</term>
674 <listitem><simpara> a <link linkend="PangoXFontCache"><type>PangoXFontCache</type></link>
675 </simpara></listitem></varlistentry>
676 <varlistentry><term><parameter>fs</parameter>&#160;:</term>
677 <listitem><simpara> the font structure to unload
678 </simpara></listitem></varlistentry>
679 </variablelist></refsect2>
680
681 </refsect1>
682
683
684
685
686 </refentry>