sync
[gir-1.1] / PangoXft-1.0.gir
1 <?xml version="1.0"?>
2 <!-- This file was automatically generated from C sources - DO NOT EDIT!
3 To affect the contents of this file, edit the original C definitions,
4 and/or use gtk-doc annotations.  -->
5 <repository version="1.1"
6             xmlns="http://www.gtk.org/introspection/core/1.0"
7             xmlns:c="http://www.gtk.org/introspection/c/1.0"
8             xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
9   <include name="GLib" version="2.0"/>
10   <include name="GObject" version="2.0"/>
11   <include name="Pango" version="1.0"/>
12   <include name="PangoFT2" version="1.0"/>
13   <include name="cairo" version="1.0"/>
14   <include name="fontconfig" version="2.0"/>
15   <include name="freetype2" version="2.0"/>
16   <include name="xft" version="2.0"/>
17   <include name="xlib" version="2.0"/>
18   <package name="freetype2"/>
19   <package name="gobject-2.0"/>
20   <namespace name="PangoXft"
21              version="1.0"
22              shared-library="libpangoxft-1.0.so.0"
23              c:prefix="PangoXft">
24     <class name="Font"
25            c:type="PangoXftFont"
26            parent="PangoFT2.PangoFcFont"
27            glib:type-name="PangoXftFont"
28            glib:get-type="pango_xft_font_get_type">
29       <field name="parent_instance">
30         <type name="PangoFT2.PangoFcFont" c:type="PangoFcFont"/>
31       </field>
32       <field name="xft_font">
33         <type name="xft.Font" c:type="XftFont*"/>
34       </field>
35       <field name="mini_font">
36         <type name="Pango.Font" c:type="PangoFont*"/>
37       </field>
38       <field name="mini_width">
39         <type name="uint" c:type="guint"/>
40       </field>
41       <field name="mini_height">
42         <type name="uint" c:type="guint"/>
43       </field>
44       <field name="mini_pad">
45         <type name="uint" c:type="guint"/>
46       </field>
47       <field name="glyph_info">
48         <type name="GLib.HashTable" c:type="GHashTable*"/>
49       </field>
50     </class>
51     <class name="FontMap"
52            c:type="PangoXftFontMap"
53            parent="PangoFT2.PangoFcFontMap"
54            glib:type-name="PangoXftFontMap"
55            glib:get-type="pango_xft_font_map_get_type">
56     </class>
57     <constant name="PANGO_RENDER_TYPE_XFT" value="PangoRenderXft">
58       <type name="utf8"/>
59     </constant>
60     <class name="Renderer"
61            c:type="PangoXftRenderer"
62            parent="Pango.Renderer"
63            glib:type-name="PangoXftRenderer"
64            glib:get-type="pango_xft_renderer_get_type"
65            glib:type-struct="RendererClass">
66       <constructor name="new"
67                    c:identifier="pango_xft_renderer_new"
68                    version="1.8">
69         <doc xml:whitespace="preserve">Create a new #PangoXftRenderer to allow rendering Pango objects
70 with the Xft library. You must call pango_xft_renderer_set_draw() before
71 using the renderer.
72 be freed with g_object_unref().</doc>
73         <return-value transfer-ownership="full">
74           <doc xml:whitespace="preserve">the newly created #PangoXftRenderer, which should</doc>
75           <type name="Renderer" c:type="PangoRenderer*"/>
76         </return-value>
77         <parameters>
78           <parameter name="display" transfer-ownership="none">
79             <doc xml:whitespace="preserve">an X display</doc>
80             <type name="xlib.Display" c:type="Display*"/>
81           </parameter>
82           <parameter name="screen" transfer-ownership="none">
83             <doc xml:whitespace="preserve">the index of the screen for @display to which rendering will be done</doc>
84             <type name="int" c:type="int"/>
85           </parameter>
86         </parameters>
87       </constructor>
88       <virtual-method name="composite_trapezoids">
89         <return-value transfer-ownership="none">
90           <type name="none" c:type="void"/>
91         </return-value>
92         <parameters>
93           <parameter name="part" transfer-ownership="none">
94             <type name="Pango.RenderPart" c:type="PangoRenderPart"/>
95           </parameter>
96           <parameter name="trapezoids" transfer-ownership="none">
97             <type name="xlib.XTrapezoid" c:type="XTrapezoid*"/>
98           </parameter>
99           <parameter name="n_trapezoids" transfer-ownership="none">
100             <type name="int" c:type="int"/>
101           </parameter>
102         </parameters>
103       </virtual-method>
104       <virtual-method name="composite_glyphs">
105         <return-value transfer-ownership="none">
106           <type name="none" c:type="void"/>
107         </return-value>
108         <parameters>
109           <parameter name="xft_font" transfer-ownership="none">
110             <type name="xft.Font" c:type="XftFont*"/>
111           </parameter>
112           <parameter name="glyphs" transfer-ownership="none">
113             <type name="xft.GlyphSpec" c:type="XftGlyphSpec*"/>
114           </parameter>
115           <parameter name="n_glyphs" transfer-ownership="none">
116             <type name="int" c:type="int"/>
117           </parameter>
118         </parameters>
119       </virtual-method>
120       <method name="set_draw"
121               c:identifier="pango_xft_renderer_set_draw"
122               version="1.8">
123         <doc xml:whitespace="preserve">Sets the #XftDraw object that the renderer is drawing to.
124 The renderer must not be currently active.</doc>
125         <return-value transfer-ownership="none">
126           <type name="none" c:type="void"/>
127         </return-value>
128         <parameters>
129           <parameter name="draw" transfer-ownership="none">
130             <doc xml:whitespace="preserve">a #XftDraw</doc>
131             <type name="xft.Draw" c:type="XftDraw*"/>
132           </parameter>
133         </parameters>
134       </method>
135       <method name="set_default_color"
136               c:identifier="pango_xft_renderer_set_default_color"
137               version="1.8">
138         <doc xml:whitespace="preserve">Sets the default foreground color for a #XftRenderer.</doc>
139         <return-value transfer-ownership="none">
140           <type name="none" c:type="void"/>
141         </return-value>
142         <parameters>
143           <parameter name="default_color" transfer-ownership="none">
144             <doc xml:whitespace="preserve">the default foreground color</doc>
145             <type name="Pango.Color" c:type="PangoColor*"/>
146           </parameter>
147         </parameters>
148       </method>
149       <property name="display"
150                 readable="0"
151                 writable="1"
152                 construct-only="1"
153                 transfer-ownership="none">
154         <type name="any" c:type="gpointer"/>
155       </property>
156       <property name="screen"
157                 readable="0"
158                 writable="1"
159                 construct-only="1"
160                 transfer-ownership="none">
161         <type name="int" c:type="gint"/>
162       </property>
163       <field name="parent_instance">
164         <type name="Pango.Renderer" c:type="PangoRenderer"/>
165       </field>
166       <field name="display">
167         <type name="xlib.Display" c:type="Display*"/>
168       </field>
169       <field name="screen">
170         <type name="int" c:type="int"/>
171       </field>
172       <field name="draw">
173         <type name="xft.Draw" c:type="XftDraw*"/>
174       </field>
175       <field name="priv">
176         <type name="RendererPrivate" c:type="PangoXftRendererPrivate*"/>
177       </field>
178     </class>
179     <record name="RendererClass"
180             c:type="PangoXftRendererClass"
181             glib:is-gtype-struct-for="Renderer">
182       <field name="parent_class">
183         <type name="Pango.RendererClass" c:type="PangoRendererClass"/>
184       </field>
185       <field name="composite_trapezoids">
186         <callback name="composite_trapezoids" c:type="composite_trapezoids">
187           <return-value transfer-ownership="none">
188             <type name="none" c:type="void"/>
189           </return-value>
190           <parameters>
191             <parameter name="xftrenderer" transfer-ownership="none">
192               <type name="Renderer" c:type="PangoXftRenderer*"/>
193             </parameter>
194             <parameter name="part" transfer-ownership="none">
195               <type name="Pango.RenderPart" c:type="PangoRenderPart"/>
196             </parameter>
197             <parameter name="trapezoids" transfer-ownership="none">
198               <type name="xlib.XTrapezoid" c:type="XTrapezoid*"/>
199             </parameter>
200             <parameter name="n_trapezoids" transfer-ownership="none">
201               <type name="int" c:type="int"/>
202             </parameter>
203           </parameters>
204         </callback>
205       </field>
206       <field name="composite_glyphs">
207         <callback name="composite_glyphs" c:type="composite_glyphs">
208           <return-value transfer-ownership="none">
209             <type name="none" c:type="void"/>
210           </return-value>
211           <parameters>
212             <parameter name="xftrenderer" transfer-ownership="none">
213               <type name="Renderer" c:type="PangoXftRenderer*"/>
214             </parameter>
215             <parameter name="xft_font" transfer-ownership="none">
216               <type name="xft.Font" c:type="XftFont*"/>
217             </parameter>
218             <parameter name="glyphs" transfer-ownership="none">
219               <type name="xft.GlyphSpec" c:type="XftGlyphSpec*"/>
220             </parameter>
221             <parameter name="n_glyphs" transfer-ownership="none">
222               <type name="int" c:type="int"/>
223             </parameter>
224           </parameters>
225         </callback>
226       </field>
227     </record>
228     <record name="RendererPrivate" c:type="PangoXftRendererPrivate">
229     </record>
230     <callback name="SubstituteFunc" c:type="PangoXftSubstituteFunc">
231       <return-value transfer-ownership="none">
232         <type name="none" c:type="void"/>
233       </return-value>
234       <parameters>
235         <parameter name="pattern" transfer-ownership="none">
236           <type name="fontconfig.Pattern" c:type="FcPattern*"/>
237         </parameter>
238         <parameter name="data" transfer-ownership="none">
239           <type name="any" c:type="gpointer"/>
240         </parameter>
241       </parameters>
242     </callback>
243     <function name="get_context"
244               c:identifier="pango_xft_get_context"
245               deprecated="Use pango_xft_get_font_map() followed by"
246               deprecated-version="1.22">
247       <doc xml:whitespace="preserve">Retrieves a #PangoContext appropriate for rendering with
248 Xft fonts on the given screen of the given display.
249 pango_font_map_create_context() instead.</doc>
250       <return-value transfer-ownership="full">
251         <doc xml:whitespace="preserve">the new #PangoContext.</doc>
252         <type name="Pango.Context" c:type="PangoContext*"/>
253       </return-value>
254       <parameters>
255         <parameter name="display" transfer-ownership="none">
256           <doc xml:whitespace="preserve">an X display.</doc>
257           <type name="xlib.Display" c:type="Display*"/>
258         </parameter>
259         <parameter name="screen" transfer-ownership="none">
260           <doc xml:whitespace="preserve">an X screen.</doc>
261           <type name="int" c:type="int"/>
262         </parameter>
263       </parameters>
264     </function>
265     <function name="get_font_map"
266               c:identifier="pango_xft_get_font_map"
267               version="1.2">
268       <doc xml:whitespace="preserve">Returns the #PangoXftFontmap for the given display and screen.
269 The fontmap is owned by Pango and will be valid until
270 the display is closed.</doc>
271       <return-value transfer-ownership="full">
272         <doc xml:whitespace="preserve">a #PangoFontMap object, owned by Pango.</doc>
273         <type name="Pango.FontMap" c:type="PangoFontMap*"/>
274       </return-value>
275       <parameters>
276         <parameter name="display" transfer-ownership="none">
277           <doc xml:whitespace="preserve">an X display</doc>
278           <type name="xlib.Display" c:type="Display*"/>
279         </parameter>
280         <parameter name="screen" transfer-ownership="none">
281           <doc xml:whitespace="preserve">the screen number of a screen within @display</doc>
282           <type name="int" c:type="int"/>
283         </parameter>
284       </parameters>
285     </function>
286     <function name="picture_render" c:identifier="pango_xft_picture_render">
287       <doc xml:whitespace="preserve">Renders a #PangoGlyphString onto an Xrender &lt;type&gt;Picture&lt;/type&gt; object.</doc>
288       <return-value transfer-ownership="none">
289         <type name="none" c:type="void"/>
290       </return-value>
291       <parameters>
292         <parameter name="display" transfer-ownership="none">
293           <doc xml:whitespace="preserve">an X display</doc>
294           <type name="xlib.Display" c:type="Display*"/>
295         </parameter>
296         <parameter name="src_picture" transfer-ownership="none">
297           <doc xml:whitespace="preserve">the source picture to draw the string with</doc>
298           <type name="xlib.Picture" c:type="Picture"/>
299         </parameter>
300         <parameter name="dest_picture" transfer-ownership="none">
301           <doc xml:whitespace="preserve">the destination picture to draw the string onto</doc>
302           <type name="xlib.Picture" c:type="Picture"/>
303         </parameter>
304         <parameter name="font" transfer-ownership="none">
305           <doc xml:whitespace="preserve">the font in which to draw the string</doc>
306           <type name="Pango.Font" c:type="PangoFont*"/>
307         </parameter>
308         <parameter name="glyphs" transfer-ownership="none">
309           <doc xml:whitespace="preserve">the glyph string to draw</doc>
310           <type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
311         </parameter>
312         <parameter name="x" transfer-ownership="none">
313           <doc xml:whitespace="preserve">the x position of start of string (in pixels)</doc>
314           <type name="int" c:type="gint"/>
315         </parameter>
316         <parameter name="y" transfer-ownership="none">
317           <doc xml:whitespace="preserve">the y position of baseline (in pixels)</doc>
318           <type name="int" c:type="gint"/>
319         </parameter>
320       </parameters>
321     </function>
322     <function name="render" c:identifier="pango_xft_render">
323       <doc xml:whitespace="preserve">Renders a #PangoGlyphString onto an &lt;type&gt;XftDraw&lt;/type&gt; object wrapping an X drawable.</doc>
324       <return-value transfer-ownership="none">
325         <type name="none" c:type="void"/>
326       </return-value>
327       <parameters>
328         <parameter name="draw" transfer-ownership="none">
329           <doc xml:whitespace="preserve">the &lt;type&gt;XftDraw&lt;/type&gt; object.</doc>
330           <type name="xft.Draw" c:type="XftDraw*"/>
331         </parameter>
332         <parameter name="color" transfer-ownership="none">
333           <doc xml:whitespace="preserve">the color in which to draw the string</doc>
334           <type name="xft.Color" c:type="XftColor*"/>
335         </parameter>
336         <parameter name="font" transfer-ownership="none">
337           <doc xml:whitespace="preserve">the font in which to draw the string</doc>
338           <type name="Pango.Font" c:type="PangoFont*"/>
339         </parameter>
340         <parameter name="glyphs" transfer-ownership="none">
341           <doc xml:whitespace="preserve">the glyph string to draw</doc>
342           <type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
343         </parameter>
344         <parameter name="x" transfer-ownership="none">
345           <doc xml:whitespace="preserve">the x position of start of string (in pixels)</doc>
346           <type name="int" c:type="gint"/>
347         </parameter>
348         <parameter name="y" transfer-ownership="none">
349           <doc xml:whitespace="preserve">the y position of baseline (in pixels)</doc>
350           <type name="int" c:type="gint"/>
351         </parameter>
352       </parameters>
353     </function>
354     <function name="render_layout"
355               c:identifier="pango_xft_render_layout"
356               version="1.8">
357       <doc xml:whitespace="preserve">Render a #PangoLayout onto a #XftDraw</doc>
358       <return-value transfer-ownership="none">
359         <type name="none" c:type="void"/>
360       </return-value>
361       <parameters>
362         <parameter name="draw" transfer-ownership="none">
363           <doc xml:whitespace="preserve">an #XftDraw</doc>
364           <type name="xft.Draw" c:type="XftDraw*"/>
365         </parameter>
366         <parameter name="color" transfer-ownership="none">
367           <doc xml:whitespace="preserve">the foreground color in which to draw the layout (may be overridden by color attributes)</doc>
368           <type name="xft.Color" c:type="XftColor*"/>
369         </parameter>
370         <parameter name="layout" transfer-ownership="none">
371           <doc xml:whitespace="preserve">a #PangoLayout</doc>
372           <type name="Pango.Layout" c:type="PangoLayout*"/>
373         </parameter>
374         <parameter name="x" transfer-ownership="none">
375           <doc xml:whitespace="preserve">the X position of the left of the layout (in Pango units)</doc>
376           <type name="int" c:type="int"/>
377         </parameter>
378         <parameter name="y" transfer-ownership="none">
379           <doc xml:whitespace="preserve">the Y position of the top of the layout (in Pango units)</doc>
380           <type name="int" c:type="int"/>
381         </parameter>
382       </parameters>
383     </function>
384     <function name="render_layout_line"
385               c:identifier="pango_xft_render_layout_line"
386               version="1.8">
387       <doc xml:whitespace="preserve">Render a #PangoLayoutLine onto a #XftDraw</doc>
388       <return-value transfer-ownership="none">
389         <type name="none" c:type="void"/>
390       </return-value>
391       <parameters>
392         <parameter name="draw" transfer-ownership="none">
393           <doc xml:whitespace="preserve">an #XftDraw</doc>
394           <type name="xft.Draw" c:type="XftDraw*"/>
395         </parameter>
396         <parameter name="color" transfer-ownership="none">
397           <doc xml:whitespace="preserve">the foreground color in which to draw the layout line (may be overridden by color attributes)</doc>
398           <type name="xft.Color" c:type="XftColor*"/>
399         </parameter>
400         <parameter name="line" transfer-ownership="none">
401           <doc xml:whitespace="preserve">a #PangoLayoutLine</doc>
402           <type name="Pango.LayoutLine" c:type="PangoLayoutLine*"/>
403         </parameter>
404         <parameter name="x" transfer-ownership="none">
405           <doc xml:whitespace="preserve">the x position of start of string (in Pango units)</doc>
406           <type name="int" c:type="int"/>
407         </parameter>
408         <parameter name="y" transfer-ownership="none">
409           <doc xml:whitespace="preserve">the y position of baseline (in Pango units)</doc>
410           <type name="int" c:type="int"/>
411         </parameter>
412       </parameters>
413     </function>
414     <function name="render_transformed"
415               c:identifier="pango_xft_render_transformed"
416               version="1.8">
417       <doc xml:whitespace="preserve">Renders a #PangoGlyphString onto a #XftDraw, possibly
418 transforming the layed-out coordinates through a transformation
419 matrix. Note that the transformation matrix for @font is not
420 changed, so to produce correct rendering results, the @font
421 must have been loaded using a #PangoContext with an identical
422 transformation matrix to that passed in to this function.</doc>
423       <return-value transfer-ownership="none">
424         <type name="none" c:type="void"/>
425       </return-value>
426       <parameters>
427         <parameter name="draw" transfer-ownership="none">
428           <doc xml:whitespace="preserve">an #XftDraw</doc>
429           <type name="xft.Draw" c:type="XftDraw*"/>
430         </parameter>
431         <parameter name="color" transfer-ownership="none">
432           <doc xml:whitespace="preserve">the color in which to draw the glyphs</doc>
433           <type name="xft.Color" c:type="XftColor*"/>
434         </parameter>
435         <parameter name="matrix" transfer-ownership="none">
436           <doc xml:whitespace="preserve">a #PangoMatrix, or %NULL to use an identity transformation</doc>
437           <type name="Pango.Matrix" c:type="PangoMatrix*"/>
438         </parameter>
439         <parameter name="font" transfer-ownership="none">
440           <doc xml:whitespace="preserve">the font in which to draw the string</doc>
441           <type name="Pango.Font" c:type="PangoFont*"/>
442         </parameter>
443         <parameter name="glyphs" transfer-ownership="none">
444           <doc xml:whitespace="preserve">the glyph string to draw</doc>
445           <type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
446         </parameter>
447         <parameter name="x" transfer-ownership="none">
448           <doc xml:whitespace="preserve">the x position of the start of the string (in Pango units in user space coordinates)</doc>
449           <type name="int" c:type="int"/>
450         </parameter>
451         <parameter name="y" transfer-ownership="none">
452           <doc xml:whitespace="preserve">the y position of the baseline (in Pango units in user space coordinates)</doc>
453           <type name="int" c:type="int"/>
454         </parameter>
455       </parameters>
456     </function>
457     <function name="set_default_substitute"
458               c:identifier="pango_xft_set_default_substitute"
459               version="1.2">
460       <doc xml:whitespace="preserve">Sets a function that will be called to do final configuration
461 substitution on a #FcPattern before it is used to load
462 the font. This function can be used to do things like set
463 hinting and antialiasing options.</doc>
464       <return-value transfer-ownership="none">
465         <type name="none" c:type="void"/>
466       </return-value>
467       <parameters>
468         <parameter name="display" transfer-ownership="none">
469           <doc xml:whitespace="preserve">an X Display</doc>
470           <type name="xlib.Display" c:type="Display*"/>
471         </parameter>
472         <parameter name="screen" transfer-ownership="none">
473           <doc xml:whitespace="preserve">the screen number of a screen within @display</doc>
474           <type name="int" c:type="int"/>
475         </parameter>
476         <parameter name="func"
477                    transfer-ownership="none"
478                    scope="notified"
479                    closure="3"
480                    destroy="4">
481           <doc xml:whitespace="preserve">function to call to to do final config tweaking on #FcPattern objects.</doc>
482           <type name="SubstituteFunc" c:type="PangoXftSubstituteFunc"/>
483         </parameter>
484         <parameter name="data" transfer-ownership="none">
485           <doc xml:whitespace="preserve">data to pass to @func</doc>
486           <type name="any" c:type="gpointer"/>
487         </parameter>
488         <parameter name="notify" transfer-ownership="none" scope="call">
489           <doc xml:whitespace="preserve">function to call when @data is no longer used.</doc>
490           <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
491         </parameter>
492       </parameters>
493     </function>
494     <function name="shutdown_display"
495               c:identifier="pango_xft_shutdown_display"
496               version="1.2">
497       <doc xml:whitespace="preserve">Release any resources that have been cached for the
498 combination of @display and @screen. Note that when the
499 X display is closed, resources are released automatically,
500 without needing to call this function.</doc>
501       <return-value transfer-ownership="none">
502         <type name="none" c:type="void"/>
503       </return-value>
504       <parameters>
505         <parameter name="display" transfer-ownership="none">
506           <doc xml:whitespace="preserve">an X display</doc>
507           <type name="xlib.Display" c:type="Display*"/>
508         </parameter>
509         <parameter name="screen" transfer-ownership="none">
510           <doc xml:whitespace="preserve">the screen number of a screen within @display</doc>
511           <type name="int" c:type="int"/>
512         </parameter>
513       </parameters>
514     </function>
515     <function name="substitute_changed"
516               c:identifier="pango_xft_substitute_changed"
517               version="1.2">
518       <doc xml:whitespace="preserve">Call this function any time the results of the
519 default substitution function set with
520 pango_xft_set_default_substitute() change.
521 That is, if your substitution function will return different
522 results for the same input pattern, you must call this function.</doc>
523       <return-value transfer-ownership="none">
524         <type name="none" c:type="void"/>
525       </return-value>
526       <parameters>
527         <parameter name="display" transfer-ownership="none">
528           <doc xml:whitespace="preserve">an X Display</doc>
529           <type name="xlib.Display" c:type="Display*"/>
530         </parameter>
531         <parameter name="screen" transfer-ownership="none">
532           <doc xml:whitespace="preserve">the screen number of a screen within @display</doc>
533           <type name="int" c:type="int"/>
534         </parameter>
535       </parameters>
536     </function>
537   </namespace>
538 </repository>