PangoCairo-1.0.gir 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834
  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.2"
  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="GObject" version="2.0"/>
  10. <include name="Pango" version="1.0"/>
  11. <include name="PangoFT2" version="1.0"/>
  12. <include name="cairo" version="1.0"/>
  13. <package name="pangocairo"/>
  14. <c:include name="pango/pangocairo.h"/>
  15. <namespace name="PangoCairo"
  16. version="1.0"
  17. shared-library="libpango-1.0.so.0,libpangocairo-1.0.so.0,libpango-1.0.so.0,libpangoft2-1.0.so.0"
  18. c:identifier-prefixes="PangoCairo"
  19. c:symbol-prefixes="pango_cairo">
  20. <class name="FcFontMap"
  21. c:symbol-prefix="fc_font_map"
  22. c:type="PangoCairoFcFontMap"
  23. parent="Pango.FontMap"
  24. glib:type-name="PangoCairoFcFontMap"
  25. glib:get-type="pango_cairo_fc_font_map_get_type">
  26. <implements name="FontMap"/>
  27. <field name="parent_instance" introspectable="0">
  28. <type c:type="PangoFcFontMap"/>
  29. </field>
  30. <field name="serial">
  31. <type name="guint" c:type="guint"/>
  32. </field>
  33. <field name="dpi">
  34. <type name="gdouble" c:type="double"/>
  35. </field>
  36. <field name="library">
  37. <type name="freetype2.Library" c:type="FT_Library"/>
  38. </field>
  39. </class>
  40. <interface name="Font"
  41. c:symbol-prefix="font"
  42. c:type="PangoCairoFont"
  43. version="1.18"
  44. glib:type-name="PangoCairoFont"
  45. glib:get-type="pango_cairo_font_get_type">
  46. <doc xml:space="preserve">#PangoCairoFont is an interface exported by fonts for
  47. use with Cairo. The actual type of the font will depend
  48. on the particular font technology Cairo was compiled to use.</doc>
  49. <prerequisite name="Pango.Font"/>
  50. <method name="get_scaled_font"
  51. c:identifier="pango_cairo_font_get_scaled_font"
  52. version="1.18">
  53. <doc xml:space="preserve">Gets the #cairo_scaled_font_t used by @font.
  54. The scaled font can be referenced and kept using
  55. cairo_scaled_font_reference().</doc>
  56. <return-value transfer-ownership="full" nullable="1">
  57. <doc xml:space="preserve">the #cairo_scaled_font_t used by @font,
  58. or %NULL if @font is %NULL.</doc>
  59. <type name="cairo.ScaledFont" c:type="cairo_scaled_font_t*"/>
  60. </return-value>
  61. <parameters>
  62. <instance-parameter name="font" transfer-ownership="none">
  63. <doc xml:space="preserve">a #PangoFont from a #PangoCairoFontMap</doc>
  64. <type name="Font" c:type="PangoCairoFont*"/>
  65. </instance-parameter>
  66. </parameters>
  67. </method>
  68. </interface>
  69. <interface name="FontMap"
  70. c:symbol-prefix="font_map"
  71. c:type="PangoCairoFontMap"
  72. version="1.10"
  73. glib:type-name="PangoCairoFontMap"
  74. glib:get-type="pango_cairo_font_map_get_type">
  75. <doc xml:space="preserve">#PangoCairoFontMap is an interface exported by font maps for
  76. use with Cairo. The actual type of the font map will depend
  77. on the particular font technology Cairo was compiled to use.</doc>
  78. <prerequisite name="Pango.FontMap"/>
  79. <function name="get_default"
  80. c:identifier="pango_cairo_font_map_get_default"
  81. version="1.10">
  82. <doc xml:space="preserve">Gets a default #PangoCairoFontMap to use with Cairo.
  83. Note that the type of the returned object will depend
  84. on the particular font backend Cairo was compiled to use;
  85. You generally should only use the #PangoFontMap and
  86. #PangoCairoFontMap interfaces on the returned object.
  87. The default Cairo fontmap can be changed by using
  88. pango_cairo_font_map_set_default(). This can be used to
  89. change the Cairo font backend that the default fontmap
  90. uses for example.
  91. Note that since Pango 1.32.6, the default fontmap is per-thread.
  92. Each thread gets its own default fontmap. In this way,
  93. PangoCairo can be used safely from multiple threads.</doc>
  94. <return-value transfer-ownership="none">
  95. <doc xml:space="preserve">the default PangoCairo fontmap
  96. for the current thread. This object is owned by Pango and must not be freed.</doc>
  97. <type name="Pango.FontMap" c:type="PangoFontMap*"/>
  98. </return-value>
  99. </function>
  100. <function name="new"
  101. c:identifier="pango_cairo_font_map_new"
  102. version="1.10">
  103. <doc xml:space="preserve">Creates a new #PangoCairoFontMap object; a fontmap is used
  104. to cache information about available fonts, and holds
  105. certain global parameters such as the resolution.
  106. In most cases, you can use pango_cairo_font_map_get_default()
  107. instead.
  108. Note that the type of the returned object will depend
  109. on the particular font backend Cairo was compiled to use;
  110. You generally should only use the #PangoFontMap and
  111. #PangoCairoFontMap interfaces on the returned object.
  112. You can override the type of backend returned by using an
  113. environment variable %PANGOCAIRO_BACKEND. Supported types,
  114. based on your build, are fc (fontconfig), win32, and coretext.
  115. If requested type is not available, NULL is returned. Ie.
  116. this is only useful for testing, when at least two backends
  117. are compiled in.</doc>
  118. <return-value transfer-ownership="full">
  119. <doc xml:space="preserve">the newly allocated #PangoFontMap,
  120. which should be freed with g_object_unref().</doc>
  121. <type name="Pango.FontMap" c:type="PangoFontMap*"/>
  122. </return-value>
  123. </function>
  124. <function name="new_for_font_type"
  125. c:identifier="pango_cairo_font_map_new_for_font_type"
  126. version="1.18">
  127. <doc xml:space="preserve">Creates a new #PangoCairoFontMap object of the type suitable
  128. to be used with cairo font backend of type @fonttype.
  129. In most cases one should simply use @pango_cairo_font_map_new(),
  130. or in fact in most of those cases, just use
  131. @pango_cairo_font_map_get_default().</doc>
  132. <return-value transfer-ownership="full" nullable="1">
  133. <doc xml:space="preserve">the newly allocated
  134. #PangoFontMap of suitable type which should be freed
  135. with g_object_unref(), or %NULL if the requested
  136. cairo font backend is not supported / compiled in.</doc>
  137. <type name="Pango.FontMap" c:type="PangoFontMap*"/>
  138. </return-value>
  139. <parameters>
  140. <parameter name="fonttype" transfer-ownership="none">
  141. <doc xml:space="preserve">desired #cairo_font_type_t</doc>
  142. <type name="cairo.FontType" c:type="cairo_font_type_t"/>
  143. </parameter>
  144. </parameters>
  145. </function>
  146. <method name="create_context"
  147. c:identifier="pango_cairo_font_map_create_context"
  148. version="1.10"
  149. introspectable="0"
  150. deprecated="1"
  151. deprecated-version="1.22">
  152. <doc xml:space="preserve">Create a #PangoContext for the given fontmap.</doc>
  153. <doc-deprecated xml:space="preserve">Use pango_font_map_create_context() instead.</doc-deprecated>
  154. <return-value>
  155. <doc xml:space="preserve">the newly created context; free with g_object_unref().</doc>
  156. <type name="Pango.Context" c:type="PangoContext*"/>
  157. </return-value>
  158. <parameters>
  159. <instance-parameter name="fontmap" transfer-ownership="none">
  160. <doc xml:space="preserve">a #PangoCairoFontMap</doc>
  161. <type name="FontMap" c:type="PangoCairoFontMap*"/>
  162. </instance-parameter>
  163. </parameters>
  164. </method>
  165. <method name="get_font_type"
  166. c:identifier="pango_cairo_font_map_get_font_type"
  167. version="1.18">
  168. <doc xml:space="preserve">Gets the type of Cairo font backend that @fontmap uses.</doc>
  169. <return-value transfer-ownership="full">
  170. <doc xml:space="preserve">the #cairo_font_type_t cairo font backend type</doc>
  171. <type name="cairo.FontType" c:type="cairo_font_type_t"/>
  172. </return-value>
  173. <parameters>
  174. <instance-parameter name="fontmap" transfer-ownership="none">
  175. <doc xml:space="preserve">a #PangoCairoFontMap</doc>
  176. <type name="FontMap" c:type="PangoCairoFontMap*"/>
  177. </instance-parameter>
  178. </parameters>
  179. </method>
  180. <method name="get_resolution"
  181. c:identifier="pango_cairo_font_map_get_resolution"
  182. version="1.10">
  183. <doc xml:space="preserve">Gets the resolution for the fontmap. See pango_cairo_font_map_set_resolution()</doc>
  184. <return-value transfer-ownership="none">
  185. <doc xml:space="preserve">the resolution in "dots per inch"</doc>
  186. <type name="gdouble" c:type="double"/>
  187. </return-value>
  188. <parameters>
  189. <instance-parameter name="fontmap" transfer-ownership="none">
  190. <doc xml:space="preserve">a #PangoCairoFontMap</doc>
  191. <type name="FontMap" c:type="PangoCairoFontMap*"/>
  192. </instance-parameter>
  193. </parameters>
  194. </method>
  195. <method name="set_default"
  196. c:identifier="pango_cairo_font_map_set_default"
  197. version="1.22">
  198. <doc xml:space="preserve">Sets a default #PangoCairoFontMap to use with Cairo.
  199. This can be used to change the Cairo font backend that the
  200. default fontmap uses for example. The old default font map
  201. is unreffed and the new font map referenced.
  202. Note that since Pango 1.32.6, the default fontmap is per-thread.
  203. This function only changes the default fontmap for
  204. the current thread. Default fontmaps of exisiting threads
  205. are not changed. Default fontmaps of any new threads will
  206. still be created using pango_cairo_font_map_new().
  207. A value of %NULL for @fontmap will cause the current default
  208. font map to be released and a new default font
  209. map to be created on demand, using pango_cairo_font_map_new().</doc>
  210. <return-value transfer-ownership="none">
  211. <type name="none" c:type="void"/>
  212. </return-value>
  213. <parameters>
  214. <instance-parameter name="fontmap"
  215. transfer-ownership="none"
  216. nullable="1"
  217. allow-none="1">
  218. <doc xml:space="preserve">The new default font map, or %NULL</doc>
  219. <type name="FontMap" c:type="PangoCairoFontMap*"/>
  220. </instance-parameter>
  221. </parameters>
  222. </method>
  223. <method name="set_resolution"
  224. c:identifier="pango_cairo_font_map_set_resolution"
  225. version="1.10">
  226. <doc xml:space="preserve">Sets the resolution for the fontmap. This is a scale factor between
  227. points specified in a #PangoFontDescription and Cairo units. The
  228. default value is 96, meaning that a 10 point font will be 13
  229. units high. (10 * 96. / 72. = 13.3).</doc>
  230. <return-value transfer-ownership="none">
  231. <type name="none" c:type="void"/>
  232. </return-value>
  233. <parameters>
  234. <instance-parameter name="fontmap" transfer-ownership="none">
  235. <doc xml:space="preserve">a #PangoCairoFontMap</doc>
  236. <type name="FontMap" c:type="PangoCairoFontMap*"/>
  237. </instance-parameter>
  238. <parameter name="dpi" transfer-ownership="none">
  239. <doc xml:space="preserve">the resolution in "dots per inch". (Physical inches aren't actually
  240. involved; the terminology is conventional.)</doc>
  241. <type name="gdouble" c:type="double"/>
  242. </parameter>
  243. </parameters>
  244. </method>
  245. </interface>
  246. <callback name="ShapeRendererFunc" c:type="PangoCairoShapeRendererFunc">
  247. <doc xml:space="preserve">Function type for rendering attributes of type %PANGO_ATTR_SHAPE
  248. with Pango's Cairo renderer.</doc>
  249. <return-value transfer-ownership="none">
  250. <type name="none" c:type="void"/>
  251. </return-value>
  252. <parameters>
  253. <parameter name="cr" transfer-ownership="none">
  254. <doc xml:space="preserve">a Cairo context with current point set to where the shape should
  255. be rendered</doc>
  256. <type name="cairo.Context" c:type="cairo_t*"/>
  257. </parameter>
  258. <parameter name="attr" transfer-ownership="none">
  259. <doc xml:space="preserve">the %PANGO_ATTR_SHAPE to render</doc>
  260. <type name="Pango.AttrShape" c:type="PangoAttrShape*"/>
  261. </parameter>
  262. <parameter name="do_path" transfer-ownership="none">
  263. <doc xml:space="preserve">whether only the shape path should be appended to current
  264. path of @cr and no filling/stroking done. This will be set
  265. to %TRUE when called from pango_cairo_layout_path() and
  266. pango_cairo_layout_line_path() rendering functions.</doc>
  267. <type name="gboolean" c:type="gboolean"/>
  268. </parameter>
  269. <parameter name="data"
  270. transfer-ownership="none"
  271. nullable="1"
  272. allow-none="1">
  273. <doc xml:space="preserve">user data passed to pango_cairo_context_set_shape_renderer()</doc>
  274. <type name="gpointer" c:type="gpointer"/>
  275. </parameter>
  276. </parameters>
  277. </callback>
  278. <function name="context_get_font_options"
  279. c:identifier="pango_cairo_context_get_font_options"
  280. version="1.10">
  281. <doc xml:space="preserve">Retrieves any font rendering options previously set with
  282. pango_cairo_context_set_font_options(). This function does not report options
  283. that are derived from the target surface by pango_cairo_update_context()</doc>
  284. <return-value transfer-ownership="none" nullable="1">
  285. <doc xml:space="preserve">the font options previously set on the
  286. context, or %NULL if no options have been set. This value is
  287. owned by the context and must not be modified or freed.</doc>
  288. <type name="cairo.FontOptions" c:type="const cairo_font_options_t*"/>
  289. </return-value>
  290. <parameters>
  291. <parameter name="context" transfer-ownership="none">
  292. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  293. <type name="Pango.Context" c:type="PangoContext*"/>
  294. </parameter>
  295. </parameters>
  296. </function>
  297. <function name="context_get_resolution"
  298. c:identifier="pango_cairo_context_get_resolution"
  299. version="1.10">
  300. <doc xml:space="preserve">Gets the resolution for the context. See pango_cairo_context_set_resolution()</doc>
  301. <return-value transfer-ownership="none">
  302. <doc xml:space="preserve">the resolution in "dots per inch". A negative value will
  303. be returned if no resolution has previously been set.</doc>
  304. <type name="gdouble" c:type="double"/>
  305. </return-value>
  306. <parameters>
  307. <parameter name="context" transfer-ownership="none">
  308. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  309. <type name="Pango.Context" c:type="PangoContext*"/>
  310. </parameter>
  311. </parameters>
  312. </function>
  313. <function name="context_get_shape_renderer"
  314. c:identifier="pango_cairo_context_get_shape_renderer"
  315. version="1.18"
  316. introspectable="0">
  317. <doc xml:space="preserve">Sets callback function for context to use for rendering attributes
  318. of type %PANGO_ATTR_SHAPE. See #PangoCairoShapeRendererFunc for
  319. details.
  320. Retrieves callback function and associated user data for rendering
  321. attributes of type %PANGO_ATTR_SHAPE as set by
  322. pango_cairo_context_set_shape_renderer(), if any.</doc>
  323. <return-value nullable="1">
  324. <doc xml:space="preserve">the shape rendering callback previously
  325. set on the context, or %NULL if no shape rendering callback have
  326. been set.</doc>
  327. <type name="ShapeRendererFunc" c:type="PangoCairoShapeRendererFunc"/>
  328. </return-value>
  329. <parameters>
  330. <parameter name="context" transfer-ownership="none">
  331. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  332. <type name="Pango.Context" c:type="PangoContext*"/>
  333. </parameter>
  334. <parameter name="data"
  335. transfer-ownership="none"
  336. nullable="1"
  337. allow-none="1">
  338. <doc xml:space="preserve">Pointer to #gpointer to return user data</doc>
  339. <type name="gpointer" c:type="gpointer*"/>
  340. </parameter>
  341. </parameters>
  342. </function>
  343. <function name="context_set_font_options"
  344. c:identifier="pango_cairo_context_set_font_options"
  345. version="1.10">
  346. <doc xml:space="preserve">Sets the font options used when rendering text with this context.
  347. These options override any options that pango_cairo_update_context()
  348. derives from the target surface.</doc>
  349. <return-value transfer-ownership="none">
  350. <type name="none" c:type="void"/>
  351. </return-value>
  352. <parameters>
  353. <parameter name="context" transfer-ownership="none">
  354. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  355. <type name="Pango.Context" c:type="PangoContext*"/>
  356. </parameter>
  357. <parameter name="options"
  358. transfer-ownership="none"
  359. nullable="1"
  360. allow-none="1">
  361. <doc xml:space="preserve">a #cairo_font_options_t, or %NULL to unset
  362. any previously set options. A copy is made.</doc>
  363. <type name="cairo.FontOptions" c:type="const cairo_font_options_t*"/>
  364. </parameter>
  365. </parameters>
  366. </function>
  367. <function name="context_set_resolution"
  368. c:identifier="pango_cairo_context_set_resolution"
  369. version="1.10">
  370. <doc xml:space="preserve">Sets the resolution for the context. This is a scale factor between
  371. points specified in a #PangoFontDescription and Cairo units. The
  372. default value is 96, meaning that a 10 point font will be 13
  373. units high. (10 * 96. / 72. = 13.3).</doc>
  374. <return-value transfer-ownership="none">
  375. <type name="none" c:type="void"/>
  376. </return-value>
  377. <parameters>
  378. <parameter name="context" transfer-ownership="none">
  379. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  380. <type name="Pango.Context" c:type="PangoContext*"/>
  381. </parameter>
  382. <parameter name="dpi" transfer-ownership="none">
  383. <doc xml:space="preserve">the resolution in "dots per inch". (Physical inches aren't actually
  384. involved; the terminology is conventional.) A 0 or negative value
  385. means to use the resolution from the font map.</doc>
  386. <type name="gdouble" c:type="double"/>
  387. </parameter>
  388. </parameters>
  389. </function>
  390. <function name="context_set_shape_renderer"
  391. c:identifier="pango_cairo_context_set_shape_renderer"
  392. version="1.18">
  393. <doc xml:space="preserve">Sets callback function for context to use for rendering attributes
  394. of type %PANGO_ATTR_SHAPE. See #PangoCairoShapeRendererFunc for
  395. details.</doc>
  396. <return-value transfer-ownership="none">
  397. <type name="none" c:type="void"/>
  398. </return-value>
  399. <parameters>
  400. <parameter name="context" transfer-ownership="none">
  401. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  402. <type name="Pango.Context" c:type="PangoContext*"/>
  403. </parameter>
  404. <parameter name="func"
  405. transfer-ownership="none"
  406. nullable="1"
  407. allow-none="1"
  408. scope="notified"
  409. closure="2"
  410. destroy="3">
  411. <doc xml:space="preserve">Callback function for rendering attributes of
  412. type %PANGO_ATTR_SHAPE, or %NULL to disable shape rendering.</doc>
  413. <type name="ShapeRendererFunc" c:type="PangoCairoShapeRendererFunc"/>
  414. </parameter>
  415. <parameter name="data"
  416. transfer-ownership="none"
  417. nullable="1"
  418. allow-none="1">
  419. <doc xml:space="preserve">User data that will be passed to @func.</doc>
  420. <type name="gpointer" c:type="gpointer"/>
  421. </parameter>
  422. <parameter name="dnotify" transfer-ownership="none" scope="async">
  423. <doc xml:space="preserve">Callback that will be called when the
  424. context is freed to release @data, or %NULL.</doc>
  425. <type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
  426. </parameter>
  427. </parameters>
  428. </function>
  429. <function name="create_context"
  430. c:identifier="pango_cairo_create_context"
  431. version="1.22">
  432. <doc xml:space="preserve">Creates a context object set up to match the current transformation
  433. and target surface of the Cairo context. This context can then be
  434. used to create a layout using pango_layout_new().
  435. This function is a convenience function that creates a context using
  436. the default font map, then updates it to @cr. If you just need to
  437. create a layout for use with @cr and do not need to access #PangoContext
  438. directly, you can use pango_cairo_create_layout() instead.</doc>
  439. <return-value transfer-ownership="full">
  440. <doc xml:space="preserve">the newly created #PangoContext. Free with
  441. g_object_unref().</doc>
  442. <type name="Pango.Context" c:type="PangoContext*"/>
  443. </return-value>
  444. <parameters>
  445. <parameter name="cr" transfer-ownership="none">
  446. <doc xml:space="preserve">a Cairo context</doc>
  447. <type name="cairo.Context" c:type="cairo_t*"/>
  448. </parameter>
  449. </parameters>
  450. </function>
  451. <function name="create_layout"
  452. c:identifier="pango_cairo_create_layout"
  453. version="1.10">
  454. <doc xml:space="preserve">Creates a layout object set up to match the current transformation
  455. and target surface of the Cairo context. This layout can then be
  456. used for text measurement with functions like
  457. pango_layout_get_size() or drawing with functions like
  458. pango_cairo_show_layout(). If you change the transformation
  459. or target surface for @cr, you need to call pango_cairo_update_layout()
  460. This function is the most convenient way to use Cairo with Pango,
  461. however it is slightly inefficient since it creates a separate
  462. #PangoContext object for each layout. This might matter in an
  463. application that was laying out large amounts of text.</doc>
  464. <return-value transfer-ownership="full">
  465. <doc xml:space="preserve">the newly created #PangoLayout. Free with
  466. g_object_unref().</doc>
  467. <type name="Pango.Layout" c:type="PangoLayout*"/>
  468. </return-value>
  469. <parameters>
  470. <parameter name="cr" transfer-ownership="none">
  471. <doc xml:space="preserve">a Cairo context</doc>
  472. <type name="cairo.Context" c:type="cairo_t*"/>
  473. </parameter>
  474. </parameters>
  475. </function>
  476. <function name="error_underline_path"
  477. c:identifier="pango_cairo_error_underline_path"
  478. version="1.14">
  479. <doc xml:space="preserve">Add a squiggly line to the current path in the specified cairo context that
  480. approximately covers the given rectangle in the style of an underline used
  481. to indicate a spelling error. (The width of the underline is rounded to an
  482. integer number of up/down segments and the resulting rectangle is centered
  483. in the original rectangle)</doc>
  484. <return-value transfer-ownership="none">
  485. <type name="none" c:type="void"/>
  486. </return-value>
  487. <parameters>
  488. <parameter name="cr" transfer-ownership="none">
  489. <doc xml:space="preserve">a Cairo context</doc>
  490. <type name="cairo.Context" c:type="cairo_t*"/>
  491. </parameter>
  492. <parameter name="x" transfer-ownership="none">
  493. <doc xml:space="preserve">The X coordinate of one corner of the rectangle</doc>
  494. <type name="gdouble" c:type="double"/>
  495. </parameter>
  496. <parameter name="y" transfer-ownership="none">
  497. <doc xml:space="preserve">The Y coordinate of one corner of the rectangle</doc>
  498. <type name="gdouble" c:type="double"/>
  499. </parameter>
  500. <parameter name="width" transfer-ownership="none">
  501. <doc xml:space="preserve">Non-negative width of the rectangle</doc>
  502. <type name="gdouble" c:type="double"/>
  503. </parameter>
  504. <parameter name="height" transfer-ownership="none">
  505. <doc xml:space="preserve">Non-negative height of the rectangle</doc>
  506. <type name="gdouble" c:type="double"/>
  507. </parameter>
  508. </parameters>
  509. </function>
  510. <function name="font_map_get_default"
  511. c:identifier="pango_cairo_font_map_get_default"
  512. moved-to="FontMap.get_default"
  513. version="1.10">
  514. <doc xml:space="preserve">Gets a default #PangoCairoFontMap to use with Cairo.
  515. Note that the type of the returned object will depend
  516. on the particular font backend Cairo was compiled to use;
  517. You generally should only use the #PangoFontMap and
  518. #PangoCairoFontMap interfaces on the returned object.
  519. The default Cairo fontmap can be changed by using
  520. pango_cairo_font_map_set_default(). This can be used to
  521. change the Cairo font backend that the default fontmap
  522. uses for example.
  523. Note that since Pango 1.32.6, the default fontmap is per-thread.
  524. Each thread gets its own default fontmap. In this way,
  525. PangoCairo can be used safely from multiple threads.</doc>
  526. <return-value transfer-ownership="none">
  527. <doc xml:space="preserve">the default PangoCairo fontmap
  528. for the current thread. This object is owned by Pango and must not be freed.</doc>
  529. <type name="Pango.FontMap" c:type="PangoFontMap*"/>
  530. </return-value>
  531. </function>
  532. <function name="font_map_new"
  533. c:identifier="pango_cairo_font_map_new"
  534. moved-to="FontMap.new"
  535. version="1.10">
  536. <doc xml:space="preserve">Creates a new #PangoCairoFontMap object; a fontmap is used
  537. to cache information about available fonts, and holds
  538. certain global parameters such as the resolution.
  539. In most cases, you can use pango_cairo_font_map_get_default()
  540. instead.
  541. Note that the type of the returned object will depend
  542. on the particular font backend Cairo was compiled to use;
  543. You generally should only use the #PangoFontMap and
  544. #PangoCairoFontMap interfaces on the returned object.
  545. You can override the type of backend returned by using an
  546. environment variable %PANGOCAIRO_BACKEND. Supported types,
  547. based on your build, are fc (fontconfig), win32, and coretext.
  548. If requested type is not available, NULL is returned. Ie.
  549. this is only useful for testing, when at least two backends
  550. are compiled in.</doc>
  551. <return-value transfer-ownership="full">
  552. <doc xml:space="preserve">the newly allocated #PangoFontMap,
  553. which should be freed with g_object_unref().</doc>
  554. <type name="Pango.FontMap" c:type="PangoFontMap*"/>
  555. </return-value>
  556. </function>
  557. <function name="font_map_new_for_font_type"
  558. c:identifier="pango_cairo_font_map_new_for_font_type"
  559. moved-to="FontMap.new_for_font_type"
  560. version="1.18">
  561. <doc xml:space="preserve">Creates a new #PangoCairoFontMap object of the type suitable
  562. to be used with cairo font backend of type @fonttype.
  563. In most cases one should simply use @pango_cairo_font_map_new(),
  564. or in fact in most of those cases, just use
  565. @pango_cairo_font_map_get_default().</doc>
  566. <return-value transfer-ownership="full" nullable="1">
  567. <doc xml:space="preserve">the newly allocated
  568. #PangoFontMap of suitable type which should be freed
  569. with g_object_unref(), or %NULL if the requested
  570. cairo font backend is not supported / compiled in.</doc>
  571. <type name="Pango.FontMap" c:type="PangoFontMap*"/>
  572. </return-value>
  573. <parameters>
  574. <parameter name="fonttype" transfer-ownership="none">
  575. <doc xml:space="preserve">desired #cairo_font_type_t</doc>
  576. <type name="cairo.FontType" c:type="cairo_font_type_t"/>
  577. </parameter>
  578. </parameters>
  579. </function>
  580. <function name="glyph_string_path"
  581. c:identifier="pango_cairo_glyph_string_path"
  582. version="1.10">
  583. <doc xml:space="preserve">Adds the glyphs in @glyphs to the current path in the specified
  584. cairo context. The origin of the glyphs (the left edge of the baseline)
  585. will be at the current point of the cairo context.</doc>
  586. <return-value transfer-ownership="none">
  587. <type name="none" c:type="void"/>
  588. </return-value>
  589. <parameters>
  590. <parameter name="cr" transfer-ownership="none">
  591. <doc xml:space="preserve">a Cairo context</doc>
  592. <type name="cairo.Context" c:type="cairo_t*"/>
  593. </parameter>
  594. <parameter name="font" transfer-ownership="none">
  595. <doc xml:space="preserve">a #PangoFont from a #PangoCairoFontMap</doc>
  596. <type name="Pango.Font" c:type="PangoFont*"/>
  597. </parameter>
  598. <parameter name="glyphs" transfer-ownership="none">
  599. <doc xml:space="preserve">a #PangoGlyphString</doc>
  600. <type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
  601. </parameter>
  602. </parameters>
  603. </function>
  604. <function name="layout_line_path"
  605. c:identifier="pango_cairo_layout_line_path"
  606. version="1.10">
  607. <doc xml:space="preserve">Adds the text in #PangoLayoutLine to the current path in the
  608. specified cairo context. The origin of the glyphs (the left edge
  609. of the line) will be at the current point of the cairo context.</doc>
  610. <return-value transfer-ownership="none">
  611. <type name="none" c:type="void"/>
  612. </return-value>
  613. <parameters>
  614. <parameter name="cr" transfer-ownership="none">
  615. <doc xml:space="preserve">a Cairo context</doc>
  616. <type name="cairo.Context" c:type="cairo_t*"/>
  617. </parameter>
  618. <parameter name="line" transfer-ownership="none">
  619. <doc xml:space="preserve">a #PangoLayoutLine</doc>
  620. <type name="Pango.LayoutLine" c:type="PangoLayoutLine*"/>
  621. </parameter>
  622. </parameters>
  623. </function>
  624. <function name="layout_path"
  625. c:identifier="pango_cairo_layout_path"
  626. version="1.10">
  627. <doc xml:space="preserve">Adds the text in a #PangoLayout to the current path in the
  628. specified cairo context. The top-left corner of the #PangoLayout
  629. will be at the current point of the cairo context.</doc>
  630. <return-value transfer-ownership="none">
  631. <type name="none" c:type="void"/>
  632. </return-value>
  633. <parameters>
  634. <parameter name="cr" transfer-ownership="none">
  635. <doc xml:space="preserve">a Cairo context</doc>
  636. <type name="cairo.Context" c:type="cairo_t*"/>
  637. </parameter>
  638. <parameter name="layout" transfer-ownership="none">
  639. <doc xml:space="preserve">a Pango layout</doc>
  640. <type name="Pango.Layout" c:type="PangoLayout*"/>
  641. </parameter>
  642. </parameters>
  643. </function>
  644. <function name="show_error_underline"
  645. c:identifier="pango_cairo_show_error_underline"
  646. version="1.14">
  647. <doc xml:space="preserve">Draw a squiggly line in the specified cairo context that approximately
  648. covers the given rectangle in the style of an underline used to indicate a
  649. spelling error. (The width of the underline is rounded to an integer
  650. number of up/down segments and the resulting rectangle is centered in the
  651. original rectangle)</doc>
  652. <return-value transfer-ownership="none">
  653. <type name="none" c:type="void"/>
  654. </return-value>
  655. <parameters>
  656. <parameter name="cr" transfer-ownership="none">
  657. <doc xml:space="preserve">a Cairo context</doc>
  658. <type name="cairo.Context" c:type="cairo_t*"/>
  659. </parameter>
  660. <parameter name="x" transfer-ownership="none">
  661. <doc xml:space="preserve">The X coordinate of one corner of the rectangle</doc>
  662. <type name="gdouble" c:type="double"/>
  663. </parameter>
  664. <parameter name="y" transfer-ownership="none">
  665. <doc xml:space="preserve">The Y coordinate of one corner of the rectangle</doc>
  666. <type name="gdouble" c:type="double"/>
  667. </parameter>
  668. <parameter name="width" transfer-ownership="none">
  669. <doc xml:space="preserve">Non-negative width of the rectangle</doc>
  670. <type name="gdouble" c:type="double"/>
  671. </parameter>
  672. <parameter name="height" transfer-ownership="none">
  673. <doc xml:space="preserve">Non-negative height of the rectangle</doc>
  674. <type name="gdouble" c:type="double"/>
  675. </parameter>
  676. </parameters>
  677. </function>
  678. <function name="show_glyph_item"
  679. c:identifier="pango_cairo_show_glyph_item"
  680. version="1.22">
  681. <doc xml:space="preserve">Draws the glyphs in @glyph_item in the specified cairo context,
  682. embedding the text associated with the glyphs in the output if the
  683. output format supports it (PDF for example), otherwise it acts
  684. similar to pango_cairo_show_glyph_string().
  685. The origin of the glyphs (the left edge of the baseline) will
  686. be drawn at the current point of the cairo context.
  687. Note that @text is the start of the text for layout, which is then
  688. indexed by &lt;literal&gt;@glyph_item-&gt;item-&gt;offset&lt;/literal&gt;.</doc>
  689. <return-value transfer-ownership="none">
  690. <type name="none" c:type="void"/>
  691. </return-value>
  692. <parameters>
  693. <parameter name="cr" transfer-ownership="none">
  694. <doc xml:space="preserve">a Cairo context</doc>
  695. <type name="cairo.Context" c:type="cairo_t*"/>
  696. </parameter>
  697. <parameter name="text" transfer-ownership="none">
  698. <doc xml:space="preserve">the UTF-8 text that @glyph_item refers to</doc>
  699. <type name="utf8" c:type="const char*"/>
  700. </parameter>
  701. <parameter name="glyph_item" transfer-ownership="none">
  702. <doc xml:space="preserve">a #PangoGlyphItem</doc>
  703. <type name="Pango.GlyphItem" c:type="PangoGlyphItem*"/>
  704. </parameter>
  705. </parameters>
  706. </function>
  707. <function name="show_glyph_string"
  708. c:identifier="pango_cairo_show_glyph_string"
  709. version="1.10">
  710. <doc xml:space="preserve">Draws the glyphs in @glyphs in the specified cairo context.
  711. The origin of the glyphs (the left edge of the baseline) will
  712. be drawn at the current point of the cairo context.</doc>
  713. <return-value transfer-ownership="none">
  714. <type name="none" c:type="void"/>
  715. </return-value>
  716. <parameters>
  717. <parameter name="cr" transfer-ownership="none">
  718. <doc xml:space="preserve">a Cairo context</doc>
  719. <type name="cairo.Context" c:type="cairo_t*"/>
  720. </parameter>
  721. <parameter name="font" transfer-ownership="none">
  722. <doc xml:space="preserve">a #PangoFont from a #PangoCairoFontMap</doc>
  723. <type name="Pango.Font" c:type="PangoFont*"/>
  724. </parameter>
  725. <parameter name="glyphs" transfer-ownership="none">
  726. <doc xml:space="preserve">a #PangoGlyphString</doc>
  727. <type name="Pango.GlyphString" c:type="PangoGlyphString*"/>
  728. </parameter>
  729. </parameters>
  730. </function>
  731. <function name="show_layout"
  732. c:identifier="pango_cairo_show_layout"
  733. version="1.10">
  734. <doc xml:space="preserve">Draws a #PangoLayout in the specified cairo context.
  735. The top-left corner of the #PangoLayout will be drawn
  736. at the current point of the cairo context.</doc>
  737. <return-value transfer-ownership="none">
  738. <type name="none" c:type="void"/>
  739. </return-value>
  740. <parameters>
  741. <parameter name="cr" transfer-ownership="none">
  742. <doc xml:space="preserve">a Cairo context</doc>
  743. <type name="cairo.Context" c:type="cairo_t*"/>
  744. </parameter>
  745. <parameter name="layout" transfer-ownership="none">
  746. <doc xml:space="preserve">a Pango layout</doc>
  747. <type name="Pango.Layout" c:type="PangoLayout*"/>
  748. </parameter>
  749. </parameters>
  750. </function>
  751. <function name="show_layout_line"
  752. c:identifier="pango_cairo_show_layout_line"
  753. version="1.10">
  754. <doc xml:space="preserve">Draws a #PangoLayoutLine in the specified cairo context.
  755. The origin of the glyphs (the left edge of the line) will
  756. be drawn at the current point of the cairo context.</doc>
  757. <return-value transfer-ownership="none">
  758. <type name="none" c:type="void"/>
  759. </return-value>
  760. <parameters>
  761. <parameter name="cr" transfer-ownership="none">
  762. <doc xml:space="preserve">a Cairo context</doc>
  763. <type name="cairo.Context" c:type="cairo_t*"/>
  764. </parameter>
  765. <parameter name="line" transfer-ownership="none">
  766. <doc xml:space="preserve">a #PangoLayoutLine</doc>
  767. <type name="Pango.LayoutLine" c:type="PangoLayoutLine*"/>
  768. </parameter>
  769. </parameters>
  770. </function>
  771. <function name="update_context"
  772. c:identifier="pango_cairo_update_context"
  773. version="1.10">
  774. <doc xml:space="preserve">Updates a #PangoContext previously created for use with Cairo to
  775. match the current transformation and target surface of a Cairo
  776. context. If any layouts have been created for the context,
  777. it's necessary to call pango_layout_context_changed() on those
  778. layouts.</doc>
  779. <return-value transfer-ownership="none">
  780. <type name="none" c:type="void"/>
  781. </return-value>
  782. <parameters>
  783. <parameter name="cr" transfer-ownership="none">
  784. <doc xml:space="preserve">a Cairo context</doc>
  785. <type name="cairo.Context" c:type="cairo_t*"/>
  786. </parameter>
  787. <parameter name="context" transfer-ownership="none">
  788. <doc xml:space="preserve">a #PangoContext, from a pangocairo font map</doc>
  789. <type name="Pango.Context" c:type="PangoContext*"/>
  790. </parameter>
  791. </parameters>
  792. </function>
  793. <function name="update_layout"
  794. c:identifier="pango_cairo_update_layout"
  795. version="1.10">
  796. <doc xml:space="preserve">Updates the private #PangoContext of a #PangoLayout created with
  797. pango_cairo_create_layout() to match the current transformation
  798. and target surface of a Cairo context.</doc>
  799. <return-value transfer-ownership="none">
  800. <type name="none" c:type="void"/>
  801. </return-value>
  802. <parameters>
  803. <parameter name="cr" transfer-ownership="none">
  804. <doc xml:space="preserve">a Cairo context</doc>
  805. <type name="cairo.Context" c:type="cairo_t*"/>
  806. </parameter>
  807. <parameter name="layout" transfer-ownership="none">
  808. <doc xml:space="preserve">a #PangoLayout, from pango_cairo_create_layout()</doc>
  809. <type name="Pango.Layout" c:type="PangoLayout*"/>
  810. </parameter>
  811. </parameters>
  812. </function>
  813. </namespace>
  814. </repository>