1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Pango::LayoutIter Class Reference</h1>A PangoLayoutIter C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="pango_2layout_8hh-source.html">gfc/pango/layout.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Pango::LayoutIter:
<p><center><img src="classGFC_1_1Pango_1_1LayoutIter.png" usemap="#GFC::Pango::LayoutIter_map" border="0" alt=""></center>
<map name="GFC::Pango::LayoutIter_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,142,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,142,24">
</map>
<a href="classGFC_1_1Pango_1_1LayoutIter-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1191_0">LayoutIter</a> (PangoLayoutIter *iter)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a> from an existing PangoLayoutIter. <a href="#z1191_0"></a><br></dl><li><a class="anchor" name="z1191_1" doxytag="GFC::Pango::LayoutIter::~LayoutIter" ></a>
<a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1191_1">~LayoutIter</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1192_0" doxytag="GFC::Pango::LayoutIter::pango_layout_iter" ></a>
PangoLayoutIter * <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_0">pango_layout_iter</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoLayoutIter structure. <br></dl><li><a class="anchor" name="z1192_1" doxytag="GFC::Pango::LayoutIter::operator PangoLayoutIter *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_1">operator PangoLayoutIter *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a> to a PangoLayoutIter pointer. <br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_2">get_index</a> () const
<dl class="el"><dd class="mdescRight">Gets the current byte index. <a href="#z1192_2"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1LayoutRun.html">LayoutRun</a> * <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_3">get_run</a> () const
<dl class="el"><dd class="mdescRight">Gets the current run. <a href="#z1192_3"></a><br></dl><li><a class="anchor" name="z1192_4" doxytag="GFC::Pango::LayoutIter::get_line" ></a>
<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> > <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_4">get_line</a> () const
<dl class="el"><dd class="mdescRight">Returns a smart pointer to the current line. <br></dl><li><a class="anchor" name="z1192_5" doxytag="GFC::Pango::LayoutIter::at_last_line" ></a>
bool <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_5">at_last_line</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the iterator is on the last line of the layout. <br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_6">get_char_extents</a> (<a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> &logical_rect) const
<dl class="el"><dd class="mdescRight">Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout). <a href="#z1192_6"></a><br></dl><li><a class="anchor" name="z1192_7" doxytag="GFC::Pango::LayoutIter::get_char_extents" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_7">get_char_extents</a> () const
<dl class="el"><dd class="mdescRight">Returns the extents of the current character, in layout coordinates (see <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_6">get_char_extents(Rectangle&) const</a>). <br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_8">get_cluster_extents</a> (<a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *ink_rect, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *logical_rect) const
<dl class="el"><dd class="mdescRight">Gets the extents of the current cluster, in layout coordinates (origin is the top left of the entire layout). <a href="#z1192_8"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_9">get_run_extents</a> (<a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *ink_rect, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *logical_rect) const
<dl class="el"><dd class="mdescRight">Gets the extents of the current run in layout coordinates (origin is the top left of the entire layout). <a href="#z1192_9"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_10">get_line_extents</a> (<a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *ink_rect, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *logical_rect) const
<dl class="el"><dd class="mdescRight">Obtains the extents of the current line. <a href="#z1192_10"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_11">get_line_yrange</a> (int *y0, int *y1) const
<dl class="el"><dd class="mdescRight">Divides the vertical space in the <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> being iterated over between the lines in the layout, and returns the space belonging to the current line. <a href="#z1192_11"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_12">get_layout_extents</a> (<a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *ink_rect, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *logical_rect) const
<dl class="el"><dd class="mdescRight">Obtains the extents of the <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> being iterated over. <a href="#z1192_12"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_13">get_baseline</a> () const
<dl class="el"><dd class="mdescRight">Gets the y position of the current line's baseline, in layout coordinates (origin at top left of the entire layout). <a href="#z1192_13"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1193_0">next_char</a> ()
<dl class="el"><dd class="mdescRight">Moves the iterator forward to the next character in visual order. <a href="#z1193_0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1193_1">next_cluster</a> ()
<dl class="el"><dd class="mdescRight">Moves the iterator forward to the next cluster in visual order. <a href="#z1193_1"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1193_2">next_run</a> ()
<dl class="el"><dd class="mdescRight">Moves the iterator forward to the next run in visual order. <a href="#z1193_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1193_3">next_line</a> ()
<dl class="el"><dd class="mdescRight">Moves the iterator forward to the next line in visual order. <a href="#z1193_3"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoLayoutIter C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a> can be used to iterate over the visual extents of a <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a>.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1191_0" doxytag="GFC::Pango::LayoutIter::LayoutIter" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Pango::LayoutIter::LayoutIter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoLayoutIter * </td>
<td class="mdname1" valign="top" nowrap> <em>iter</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a> from an existing PangoLayoutIter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>iter</em> </td><td>A pointer to a PangoLayoutIter.</td></tr>
</table>
</dl>
<br>
<a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a> takes over the ownership of PangoLayoutIter and frees it when it's no longer required. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1192_13" doxytag="GFC::Pango::LayoutIter::get_baseline" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int GFC::Pango::LayoutIter::get_baseline </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the y position of the current line's baseline, in layout coordinates (origin at top left of the entire layout).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The baseline of the current line. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1192_6" doxytag="GFC::Pango::LayoutIter::get_char_extents" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::LayoutIter::get_char_extents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>logical_rect</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>logical_rect</em> </td><td>The rectangle to fill with logical extents.</td></tr>
</table>
</dl>
Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>logical_rect</em> </td><td>The rectangle to fill with logical extents. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1192_8" doxytag="GFC::Pango::LayoutIter::get_cluster_extents" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::LayoutIter::get_cluster_extents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>ink_rect</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>logical_rect</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the extents of the current cluster, in layout coordinates (origin is the top left of the entire layout).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ink_rect</em> </td><td>The rectangle to fill with the ink extents. </td></tr>
<tr><td></td><td valign=top><em>logical_rect</em> </td><td>The rectangle to fill with the logical extents. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1192_2" doxytag="GFC::Pango::LayoutIter::get_index" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int GFC::Pango::LayoutIter::get_index </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the current byte index.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current byte index.</dd></dl>
<br>
Note that iterating forward by char moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout, if on the null run (see <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html#z1192_3">get_run()</a>). </td>
</tr>
</table>
<a class="anchor" name="z1192_12" doxytag="GFC::Pango::LayoutIter::get_layout_extents" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::LayoutIter::get_layout_extents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>ink_rect</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>logical_rect</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the extents of the <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> being iterated over.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ink_rect</em> </td><td>The rectangle to fill with the ink extents. </td></tr>
<tr><td></td><td valign=top><em>logical_rect</em> </td><td>The rectangle to fill with the logical extents.</td></tr>
</table>
</dl>
<br>
<em>ink_rect</em> or <em>logical_rect</em> can be null if you aren't interested in them. </td>
</tr>
</table>
<a class="anchor" name="z1192_10" doxytag="GFC::Pango::LayoutIter::get_line_extents" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::LayoutIter::get_line_extents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>ink_rect</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>logical_rect</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Obtains the extents of the current line.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ink_rect</em> </td><td>The rectangle to fill with the ink extents. </td></tr>
<tr><td></td><td valign=top><em>logical_rect</em> </td><td>The rectangle to fill with the logical extents.</td></tr>
</table>
</dl>
<br>
<em>ink_rect</em> or <em>logical_rect</em> can be null if you aren't interested in them. Extents are in layout coordinates (origin is the top-left corner of the entire <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a>). Thus the extents returned by this method will be the same width/height but not at the same x/y as the extents returned from <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_6">Pango::LayoutLine::get_extents()</a>. </td>
</tr>
</table>
<a class="anchor" name="z1192_11" doxytag="GFC::Pango::LayoutIter::get_line_yrange" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::LayoutIter::get_line_yrange </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>y0</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>y1</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Divides the vertical space in the <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> being iterated over between the lines in the layout, and returns the space belonging to the current line.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>y0</em> </td><td>The start of the line. </td></tr>
<tr><td></td><td valign=top><em>y1</em> </td><td>The end of the line.</td></tr>
</table>
</dl>
<br>
A line's range includes the line's logical extents, plus half of the spacing above and below the line, if <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_11">Pango::Layout::set_spacing()</a> has been called to set layout spacing. The y positions are in layout coordinates (origin at top left of the entire layout). </td>
</tr>
</table>
<a class="anchor" name="z1192_3" doxytag="GFC::Pango::LayoutIter::get_run" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Pango_1_1LayoutRun.html">LayoutRun</a>* GFC::Pango::LayoutIter::get_run </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the current run.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current run.</dd></dl>
<br>
When iterating by run, at the end of each line, there's a position with a null run, so this method can return null. The null run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline. </td>
</tr>
</table>
<a class="anchor" name="z1192_9" doxytag="GFC::Pango::LayoutIter::get_run_extents" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Pango::LayoutIter::get_run_extents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>ink_rect</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>logical_rect</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the extents of the current run in layout coordinates (origin is the top left of the entire layout).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ink_rect</em> </td><td>The rectangle to fill with the ink extents. </td></tr>
<tr><td></td><td valign=top><em>logical_rect</em> </td><td>The rectangle to fill with the logical extents. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1193_0" doxytag="GFC::Pango::LayoutIter::next_char" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Pango::LayoutIter::next_char </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Moves the iterator forward to the next character in visual order.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether motion was possible.</dd></dl>
<br>
If the iterator was already at the end of the layout, false is returned. </td>
</tr>
</table>
<a class="anchor" name="z1193_1" doxytag="GFC::Pango::LayoutIter::next_cluster" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Pango::LayoutIter::next_cluster </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Moves the iterator forward to the next cluster in visual order.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether motion was possible.</dd></dl>
<br>
If the iterator was already at the end of the layout, false is returned. </td>
</tr>
</table>
<a class="anchor" name="z1193_3" doxytag="GFC::Pango::LayoutIter::next_line" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Pango::LayoutIter::next_line </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Moves the iterator forward to the next line in visual order.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether motion was possible.</dd></dl>
<br>
If the iterator was already at the end of the layout, false is returned. </td>
</tr>
</table>
<a class="anchor" name="z1193_2" doxytag="GFC::Pango::LayoutIter::next_run" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Pango::LayoutIter::next_run </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Moves the iterator forward to the next run in visual order.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Whether motion was possible.</dd></dl>
<br>
If the iterator was already at the end of the layout, false is returned. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pango_2layout_8hh-source.html">pango/layout.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:46 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
