← Back to branch summary

~ubuntu-branches/ubuntu/trusty/guile-gnome-platform/trusty-proposed

« back to all changes in this revision

Viewing changes to pango/doc/pango/defuns-layout.xml.texi

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Rottmann
  • Date: 2009-03-01 22:51:48 UTC
  • mfrom: (1.1.2 upstream) (3.2.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090301225148-5cubt342wiv8jpmf
Tags: 2.16.1-1
* New upstream release.
* Upstream bumped API, hence all package names changed from
  guile-gnome0-* to guile-gnome2-*.
* Standards-Version 3.8.0 (no changes).
* Remove unused guile-gnome2-cairo.install file.
* Added ${misc:Depends} to all packages.
* Do not build-depend on a -1 revision of the g-wrap packages.
* Add a proper "Copyright YEARS AUTHORS" line to debian/copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
pango/doc/pango/defuns-layout.xml.texi
1
1
 
2
2
@c %start of fragment
3
3
 
4
 
@deffn Function pango-layout-new  (context@tie{}@code{<pango-context*>}) @result{}@tie{} (ret@tie{}@code{<pango-layout*>})
 
4
@deftp Class <pango-layout>
 
5
Derives from @code{<gobject>}.
 
6
 
 
7
This class defines no direct slots.
 
8
 
 
9
@end deftp
 
10
 
 
11
@deftp Class <pango-layout-iter>
 
12
Derives from @code{<gboxed>}.
 
13
 
 
14
This class defines no direct slots.
 
15
 
 
16
@end deftp
 
17
 
 
18
@deftp Class <pango-layout-line>
 
19
Derives from @code{<gboxed>}.
 
20
 
 
21
This class defines no direct slots.
 
22
 
 
23
@end deftp
 
24
 
 
25
@deffn Function pango-layout-new  (context@tie{}@code{<pango-context>}) @result{}@tie{} (ret@tie{}@code{<pango-layout>})
5
26
Create a new @code{<pango-layout>} object with attributes initialized to default
6
27
values for a particular @code{<pango-context>}.
7
28
 
17
38
 
18
39
@end deffn
19
40
 
20
 
@deffn Function pango-layout-get-context  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-context*>})
 
41
@deffn Function pango-layout-copy  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-layout>})
 
42
@deffnx Method copy
 
43
Does a deep copy-by-value of the @var{src} layout. The attribute list, tab
 
44
array, and text from the original layout are all copied by value.
 
45
 
 
46
@table @var
 
47
@item src
 
48
a @code{<pango-layout>}
 
49
 
 
50
@item ret
 
51
the newly allocated @code{<pango-layout>}, with a reference count of one, which
 
52
should be freed with @code{g-object-unref}.
 
53
 
 
54
@end table
 
55
 
 
56
@end deffn
 
57
 
 
58
@deffn Function pango-layout-get-context  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-context>})
 
59
@deffnx Method get-context
21
60
Retrieves the @code{<pango-context>} used for this layout.
22
61
 
23
62
@table @var
33
72
 
34
73
@end deffn
35
74
 
36
 
@deffn Function pango-layout-context-changed  (self@tie{}@code{<pango-layout*>})
 
75
@deffn Function pango-layout-context-changed  (self@tie{}@code{<pango-layout>})
 
76
@deffnx Method context-changed
37
77
Forces recomputation of any state in the @code{<pango-layout>} that might depend
38
78
on the layout's context. This function should be called if you make changes to
39
79
the context subsequent to creating the layout.
46
86
 
47
87
@end deffn
48
88
 
49
 
@deffn Function pango-layout-set-text  (self@tie{}@code{<pango-layout*>}) (text@tie{}@code{mchars}) (length@tie{}@code{int})
 
89
@deffn Function pango-layout-set-text  (self@tie{}@code{<pango-layout>}) (text@tie{}@code{mchars}) (length@tie{}@code{int})
 
90
@deffnx Method set-text
50
91
Sets the text of the layout.
51
92
 
52
93
@table @var
65
106
 
66
107
@end deffn
67
108
 
68
 
@deffn Function pango-layout-get-text  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{mchars})
 
109
@deffn Function pango-layout-get-text  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{mchars})
 
110
@deffnx Method get-text
69
111
Gets the text in the layout. The returned text should not be freed or modified.
70
112
 
71
113
@table @var
79
121
 
80
122
@end deffn
81
123
 
82
 
@deffn Function pango-layout-set-markup  (self@tie{}@code{<pango-layout*>}) (markup@tie{}@code{mchars}) (length@tie{}@code{int})
 
124
@deffn Function pango-layout-set-markup  (self@tie{}@code{<pango-layout>}) (markup@tie{}@code{mchars}) (length@tie{}@code{int})
 
125
@deffnx Method set-markup
83
126
Same as @code{pango-layout-set-markup-with-accel}, but the markup text isn't
84
127
scanned for accelerators.
85
128
 
97
140
 
98
141
@end deffn
99
142
 
100
 
@deffn Function pango-layout-set-markup-with-accel  (self@tie{}@code{<pango-layout*>}) (markup@tie{}@code{mchars}) (length@tie{}@code{int}) (accel_marker@tie{}@code{unsigned-int32}) @result{}@tie{} (accel_char@tie{}@code{unsigned-int32})
 
143
@deffn Function pango-layout-set-markup-with-accel  (self@tie{}@code{<pango-layout>}) (markup@tie{}@code{mchars}) (length@tie{}@code{int}) (accel_marker@tie{}@code{unsigned-int32}) @result{}@tie{} (accel_char@tie{}@code{unsigned-int32})
 
144
@deffnx Method set-markup-with-accel
101
145
Sets the layout text and attribute list from marked-up text (see markup format).
102
146
Replaces the current text and attribute list.
103
147
 
128
172
 
129
173
@end deffn
130
174
 
131
 
@deffn Function pango-layout-set-attributes  (self@tie{}@code{<pango-layout*>}) (attrs@tie{}@code{<pango-attr-list>})
 
175
@deffn Function pango-layout-set-attributes  (self@tie{}@code{<pango-layout>}) (attrs@tie{}@code{<pango-attr-list>})
 
176
@deffnx Method set-attributes
132
177
Sets the text attributes for a layout object.
133
178
 
134
179
@table @var
142
187
 
143
188
@end deffn
144
189
 
145
 
@deffn Function pango-layout-get-attributes  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-attr-list>})
 
190
@deffn Function pango-layout-get-attributes  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-attr-list>})
 
191
@deffnx Method get-attributes
146
192
Gets the attribute list for the layout, if any.
147
193
 
148
194
@table @var
156
202
 
157
203
@end deffn
158
204
 
159
 
@deffn Function pango-layout-set-font-description  (self@tie{}@code{<pango-layout*>}) (desc@tie{}@code{<pango-font-description>})
 
205
@deffn Function pango-layout-set-font-description  (self@tie{}@code{<pango-layout>}) (desc@tie{}@code{<pango-font-description>})
 
206
@deffnx Method set-font-description
160
207
Sets the default font description for the layout. If no font description is set
161
208
on the layout, the font description from the layout's context is used.
162
209
 
172
219
 
173
220
@end deffn
174
221
 
175
 
@deffn Function pango-layout-set-width  (self@tie{}@code{<pango-layout*>}) (width@tie{}@code{int})
 
222
@deffn Function pango-layout-set-width  (self@tie{}@code{<pango-layout>}) (width@tie{}@code{int})
 
223
@deffnx Method set-width
176
224
Sets the width to which the lines of the @code{<pango-layout>} should wrap.
177
225
 
178
226
@table @var
187
235
 
188
236
@end deffn
189
237
 
190
 
@deffn Function pango-layout-get-width  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{int})
 
238
@deffn Function pango-layout-get-width  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{int})
 
239
@deffnx Method get-width
191
240
Gets the width to which the lines of the @code{<pango-layout>} should wrap.
192
241
 
193
242
@table @var
201
250
 
202
251
@end deffn
203
252
 
204
 
@deffn Function pango-layout-set-wrap  (self@tie{}@code{<pango-layout*>}) (wrap@tie{}@code{<pango-wrap-mode>})
 
253
@deffn Function pango-layout-set-wrap  (self@tie{}@code{<pango-layout>}) (wrap@tie{}@code{<pango-wrap-mode>})
 
254
@deffnx Method set-wrap
205
255
Sets the wrap mode; the wrap mode only has effect if a width is set on the
206
256
layout with @code{pango-layout-set-width}. To turn off wrapping, set the width
207
257
to -1.
217
267
 
218
268
@end deffn
219
269
 
220
 
@deffn Function pango-layout-get-wrap  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-wrap-mode>})
 
270
@deffn Function pango-layout-get-wrap  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-wrap-mode>})
 
271
@deffnx Method get-wrap
221
272
Gets the wrap mode for the layout.
222
273
 
223
274
@table @var
231
282
 
232
283
@end deffn
233
284
 
234
 
@deffn Function pango-layout-set-ellipsize  (self@tie{}@code{<pango-layout*>}) (ellipsize@tie{}@code{<pango-ellipsize-mode>})
 
285
@deffn Function pango-layout-set-ellipsize  (self@tie{}@code{<pango-layout>}) (ellipsize@tie{}@code{<pango-ellipsize-mode>})
 
286
@deffnx Method set-ellipsize
235
287
Sets the type of ellipsization being performed for @var{layout}. Depending on
236
288
the ellipsization mode @var{ellipsize} text is removed from the start, middle,
237
289
or end of lines so they fit within the width of layout set with
253
305
 
254
306
@end deffn
255
307
 
256
 
@deffn Function pango-layout-get-ellipsize  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-ellipsize-mode>})
 
308
@deffn Function pango-layout-get-ellipsize  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-ellipsize-mode>})
 
309
@deffnx Method get-ellipsize
257
310
Gets the type of ellipsization being performed for @var{layout}. See
258
311
@code{pango-layout-set-ellipsize}
259
312
 
270
323
 
271
324
@end deffn
272
325
 
273
 
@deffn Function pango-layout-set-indent  (self@tie{}@code{<pango-layout*>}) (indent@tie{}@code{int})
 
326
@deffn Function pango-layout-set-indent  (self@tie{}@code{<pango-layout>}) (indent@tie{}@code{int})
 
327
@deffnx Method set-indent
274
328
Sets the width in Pango units to indent each paragraph. A negative value of
275
329
@var{indent} will produce a hanging indentation. That is, the first line will
276
330
have the full width, and subsequent lines will be indented by the absolute value
287
341
 
288
342
@end deffn
289
343
 
290
 
@deffn Function pango-layout-get-indent  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{int})
 
344
@deffn Function pango-layout-get-indent  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{int})
 
345
@deffnx Method get-indent
291
346
Gets the paragraph indent width in Pango units. A negative value indicates a
292
347
hanging indentation.
293
348
 
302
357
 
303
358
@end deffn
304
359
 
305
 
@deffn Function pango-layout-get-spacing  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{int})
 
360
@deffn Function pango-layout-get-spacing  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{int})
 
361
@deffnx Method get-spacing
306
362
Gets the amount of spacing in @code{<pango-glyph-unit>} between the lines of the
307
363
layout.
308
364
 
317
373
 
318
374
@end deffn
319
375
 
320
 
@deffn Function pango-layout-set-spacing  (self@tie{}@code{<pango-layout*>}) (spacing@tie{}@code{int})
 
376
@deffn Function pango-layout-set-spacing  (self@tie{}@code{<pango-layout>}) (spacing@tie{}@code{int})
 
377
@deffnx Method set-spacing
321
378
Sets the amount of spacing in @code{<pango-glyph-unit>} between the lines of the
322
379
layout.
323
380
 
332
389
 
333
390
@end deffn
334
391
 
335
 
@deffn Function pango-layout-set-justify  (self@tie{}@code{<pango-layout*>}) (justify@tie{}@code{bool})
 
392
@deffn Function pango-layout-set-justify  (self@tie{}@code{<pango-layout>}) (justify@tie{}@code{bool})
 
393
@deffnx Method set-justify
336
394
Sets whether each complete line should be stretched to fill the entire width of
337
395
the layout. This stretching is typically done by adding whitespace, but for some
338
396
scripts (such as Arabic), the justification may be done in more complex ways,
351
409
 
352
410
@end deffn
353
411
 
354
 
@deffn Function pango-layout-get-justify  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
412
@deffn Function pango-layout-get-justify  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{bool})
 
413
@deffnx Method get-justify
355
414
Gets whether each complete line should be stretched to fill the entire width of
356
415
the layout.
357
416
 
366
425
 
367
426
@end deffn
368
427
 
369
 
@deffn Function pango-layout-set-auto-dir  (self@tie{}@code{<pango-layout*>}) (auto_dir@tie{}@code{bool})
 
428
@deffn Function pango-layout-set-auto-dir  (self@tie{}@code{<pango-layout>}) (auto_dir@tie{}@code{bool})
 
429
@deffnx Method set-auto-dir
370
430
Sets whether to calculate the bidirectional base direction for the layout
371
431
according to the contents of the layout; when this flag is on (the default),
372
432
then paragraphs in @var{layout} that begin with strong right-to-left characters
396
456
 
397
457
@end deffn
398
458
 
399
 
@deffn Function pango-layout-get-auto-dir  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
459
@deffn Function pango-layout-get-auto-dir  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{bool})
 
460
@deffnx Method get-auto-dir
400
461
Gets whether to calculate the bidirectional base direction for the layout
401
462
according to the contents of the layout. See @code{pango-layout-set-auto-dir}.
402
463
 
414
475
 
415
476
@end deffn
416
477
 
417
 
@deffn Function pango-layout-set-alignment  (self@tie{}@code{<pango-layout*>}) (alignment@tie{}@code{<pango-alignment>})
 
478
@deffn Function pango-layout-set-alignment  (self@tie{}@code{<pango-layout>}) (alignment@tie{}@code{<pango-alignment>})
 
479
@deffnx Method set-alignment
418
480
Sets the alignment for the layout: how partial lines are positioned within the
419
481
horizontal space available.
420
482
 
429
491
 
430
492
@end deffn
431
493
 
432
 
@deffn Function pango-layout-get-alignment  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-alignment>})
 
494
@deffn Function pango-layout-get-alignment  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-alignment>})
 
495
@deffnx Method get-alignment
433
496
Gets the alignment for the layout: how partial lines are positioned within the
434
497
horizontal space available.
435
498
 
444
507
 
445
508
@end deffn
446
509
 
447
 
@deffn Function pango-layout-set-tabs  (self@tie{}@code{<pango-layout*>}) (tabs@tie{}@code{<pango-tab-array>})
 
510
@deffn Function pango-layout-set-tabs  (self@tie{}@code{<pango-layout>}) (tabs@tie{}@code{<pango-tab-array>})
 
511
@deffnx Method set-tabs
448
512
Sets the tabs to use for @var{layout}, overriding the default tabs (by default,
449
513
tabs are every 8 spaces). If @var{tabs} is @samp{@code{#f}}, the default tabs
450
514
are reinstated. @var{tabs} is copied into the layout; you must free your copy of
461
525
 
462
526
@end deffn
463
527
 
464
 
@deffn Function pango-layout-get-tabs  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-tab-array>})
 
528
@deffn Function pango-layout-get-tabs  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-tab-array>})
 
529
@deffnx Method get-tabs
465
530
Gets the current @code{<pango-tab-array>} used by this layout. If no
466
531
@code{<pango-tab-array>} has been set, then the default tabs are in use and
467
532
@samp{@code{#f}} is returned. Default tabs are every 8 spaces. The return value
478
543
 
479
544
@end deffn
480
545
 
481
 
@deffn Function pango-layout-get-log-attrs  (self@tie{}@code{<pango-layout*>}) (attrs@tie{}@code{<pango-log-attr**>}) @result{}@tie{} (n_attrs@tie{}@code{int})
482
 
Retrieves an array of logical attributes for each character in the @var{layout}.
483
 
 
484
 
@table @var
485
 
@item layout
486
 
a @code{<pango-layout>}
487
 
 
488
 
@item attrs
489
 
location to store a pointer to an array of logical attributes This value must be
490
 
freed with @code{g-free}.
491
 
 
492
 
@item n-attrs
493
 
location to store the number of the attributes in the array. (The stored value
494
 
will be one more than the total number of characters in the layout, since there
495
 
need to be attributes corresponding to both the position before the first
496
 
character and the position after the last character.)
497
 
 
498
 
@end table
499
 
 
500
 
@end deffn
501
 
 
502
 
@deffn Function pango-layout-index-to-pos  (self@tie{}@code{<pango-layout*>}) (index_@tie{}@code{int}) (pos@tie{}@code{<pango-rectangle*>})
 
546
@deffn Function pango-layout-index-to-pos  (self@tie{}@code{<pango-layout>}) (index_@tie{}@code{int}) @result{}@tie{} (pos@tie{}@code{<pango-rectangle>})
 
547
@deffnx Method index-to-pos
503
548
Converts from an index within a @code{<pango-layout>} to the onscreen position
504
549
corresponding to the grapheme at that index, which is represented as rectangle.
505
550
Note that @samp{pos->x} is always the leading edge of the grapheme and
521
566
 
522
567
@end deffn
523
568
 
524
 
@deffn Function pango-layout-index-to-line-x  (self@tie{}@code{<pango-layout*>}) (index_@tie{}@code{int}) (trailing@tie{}@code{bool}) @result{}@tie{} (line@tie{}@code{int}) (x_pos@tie{}@code{int})
 
569
@deffn Function pango-layout-index-to-line-x  (self@tie{}@code{<pango-layout>}) (index_@tie{}@code{int}) (trailing@tie{}@code{bool}) @result{}@tie{} (line@tie{}@code{int}) (x_pos@tie{}@code{int})
 
570
@deffnx Method index-to-line-x
525
571
Converts from byte @var{index} within the @var{layout} to line and X position.
526
572
(X position is measured from the left edge of the line)
527
573
 
548
594
 
549
595
@end deffn
550
596
 
551
 
@deffn Function pango-layout-xy-to-index  (self@tie{}@code{<pango-layout*>}) (x@tie{}@code{int}) (y@tie{}@code{int}) @result{}@tie{} (ret@tie{}@code{bool}) (index_@tie{}@code{int}) (trailing@tie{}@code{int})
 
597
@deffn Function pango-layout-xy-to-index  (self@tie{}@code{<pango-layout>}) (x@tie{}@code{int}) (y@tie{}@code{int}) @result{}@tie{} (ret@tie{}@code{bool}) (index_@tie{}@code{int}) (trailing@tie{}@code{int})
 
598
@deffnx Method xy-to-index
552
599
Converts from X and Y position within a layout to the byte index to the
553
600
character at that logical position. If the Y position is not inside the layout,
554
601
the closest position is chosen (the position will be clamped inside the layout).
583
630
 
584
631
@end deffn
585
632
 
586
 
@deffn Function pango-layout-get-cursor-pos  (self@tie{}@code{<pango-layout*>}) (index_@tie{}@code{int}) (strong_pos@tie{}@code{<pango-rectangle*>}) (weak_pos@tie{}@code{<pango-rectangle*>})
 
633
@deffn Function pango-layout-get-cursor-pos  (self@tie{}@code{<pango-layout>}) (index_@tie{}@code{int}) @result{}@tie{} (strong_pos@tie{}@code{<pango-rectangle>}) (weak_pos@tie{}@code{<pango-rectangle>})
 
634
@deffnx Method get-cursor-pos
587
635
Given an index within a layout, determines the positions that of the strong and
588
636
weak cursors if the insertion point is at that index. The position of each
589
637
cursor is stored as a zero-width rectangle. The strong cursor location is the
609
657
 
610
658
@end deffn
611
659
 
612
 
@deffn Function pango-layout-move-cursor-visually  (self@tie{}@code{<pango-layout*>}) (strong@tie{}@code{bool}) (old_index@tie{}@code{int}) (old_trailing@tie{}@code{int}) (direction@tie{}@code{int}) @result{}@tie{} (new_index@tie{}@code{int}) (new_trailing@tie{}@code{int})
 
660
@deffn Function pango-layout-move-cursor-visually  (self@tie{}@code{<pango-layout>}) (strong@tie{}@code{bool}) (old_index@tie{}@code{int}) (old_trailing@tie{}@code{int}) (direction@tie{}@code{int}) @result{}@tie{} (new_index@tie{}@code{int}) (new_trailing@tie{}@code{int})
 
661
@deffnx Method move-cursor-visually
613
662
Computes a new cursor position from an old position and a count of positions to
614
663
move visually. If @var{count} is positive, then the new strong cursor position
615
664
will be one position to the right of the old cursor position. If @var{count} is
660
709
 
661
710
@end deffn
662
711
 
663
 
@deffn Function pango-layout-get-extents  (self@tie{}@code{<pango-layout*>}) (ink_rect@tie{}@code{<pango-rectangle*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
712
@deffn Function pango-layout-get-extents  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ink_rect@tie{}@code{<pango-rectangle>}) (logical_rect@tie{}@code{<pango-rectangle>})
 
713
@deffnx Method get-extents
664
714
Computes the logical and ink extents of @var{layout}. Logical extents are
665
715
usually what you want for positioning things. Note that both extents may have
666
716
non-zero x and y. You may want to use those to offset where you render the
686
736
 
687
737
@end deffn
688
738
 
689
 
@deffn Function pango-layout-get-pixel-extents  (self@tie{}@code{<pango-layout*>}) (ink_rect@tie{}@code{<pango-rectangle*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
739
@deffn Function pango-layout-get-pixel-extents  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ink_rect@tie{}@code{<pango-rectangle>}) (logical_rect@tie{}@code{<pango-rectangle>})
 
740
@deffnx Method get-pixel-extents
690
741
Computes the logical and ink extents of @var{layout} in device units. See
691
742
@code{pango-layout-get-extents}; this function just calls
692
743
@code{pango-layout-get-extents} and then converts the extents to device units
708
759
 
709
760
@end deffn
710
761
 
711
 
@deffn Function pango-layout-get-size  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (width@tie{}@code{int}) (height@tie{}@code{int})
 
762
@deffn Function pango-layout-get-size  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (width@tie{}@code{int}) (height@tie{}@code{int})
 
763
@deffnx Method get-size
712
764
Determines the logical width and height of a @code{<pango-layout>} in Pango
713
765
units. (device units scaled by @samp{PANGO_SCALE}). This is simply a convenience
714
766
function around @code{pango-layout-get-extents}.
727
779
 
728
780
@end deffn
729
781
 
730
 
@deffn Function pango-layout-get-pixel-size  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (width@tie{}@code{int}) (height@tie{}@code{int})
 
782
@deffn Function pango-layout-get-pixel-size  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (width@tie{}@code{int}) (height@tie{}@code{int})
 
783
@deffnx Method get-pixel-size
731
784
Determines the logical width and height of a @code{<pango-layout>} in device
732
785
units. (@code{pango-layout-get-size} returns the width and height scaled by
733
786
@samp{PANGO_SCALE}.) This is simply a convenience function around
747
800
 
748
801
@end deffn
749
802
 
750
 
@deffn Function pango-layout-get-line-count  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{int})
 
803
@deffn Function pango-layout-get-line-count  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{int})
 
804
@deffnx Method get-line-count
751
805
Retrieves the count of lines for the @var{layout}.
752
806
 
753
807
@table @var
761
815
 
762
816
@end deffn
763
817
 
764
 
@deffn Function pango-layout-get-line  (self@tie{}@code{<pango-layout*>}) (line@tie{}@code{int}) @result{}@tie{} (ret@tie{}@code{<pango-layout-line*>})
 
818
@deffn Function pango-layout-get-line  (self@tie{}@code{<pango-layout>}) (line@tie{}@code{int}) @result{}@tie{} (ret@tie{}@code{<pango-layout-line>})
 
819
@deffnx Method get-line
765
820
Retrieves a particular line from a @code{<pango-layout>}.
766
821
 
767
822
@table @var
781
836
 
782
837
@end deffn
783
838
 
784
 
@deffn Function pango-layout-get-lines  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{gslist-of})
 
839
@deffn Function pango-layout-get-lines  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{gslist-of})
 
840
@deffnx Method get-lines
785
841
Returns the lines of the @var{layout} as a list.
786
842
 
787
843
@table @var
797
853
 
798
854
@end deffn
799
855
 
800
 
@deffn Function pango-layout-get-iter  (self@tie{}@code{<pango-layout*>}) @result{}@tie{} (ret@tie{}@code{<pango-layout-iter*>})
 
856
@deffn Function pango-layout-get-iter  (self@tie{}@code{<pango-layout>}) @result{}@tie{} (ret@tie{}@code{<pango-layout-iter>})
 
857
@deffnx Method get-iter
801
858
Returns an iterator to iterate over the visual extents of the layout.
802
859
 
803
860
@table @var
812
869
 
813
870
@end deffn
814
871
 
815
 
@deffn Function pango-layout-iter-next-run  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
872
@deffn Function pango-layout-iter-next-run  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{bool})
816
873
Moves @var{iter} forward to the next run in visual order. If @var{iter} was
817
874
already at the end of the layout, returns @samp{@code{#f}}.
818
875
 
827
884
 
828
885
@end deffn
829
886
 
830
 
@deffn Function pango-layout-iter-next-char  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
887
@deffn Function pango-layout-iter-next-char  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{bool})
831
888
Moves @var{iter} forward to the next character in visual order. If @var{iter}
832
889
was already at the end of the layout, returns @samp{@code{#f}}.
833
890
 
842
899
 
843
900
@end deffn
844
901
 
845
 
@deffn Function pango-layout-iter-next-cluster  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
902
@deffn Function pango-layout-iter-next-cluster  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{bool})
846
903
Moves @var{iter} forward to the next cluster in visual order. If @var{iter} was
847
904
already at the end of the layout, returns @samp{@code{#f}}.
848
905
 
857
914
 
858
915
@end deffn
859
916
 
860
 
@deffn Function pango-layout-iter-next-line  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
917
@deffn Function pango-layout-iter-next-line  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{bool})
861
918
Moves @var{iter} forward to the start of the next line. If @var{iter} is already
862
919
on the last line, returns @samp{@code{#f}}.
863
920
 
872
929
 
873
930
@end deffn
874
931
 
875
 
@deffn Function pango-layout-iter-at-last-line  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{bool})
 
932
@deffn Function pango-layout-iter-at-last-line  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{bool})
876
933
Determines whether @var{iter} is on the last line of the layout.
877
934
 
878
935
@table @var
886
943
 
887
944
@end deffn
888
945
 
889
 
@deffn Function pango-layout-iter-get-index  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{int})
 
946
@deffn Function pango-layout-iter-get-index  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{int})
890
947
Gets the current byte index. Note that iterating forward by char moves in visual
891
948
order, not logical order, so indexes may not be sequential. Also, the index may
892
949
be equal to the length of the text in the layout, if on the @samp{@code{#f}} run
903
960
 
904
961
@end deffn
905
962
 
906
 
@deffn Function pango-layout-iter-get-baseline  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{int})
 
963
@deffn Function pango-layout-iter-get-baseline  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{int})
907
964
Gets the Y position of the current line's baseline, in layout coordinates
908
965
(origin at top left of the entire layout).
909
966
 
918
975
 
919
976
@end deffn
920
977
 
921
 
@deffn Function pango-layout-iter-get-run  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{<pango-layout-run*>})
922
 
Gets the current run. When iterating by run, at the end of each line, there's a
923
 
position with a @samp{@code{#f}} run, so this function can return
924
 
@samp{@code{#f}}. The @samp{@code{#f}} run at the end of each line ensures that
925
 
all lines have at least one run, even lines consisting of only a newline.
926
 
 
927
 
@table @var
928
 
@item iter
929
 
a @code{<pango-layout-iter>}
930
 
 
931
 
@item ret
932
 
the current run.
933
 
 
934
 
@end table
935
 
 
936
 
@end deffn
937
 
 
938
 
@deffn Function pango-layout-iter-get-line  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (ret@tie{}@code{<pango-layout-line*>})
 
978
@deffn Function pango-layout-iter-get-line  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ret@tie{}@code{<pango-layout-line>})
939
979
Gets the current line.
940
980
 
941
981
@table @var
949
989
 
950
990
@end deffn
951
991
 
952
 
@deffn Function pango-layout-iter-get-char-extents  (self@tie{}@code{<pango-layout-iter*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
992
@deffn Function pango-layout-iter-get-char-extents  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (logical_rect@tie{}@code{<pango-rectangle>})
953
993
Gets the extents of the current character, in layout coordinates (origin is the
954
994
top left of the entire layout). Only logical extents can sensibly be obtained
955
995
for characters; ink extents make sense only down to the level of clusters.
965
1005
 
966
1006
@end deffn
967
1007
 
968
 
@deffn Function pango-layout-iter-get-run-extents  (self@tie{}@code{<pango-layout-iter*>}) (ink_rect@tie{}@code{<pango-rectangle*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
1008
@deffn Function pango-layout-iter-get-run-extents  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ink_rect@tie{}@code{<pango-rectangle>}) (logical_rect@tie{}@code{<pango-rectangle>})
969
1009
Gets the extents of the current run in layout coordinates (origin is the top
970
1010
left of the entire layout).
971
1011
 
983
1023
 
984
1024
@end deffn
985
1025
 
986
 
@deffn Function pango-layout-iter-get-line-yrange  (self@tie{}@code{<pango-layout-iter*>}) @result{}@tie{} (y0_@tie{}@code{int}) (y1_@tie{}@code{int})
 
1026
@deffn Function pango-layout-iter-get-line-yrange  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (y0_@tie{}@code{int}) (y1_@tie{}@code{int})
987
1027
Divides the vertical space in the @code{<pango-layout>} being iterated over
988
1028
between the lines in the layout, and returns the space belonging to the current
989
1029
line. A line's range includes the line's logical extents, plus half of the
1005
1045
 
1006
1046
@end deffn
1007
1047
 
1008
 
@deffn Function pango-layout-iter-get-line-extents  (self@tie{}@code{<pango-layout-iter*>}) (ink_rect@tie{}@code{<pango-rectangle*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
1048
@deffn Function pango-layout-iter-get-line-extents  (self@tie{}@code{<pango-layout-iter>}) @result{}@tie{} (ink_rect@tie{}@code{<pango-rectangle>}) (logical_rect@tie{}@code{<pango-rectangle>})
1009
1049
Obtains the extents of the current line. @var{ink-rect} or @var{logical-rect}
1010
1050
can be NULL if you aren't interested in them. Extents are in layout coordinates
1011
1051
(origin is the top-left corner of the entire @code{<pango-layout>}). Thus the
1026
1066
 
1027
1067
@end deffn
1028
1068
 
1029
 
@deffn Function pango-layout-line-get-extents  (self@tie{}@code{<pango-layout-line*>}) (ink_rect@tie{}@code{<pango-rectangle*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
1069
@deffn Function pango-layout-line-get-extents  (self@tie{}@code{<pango-layout-line>}) @result{}@tie{} (ink_rect@tie{}@code{<pango-rectangle>}) (logical_rect@tie{}@code{<pango-rectangle>})
1030
1070
Computes the logical and ink extents of a layout line. See
1031
1071
@code{pango-font-get-glyph-extents} for details about the interpretation of the
1032
1072
rectangles.
1047
1087
 
1048
1088
@end deffn
1049
1089
 
1050
 
@deffn Function pango-layout-line-get-pixel-extents  (self@tie{}@code{<pango-layout-line*>}) (ink_rect@tie{}@code{<pango-rectangle*>}) (logical_rect@tie{}@code{<pango-rectangle*>})
 
1090
@deffn Function pango-layout-line-get-pixel-extents  (self@tie{}@code{<pango-layout-line>}) @result{}@tie{} (ink_rect@tie{}@code{<pango-rectangle>}) (logical_rect@tie{}@code{<pango-rectangle>})
1051
1091
Computes the logical and ink extents of a layout line. See
1052
1092
@code{pango-font-get-glyph-extents} for details about the interpretation of the
1053
1093
rectangles. The returned rectangles are in device units, as opposed to
1070
1110
 
1071
1111
@end deffn
1072
1112
 
1073
 
@deffn Function pango-layout-line-index-to-x  (self@tie{}@code{<pango-layout-line*>}) (index_@tie{}@code{int}) (trailing@tie{}@code{bool}) @result{}@tie{} (x_pos@tie{}@code{int})
 
1113
@deffn Function pango-layout-line-index-to-x  (self@tie{}@code{<pango-layout-line>}) (index_@tie{}@code{int}) (trailing@tie{}@code{bool}) @result{}@tie{} (x_pos@tie{}@code{int})
1074
1114
Converts an index within a line to a X position.
1075
1115
 
1076
1116
@table @var
1091
1131
 
1092
1132
@end deffn
1093
1133
 
1094
 
@deffn Function pango-layout-line-x-to-index  (self@tie{}@code{<pango-layout-line*>}) (x_pos@tie{}@code{int}) @result{}@tie{} (ret@tie{}@code{bool}) (index_@tie{}@code{int}) (trailing@tie{}@code{int})
 
1134
@deffn Function pango-layout-line-x-to-index  (self@tie{}@code{<pango-layout-line>}) (x_pos@tie{}@code{int}) @result{}@tie{} (ret@tie{}@code{bool}) (index_@tie{}@code{int}) (trailing@tie{}@code{int})
1095
1135
Converts from x offset to the byte index of the corresponding character within
1096
1136
the text of the layout. If @var{x-pos} is outside the line, @var{index} and
1097
1137
@var{trailing} will point to the very first or very last position in the line.
1126
1166
 
1127
1167
@end deffn
1128
1168
 
1129
 
@deffn Function pango-layout-line-get-x-ranges  (self@tie{}@code{<pango-layout-line*>}) (start_index@tie{}@code{int}) (end_index@tie{}@code{int}) (ranges@tie{}@code{<int**>}) @result{}@tie{} (n_ranges@tie{}@code{int})
1130
 
Gets a list of visual ranges corresponding to a given logical range. This list
1131
 
is not necessarily minimal - there may be consecutive ranges which are adjacent.
1132
 
The ranges will be sorted from left to right. The ranges are with respect to the
1133
 
left edge of the entire layout, not with respect to the line.
1134
 
 
1135
 
@table @var
1136
 
@item line
1137
 
a @code{<pango-layout-line>}
1138
 
 
1139
 
@item start-index
1140
 
Start byte index of the logical range. If this value is less than the start
1141
 
index for the line, then the first range will extend all the way to the leading
1142
 
edge of the layout. Otherwise it will start at the leading edge of the first
1143
 
character.
1144
 
 
1145
 
@item end-index
1146
 
Ending byte index of the logical range. If this value is greater than the end
1147
 
index for the line, then the last range will extend all the way to the trailing
1148
 
edge of the layout. Otherwise, it will end at the trailing edge of the last
1149
 
character.
1150
 
 
1151
 
@item ranges
1152
 
location to store a pointer to an array of ranges. The array will be of length
1153
 
@samp{2*n_ranges}, with each range starting at @samp{(*ranges)[2*n]} and of
1154
 
width @samp{(*ranges)[2*n + 1] - (*ranges)[2*n]}. This array must be freed with
1155
 
@code{g-free}. The coordinates are relative to the layout and are in
1156
 
@code{<pango-glyph-unit>}.
1157
 
 
1158
 
@item n-ranges
1159
 
The number of ranges stored in @var{ranges}.
1160
 
 
1161
 
@end table
1162
 
 
1163
 
@end deffn
1164
 
 
1165
1169
 
1166
1170
@c %end of fragment