pango-layout.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554
  1. /* Pango
  2. * pango-layout.h: High-level layout driver
  3. *
  4. * Copyright (C) 2000 Red Hat Software
  5. *
  6. * This library is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU Library General Public
  8. * License as published by the Free Software Foundation; either
  9. * version 2 of the License, or (at your option) any later version.
  10. *
  11. * This library is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. * Library General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU Library General Public
  17. * License along with this library; if not, write to the
  18. * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19. * Boston, MA 02111-1307, USA.
  20. */
  21. #ifndef __PANGO_LAYOUT_H__
  22. #define __PANGO_LAYOUT_H__
  23. #include <pango/pango-attributes.h>
  24. #include <pango/pango-context.h>
  25. #include <pango/pango-glyph-item.h>
  26. #include <pango/pango-tabs.h>
  27. G_BEGIN_DECLS
  28. typedef struct _PangoLayout PangoLayout;
  29. typedef struct _PangoLayoutClass PangoLayoutClass;
  30. typedef struct _PangoLayoutLine PangoLayoutLine;
  31. /**
  32. * PangoLayoutRun:
  33. *
  34. * A `PangoLayoutRun` represents a single run within a `PangoLayoutLine`.
  35. *
  36. * It is simply an alternate name for [struct@Pango.GlyphItem].
  37. * See the [struct@Pango.GlyphItem] docs for details on the fields.
  38. */
  39. typedef PangoGlyphItem PangoLayoutRun;
  40. /**
  41. * PangoAlignment:
  42. * @PANGO_ALIGN_LEFT: Put all available space on the right
  43. * @PANGO_ALIGN_CENTER: Center the line within the available space
  44. * @PANGO_ALIGN_RIGHT: Put all available space on the left
  45. *
  46. * `PangoAlignment` describes how to align the lines of a `PangoLayout`
  47. * within the available space.
  48. *
  49. * If the `PangoLayout` is set to justify using [method@Pango.Layout.set_justify],
  50. * this only affects partial lines.
  51. *
  52. * See [method@Pango.Layout.set_auto_dir] for how text direction affects
  53. * the interpretation of `PangoAlignment` values.
  54. */
  55. typedef enum {
  56. PANGO_ALIGN_LEFT,
  57. PANGO_ALIGN_CENTER,
  58. PANGO_ALIGN_RIGHT
  59. } PangoAlignment;
  60. /**
  61. * PangoWrapMode:
  62. * @PANGO_WRAP_WORD: wrap lines at word boundaries.
  63. * @PANGO_WRAP_CHAR: wrap lines at character boundaries.
  64. * @PANGO_WRAP_WORD_CHAR: wrap lines at word boundaries, but fall back to
  65. * character boundaries if there is not enough space for a full word.
  66. *
  67. * `PangoWrapMode` describes how to wrap the lines of a `PangoLayout`
  68. * to the desired width.
  69. *
  70. * For @PANGO_WRAP_WORD, Pango uses break opportunities that are determined
  71. * by the Unicode line breaking algorithm. For @PANGO_WRAP_CHAR, Pango allows
  72. * breaking at grapheme boundaries that are determined by the Unicode text
  73. * segmentation algorithm.
  74. */
  75. typedef enum {
  76. PANGO_WRAP_WORD,
  77. PANGO_WRAP_CHAR,
  78. PANGO_WRAP_WORD_CHAR
  79. } PangoWrapMode;
  80. /**
  81. * PangoEllipsizeMode:
  82. * @PANGO_ELLIPSIZE_NONE: No ellipsization
  83. * @PANGO_ELLIPSIZE_START: Omit characters at the start of the text
  84. * @PANGO_ELLIPSIZE_MIDDLE: Omit characters in the middle of the text
  85. * @PANGO_ELLIPSIZE_END: Omit characters at the end of the text
  86. *
  87. * `PangoEllipsizeMode` describes what sort of ellipsization
  88. * should be applied to text.
  89. *
  90. * In the ellipsization process characters are removed from the
  91. * text in order to make it fit to a given width and replaced
  92. * with an ellipsis.
  93. */
  94. typedef enum {
  95. PANGO_ELLIPSIZE_NONE,
  96. PANGO_ELLIPSIZE_START,
  97. PANGO_ELLIPSIZE_MIDDLE,
  98. PANGO_ELLIPSIZE_END
  99. } PangoEllipsizeMode;
  100. /**
  101. * PangoLayoutLine:
  102. * @layout: (nullable): the layout this line belongs to, might be %NULL
  103. * @start_index: start of line as byte index into layout->text
  104. * @length: length of line in bytes
  105. * @runs: (nullable) (element-type Pango.LayoutRun): list of runs in the
  106. * line, from left to right
  107. * @is_paragraph_start: #TRUE if this is the first line of the paragraph
  108. * @resolved_dir: #Resolved PangoDirection of line
  109. *
  110. * A `PangoLayoutLine` represents one of the lines resulting from laying
  111. * out a paragraph via `PangoLayout`.
  112. *
  113. * `PangoLayoutLine` structures are obtained by calling
  114. * [method@Pango.Layout.get_line] and are only valid until the text,
  115. * attributes, or settings of the parent `PangoLayout` are modified.
  116. */
  117. struct _PangoLayoutLine
  118. {
  119. PangoLayout *layout;
  120. gint start_index; /* start of line as byte index into layout->text */
  121. gint length; /* length of line in bytes */
  122. GSList *runs;
  123. guint is_paragraph_start : 1; /* TRUE if this is the first line of the paragraph */
  124. guint resolved_dir : 3; /* Resolved PangoDirection of line */
  125. };
  126. #define PANGO_TYPE_LAYOUT (pango_layout_get_type ())
  127. #define PANGO_LAYOUT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_LAYOUT, PangoLayout))
  128. #define PANGO_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PANGO_TYPE_LAYOUT, PangoLayoutClass))
  129. #define PANGO_IS_LAYOUT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_LAYOUT))
  130. #define PANGO_IS_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PANGO_TYPE_LAYOUT))
  131. #define PANGO_LAYOUT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PANGO_TYPE_LAYOUT, PangoLayoutClass))
  132. /* The PangoLayout and PangoLayoutClass structs are private; if you
  133. * need to create a subclass of these, file a bug.
  134. */
  135. PANGO_AVAILABLE_IN_ALL
  136. GType pango_layout_get_type (void) G_GNUC_CONST;
  137. PANGO_AVAILABLE_IN_ALL
  138. PangoLayout *pango_layout_new (PangoContext *context);
  139. PANGO_AVAILABLE_IN_ALL
  140. PangoLayout *pango_layout_copy (PangoLayout *src);
  141. PANGO_AVAILABLE_IN_ALL
  142. PangoContext *pango_layout_get_context (PangoLayout *layout);
  143. PANGO_AVAILABLE_IN_ALL
  144. void pango_layout_set_attributes (PangoLayout *layout,
  145. PangoAttrList *attrs);
  146. PANGO_AVAILABLE_IN_ALL
  147. PangoAttrList *pango_layout_get_attributes (PangoLayout *layout);
  148. PANGO_AVAILABLE_IN_ALL
  149. void pango_layout_set_text (PangoLayout *layout,
  150. const char *text,
  151. int length);
  152. PANGO_AVAILABLE_IN_ALL
  153. const char *pango_layout_get_text (PangoLayout *layout);
  154. PANGO_AVAILABLE_IN_1_30
  155. gint pango_layout_get_character_count (PangoLayout *layout);
  156. PANGO_AVAILABLE_IN_ALL
  157. void pango_layout_set_markup (PangoLayout *layout,
  158. const char *markup,
  159. int length);
  160. PANGO_AVAILABLE_IN_ALL
  161. void pango_layout_set_markup_with_accel (PangoLayout *layout,
  162. const char *markup,
  163. int length,
  164. gunichar accel_marker,
  165. gunichar *accel_char);
  166. PANGO_AVAILABLE_IN_ALL
  167. void pango_layout_set_font_description (PangoLayout *layout,
  168. const PangoFontDescription *desc);
  169. PANGO_AVAILABLE_IN_1_8
  170. const PangoFontDescription *pango_layout_get_font_description (PangoLayout *layout);
  171. PANGO_AVAILABLE_IN_ALL
  172. void pango_layout_set_width (PangoLayout *layout,
  173. int width);
  174. PANGO_AVAILABLE_IN_ALL
  175. int pango_layout_get_width (PangoLayout *layout);
  176. PANGO_AVAILABLE_IN_1_20
  177. void pango_layout_set_height (PangoLayout *layout,
  178. int height);
  179. PANGO_AVAILABLE_IN_1_20
  180. int pango_layout_get_height (PangoLayout *layout);
  181. PANGO_AVAILABLE_IN_ALL
  182. void pango_layout_set_wrap (PangoLayout *layout,
  183. PangoWrapMode wrap);
  184. PANGO_AVAILABLE_IN_ALL
  185. PangoWrapMode pango_layout_get_wrap (PangoLayout *layout);
  186. PANGO_AVAILABLE_IN_1_16
  187. gboolean pango_layout_is_wrapped (PangoLayout *layout);
  188. PANGO_AVAILABLE_IN_ALL
  189. void pango_layout_set_indent (PangoLayout *layout,
  190. int indent);
  191. PANGO_AVAILABLE_IN_ALL
  192. int pango_layout_get_indent (PangoLayout *layout);
  193. PANGO_AVAILABLE_IN_ALL
  194. void pango_layout_set_spacing (PangoLayout *layout,
  195. int spacing);
  196. PANGO_AVAILABLE_IN_ALL
  197. int pango_layout_get_spacing (PangoLayout *layout);
  198. PANGO_AVAILABLE_IN_1_44
  199. void pango_layout_set_line_spacing (PangoLayout *layout,
  200. float factor);
  201. PANGO_AVAILABLE_IN_1_44
  202. float pango_layout_get_line_spacing (PangoLayout *layout);
  203. PANGO_AVAILABLE_IN_ALL
  204. void pango_layout_set_justify (PangoLayout *layout,
  205. gboolean justify);
  206. PANGO_AVAILABLE_IN_ALL
  207. gboolean pango_layout_get_justify (PangoLayout *layout);
  208. PANGO_AVAILABLE_IN_1_50
  209. void pango_layout_set_justify_last_line (PangoLayout *layout,
  210. gboolean justify);
  211. PANGO_AVAILABLE_IN_1_50
  212. gboolean pango_layout_get_justify_last_line (PangoLayout *layout);
  213. PANGO_AVAILABLE_IN_1_4
  214. void pango_layout_set_auto_dir (PangoLayout *layout,
  215. gboolean auto_dir);
  216. PANGO_AVAILABLE_IN_1_4
  217. gboolean pango_layout_get_auto_dir (PangoLayout *layout);
  218. PANGO_AVAILABLE_IN_ALL
  219. void pango_layout_set_alignment (PangoLayout *layout,
  220. PangoAlignment alignment);
  221. PANGO_AVAILABLE_IN_ALL
  222. PangoAlignment pango_layout_get_alignment (PangoLayout *layout);
  223. PANGO_AVAILABLE_IN_ALL
  224. void pango_layout_set_tabs (PangoLayout *layout,
  225. PangoTabArray *tabs);
  226. PANGO_AVAILABLE_IN_ALL
  227. PangoTabArray* pango_layout_get_tabs (PangoLayout *layout);
  228. PANGO_AVAILABLE_IN_ALL
  229. void pango_layout_set_single_paragraph_mode (PangoLayout *layout,
  230. gboolean setting);
  231. PANGO_AVAILABLE_IN_ALL
  232. gboolean pango_layout_get_single_paragraph_mode (PangoLayout *layout);
  233. PANGO_AVAILABLE_IN_1_6
  234. void pango_layout_set_ellipsize (PangoLayout *layout,
  235. PangoEllipsizeMode ellipsize);
  236. PANGO_AVAILABLE_IN_1_6
  237. PangoEllipsizeMode pango_layout_get_ellipsize (PangoLayout *layout);
  238. PANGO_AVAILABLE_IN_1_16
  239. gboolean pango_layout_is_ellipsized (PangoLayout *layout);
  240. PANGO_AVAILABLE_IN_1_16
  241. int pango_layout_get_unknown_glyphs_count (PangoLayout *layout);
  242. PANGO_AVAILABLE_IN_1_46
  243. PangoDirection pango_layout_get_direction (PangoLayout *layout,
  244. int index);
  245. PANGO_AVAILABLE_IN_ALL
  246. void pango_layout_context_changed (PangoLayout *layout);
  247. PANGO_AVAILABLE_IN_1_32
  248. guint pango_layout_get_serial (PangoLayout *layout);
  249. PANGO_AVAILABLE_IN_ALL
  250. void pango_layout_get_log_attrs (PangoLayout *layout,
  251. PangoLogAttr **attrs,
  252. gint *n_attrs);
  253. PANGO_AVAILABLE_IN_1_30
  254. const PangoLogAttr *pango_layout_get_log_attrs_readonly (PangoLayout *layout,
  255. gint *n_attrs);
  256. PANGO_AVAILABLE_IN_ALL
  257. void pango_layout_index_to_pos (PangoLayout *layout,
  258. int index_,
  259. PangoRectangle *pos);
  260. PANGO_AVAILABLE_IN_ALL
  261. void pango_layout_index_to_line_x (PangoLayout *layout,
  262. int index_,
  263. gboolean trailing,
  264. int *line,
  265. int *x_pos);
  266. PANGO_AVAILABLE_IN_ALL
  267. void pango_layout_get_cursor_pos (PangoLayout *layout,
  268. int index_,
  269. PangoRectangle *strong_pos,
  270. PangoRectangle *weak_pos);
  271. PANGO_AVAILABLE_IN_1_50
  272. void pango_layout_get_caret_pos (PangoLayout *layout,
  273. int index_,
  274. PangoRectangle *strong_pos,
  275. PangoRectangle *weak_pos);
  276. PANGO_AVAILABLE_IN_ALL
  277. void pango_layout_move_cursor_visually (PangoLayout *layout,
  278. gboolean strong,
  279. int old_index,
  280. int old_trailing,
  281. int direction,
  282. int *new_index,
  283. int *new_trailing);
  284. PANGO_AVAILABLE_IN_ALL
  285. gboolean pango_layout_xy_to_index (PangoLayout *layout,
  286. int x,
  287. int y,
  288. int *index_,
  289. int *trailing);
  290. PANGO_AVAILABLE_IN_ALL
  291. void pango_layout_get_extents (PangoLayout *layout,
  292. PangoRectangle *ink_rect,
  293. PangoRectangle *logical_rect);
  294. PANGO_AVAILABLE_IN_ALL
  295. void pango_layout_get_pixel_extents (PangoLayout *layout,
  296. PangoRectangle *ink_rect,
  297. PangoRectangle *logical_rect);
  298. PANGO_AVAILABLE_IN_ALL
  299. void pango_layout_get_size (PangoLayout *layout,
  300. int *width,
  301. int *height);
  302. PANGO_AVAILABLE_IN_ALL
  303. void pango_layout_get_pixel_size (PangoLayout *layout,
  304. int *width,
  305. int *height);
  306. PANGO_AVAILABLE_IN_1_22
  307. int pango_layout_get_baseline (PangoLayout *layout);
  308. PANGO_AVAILABLE_IN_ALL
  309. int pango_layout_get_line_count (PangoLayout *layout);
  310. PANGO_AVAILABLE_IN_ALL
  311. PangoLayoutLine *pango_layout_get_line (PangoLayout *layout,
  312. int line);
  313. PANGO_AVAILABLE_IN_1_16
  314. PangoLayoutLine *pango_layout_get_line_readonly (PangoLayout *layout,
  315. int line);
  316. PANGO_AVAILABLE_IN_ALL
  317. GSList * pango_layout_get_lines (PangoLayout *layout);
  318. PANGO_AVAILABLE_IN_1_16
  319. GSList * pango_layout_get_lines_readonly (PangoLayout *layout);
  320. /**
  321. * PangoLayoutSerializeFlags:
  322. * @PANGO_LAYOUT_SERIALIZE_DEFAULT: Default behavior
  323. * @PANGO_LAYOUT_SERIALIZE_CONTEXT: Include context information
  324. * @PANGO_LAYOUT_SERIALIZE_OUTPUT: Include information about the formatted output
  325. *
  326. * Flags that influence the behavior of [method@Pango.Layout.serialize].
  327. *
  328. * New members may be added to this enumeration over time.
  329. *
  330. * Since: 1.50
  331. */
  332. typedef enum {
  333. PANGO_LAYOUT_SERIALIZE_DEFAULT = 0,
  334. PANGO_LAYOUT_SERIALIZE_CONTEXT = 1 << 0,
  335. PANGO_LAYOUT_SERIALIZE_OUTPUT = 1 << 1,
  336. } PangoLayoutSerializeFlags;
  337. PANGO_AVAILABLE_IN_1_50
  338. GBytes * pango_layout_serialize (PangoLayout *layout,
  339. PangoLayoutSerializeFlags flags);
  340. PANGO_AVAILABLE_IN_1_50
  341. gboolean pango_layout_write_to_file (PangoLayout *layout,
  342. PangoLayoutSerializeFlags flags,
  343. const char *filename,
  344. GError **error);
  345. #define PANGO_LAYOUT_DESERIALIZE_ERROR (pango_layout_deserialize_error_quark ())
  346. /**
  347. * PangoLayoutDeserializeError:
  348. * @PANGO_LAYOUT_DESERIALIZE_INVALID: Unspecified error
  349. * @PANGO_LAYOUT_DESERIALIZE_INVALID_VALUE: A JSon value could not be
  350. * interpreted
  351. * @PANGO_LAYOUT_DESERIALIZE_MISSING_VALUE: A required JSon member was
  352. * not found
  353. *
  354. * Errors that can be returned by [func@Pango.Layout.deserialize].
  355. *
  356. * Since: 1.50
  357. */
  358. typedef enum {
  359. PANGO_LAYOUT_DESERIALIZE_INVALID,
  360. PANGO_LAYOUT_DESERIALIZE_INVALID_VALUE,
  361. PANGO_LAYOUT_DESERIALIZE_MISSING_VALUE,
  362. } PangoLayoutDeserializeError;
  363. PANGO_AVAILABLE_IN_1_50
  364. GQuark pango_layout_deserialize_error_quark (void);
  365. /**
  366. * PangoLayoutDeserializeFlags:
  367. * @PANGO_LAYOUT_DESERIALIZE_DEFAULT: Default behavior
  368. * @PANGO_LAYOUT_DESERIALIZE_CONTEXT: Apply context information
  369. * from the serialization to the `PangoContext`
  370. *
  371. * Flags that influence the behavior of [func@Pango.Layout.deserialize].
  372. *
  373. * New members may be added to this enumeration over time.
  374. *
  375. * Since: 1.50
  376. */
  377. typedef enum {
  378. PANGO_LAYOUT_DESERIALIZE_DEFAULT = 0,
  379. PANGO_LAYOUT_DESERIALIZE_CONTEXT = 1 << 0,
  380. } PangoLayoutDeserializeFlags;
  381. PANGO_AVAILABLE_IN_1_50
  382. PangoLayout * pango_layout_deserialize (PangoContext *context,
  383. GBytes *bytes,
  384. PangoLayoutDeserializeFlags flags,
  385. GError **error);
  386. #define PANGO_TYPE_LAYOUT_LINE (pango_layout_line_get_type ())
  387. PANGO_AVAILABLE_IN_ALL
  388. GType pango_layout_line_get_type (void) G_GNUC_CONST;
  389. PANGO_AVAILABLE_IN_1_10
  390. PangoLayoutLine *pango_layout_line_ref (PangoLayoutLine *line);
  391. PANGO_AVAILABLE_IN_ALL
  392. void pango_layout_line_unref (PangoLayoutLine *line);
  393. PANGO_AVAILABLE_IN_1_50
  394. int pango_layout_line_get_start_index (PangoLayoutLine *line);
  395. PANGO_AVAILABLE_IN_1_50
  396. int pango_layout_line_get_length (PangoLayoutLine *line);
  397. PANGO_AVAILABLE_IN_1_50
  398. gboolean pango_layout_line_is_paragraph_start (PangoLayoutLine *line);
  399. PANGO_AVAILABLE_IN_1_50
  400. PangoDirection pango_layout_line_get_resolved_direction (PangoLayoutLine *line);
  401. PANGO_AVAILABLE_IN_ALL
  402. gboolean pango_layout_line_x_to_index (PangoLayoutLine *line,
  403. int x_pos,
  404. int *index_,
  405. int *trailing);
  406. PANGO_AVAILABLE_IN_ALL
  407. void pango_layout_line_index_to_x (PangoLayoutLine *line,
  408. int index_,
  409. gboolean trailing,
  410. int *x_pos);
  411. PANGO_AVAILABLE_IN_ALL
  412. void pango_layout_line_get_x_ranges (PangoLayoutLine *line,
  413. int start_index,
  414. int end_index,
  415. int **ranges,
  416. int *n_ranges);
  417. PANGO_AVAILABLE_IN_ALL
  418. void pango_layout_line_get_extents (PangoLayoutLine *line,
  419. PangoRectangle *ink_rect,
  420. PangoRectangle *logical_rect);
  421. PANGO_AVAILABLE_IN_1_44
  422. void pango_layout_line_get_height (PangoLayoutLine *line,
  423. int *height);
  424. PANGO_AVAILABLE_IN_ALL
  425. void pango_layout_line_get_pixel_extents (PangoLayoutLine *layout_line,
  426. PangoRectangle *ink_rect,
  427. PangoRectangle *logical_rect);
  428. typedef struct _PangoLayoutIter PangoLayoutIter;
  429. #define PANGO_TYPE_LAYOUT_ITER (pango_layout_iter_get_type ())
  430. PANGO_AVAILABLE_IN_ALL
  431. GType pango_layout_iter_get_type (void) G_GNUC_CONST;
  432. PANGO_AVAILABLE_IN_ALL
  433. PangoLayoutIter *pango_layout_get_iter (PangoLayout *layout);
  434. PANGO_AVAILABLE_IN_1_20
  435. PangoLayoutIter *pango_layout_iter_copy (PangoLayoutIter *iter);
  436. PANGO_AVAILABLE_IN_ALL
  437. void pango_layout_iter_free (PangoLayoutIter *iter);
  438. PANGO_AVAILABLE_IN_ALL
  439. int pango_layout_iter_get_index (PangoLayoutIter *iter);
  440. PANGO_AVAILABLE_IN_ALL
  441. PangoLayoutRun *pango_layout_iter_get_run (PangoLayoutIter *iter);
  442. PANGO_AVAILABLE_IN_1_16
  443. PangoLayoutRun *pango_layout_iter_get_run_readonly (PangoLayoutIter *iter);
  444. PANGO_AVAILABLE_IN_ALL
  445. PangoLayoutLine *pango_layout_iter_get_line (PangoLayoutIter *iter);
  446. PANGO_AVAILABLE_IN_1_16
  447. PangoLayoutLine *pango_layout_iter_get_line_readonly (PangoLayoutIter *iter);
  448. PANGO_AVAILABLE_IN_ALL
  449. gboolean pango_layout_iter_at_last_line (PangoLayoutIter *iter);
  450. PANGO_AVAILABLE_IN_1_20
  451. PangoLayout *pango_layout_iter_get_layout (PangoLayoutIter *iter);
  452. PANGO_AVAILABLE_IN_ALL
  453. gboolean pango_layout_iter_next_char (PangoLayoutIter *iter);
  454. PANGO_AVAILABLE_IN_ALL
  455. gboolean pango_layout_iter_next_cluster (PangoLayoutIter *iter);
  456. PANGO_AVAILABLE_IN_ALL
  457. gboolean pango_layout_iter_next_run (PangoLayoutIter *iter);
  458. PANGO_AVAILABLE_IN_ALL
  459. gboolean pango_layout_iter_next_line (PangoLayoutIter *iter);
  460. PANGO_AVAILABLE_IN_ALL
  461. void pango_layout_iter_get_char_extents (PangoLayoutIter *iter,
  462. PangoRectangle *logical_rect);
  463. PANGO_AVAILABLE_IN_ALL
  464. void pango_layout_iter_get_cluster_extents (PangoLayoutIter *iter,
  465. PangoRectangle *ink_rect,
  466. PangoRectangle *logical_rect);
  467. PANGO_AVAILABLE_IN_ALL
  468. void pango_layout_iter_get_run_extents (PangoLayoutIter *iter,
  469. PangoRectangle *ink_rect,
  470. PangoRectangle *logical_rect);
  471. PANGO_AVAILABLE_IN_ALL
  472. void pango_layout_iter_get_line_extents (PangoLayoutIter *iter,
  473. PangoRectangle *ink_rect,
  474. PangoRectangle *logical_rect);
  475. /* All the yranges meet, unlike the logical_rect's (i.e. the yranges
  476. * assign between-line spacing to the nearest line)
  477. */
  478. PANGO_AVAILABLE_IN_ALL
  479. void pango_layout_iter_get_line_yrange (PangoLayoutIter *iter,
  480. int *y0_,
  481. int *y1_);
  482. PANGO_AVAILABLE_IN_ALL
  483. void pango_layout_iter_get_layout_extents (PangoLayoutIter *iter,
  484. PangoRectangle *ink_rect,
  485. PangoRectangle *logical_rect);
  486. PANGO_AVAILABLE_IN_ALL
  487. int pango_layout_iter_get_baseline (PangoLayoutIter *iter);
  488. PANGO_AVAILABLE_IN_1_50
  489. int pango_layout_iter_get_run_baseline (PangoLayoutIter *iter);
  490. G_DEFINE_AUTOPTR_CLEANUP_FUNC(PangoLayout, g_object_unref)
  491. G_DEFINE_AUTOPTR_CLEANUP_FUNC(PangoLayoutIter, pango_layout_iter_free)
  492. G_END_DECLS
  493. #endif /* __PANGO_LAYOUT_H__ */