File: classGFC_1_1Pango_1_1LayoutLine.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (543 lines) | stat: -rw-r--r-- 28,250 bytes parent folder | download | duplicates (3)
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
<!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>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <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::LayoutLine Class Reference</h1>A PangoLayoutLine C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="pango_2layout_8hh-source.html">gfc/pango/layout.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Pango::LayoutLine:
<p><center><img src="classGFC_1_1Pango_1_1LayoutLine.png" usemap="#GFC::Pango::LayoutLine_map" border="0" alt=""></center>
<map name="GFC::Pango::LayoutLine_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,148,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,148,24">
</map>
<a href="classGFC_1_1Pango_1_1LayoutLine-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_1LayoutLine.html#z1188_0">LayoutLine</a> (PangoLayoutLine *layout_line)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> from an existing PangoLayoutLine.  <a href="#z1188_0"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1188_1">LayoutLine</a> (const <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> &amp;src)
<dl class="el"><dd class="mdescRight">Copy constructor.  <a href="#z1188_1"></a><br></dl><li><a class="anchor" name="z1188_2" doxytag="GFC::Pango::LayoutLine::~LayoutLine" ></a>
<a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1188_2">~LayoutLine</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> &amp; <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1188_3">operator=</a> (const <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> &amp;src)
<dl class="el"><dd class="mdescRight">Assignment operator.  <a href="#z1188_3"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1189_0" doxytag="GFC::Pango::LayoutLine::pango_layout_line" ></a>
PangoLayoutLine * <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_0">pango_layout_line</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoLayoutLine structure. <br></dl><li><a class="anchor" name="z1189_1" doxytag="GFC::Pango::LayoutLine::operator PangoLayoutLine *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_1">operator PangoLayoutLine *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> to a PangoLayoutLine pointer. <br></dl><li><a class="anchor" name="z1189_2" doxytag="GFC::Pango::LayoutLine::start_index" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_2">start_index</a> () const
<dl class="el"><dd class="mdescRight">Returns the start of line as byte index into the text of the parent layout. <br></dl><li><a class="anchor" name="z1189_3" doxytag="GFC::Pango::LayoutLine::length" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_3">length</a> () const
<dl class="el"><dd class="mdescRight">Returns the length of line in bytes. <br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_4">is_paragraph_start</a> () const
<dl class="el"><dd class="mdescRight">Determines whether this is the first line of a paragraph.  <a href="#z1189_4"></a><br></dl><li>std::vector&lt; std::pair&lt; int,<br>
 int &gt; &gt; <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_5">get_x_ranges</a> (int start_index, int end_index) const
<dl class="el"><dd class="mdescRight">Get a list of visual ranges corresponding to a given logical range.  <a href="#z1189_5"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_6">get_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">Compute the logical and ink extents of a layout line.  <a href="#z1189_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_7">get_pixel_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">Compute the logical and ink extents of a layout line.  <a href="#z1189_7"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classGFC_1_1Gdk_1_1Region.html">Gdk::Region</a> &gt; <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_8">get_clip_region</a> (int x_origin, int y_origin, const std::vector&lt; std::pair&lt; int, int &gt; &gt; &amp;index_ranges) const
<dl class="el"><dd class="mdescRight">Obtains a clip region which contains the areas where the given ranges of text would be drawn.  <a href="#z1189_8"></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_1LayoutLine.html#z1190_0">x_to_index</a> (int x_pos, int *index, int *trailing)
<dl class="el"><dd class="mdescRight">Convert from x offset to the byte index of the corresponding character within the text of the layout.  <a href="#z1190_0"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1190_1">index_to_x</a> (int index, bool trailing)
<dl class="el"><dd class="mdescRight">Converts an index within a line to a X position.  <a href="#z1190_1"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoLayoutLine C++ wrapper class. 
<p>
<a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> represents one of the lines resulting from laying out a paragraph via <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a>. <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> objects are obtained by calling <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_21">Pango::Layout::get_line()</a> and are only valid until the text, attributes, or settings of the parent <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> are modified.<p>
Routines for rendering <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> objects are provided in code specific to each rendering system. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z1188_0" doxytag="GFC::Pango::LayoutLine::LayoutLine" ></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::LayoutLine::LayoutLine           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PangoLayoutLine *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>layout_line</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [explicit]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> from an existing PangoLayoutLine. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>layout_line</em>&nbsp;</td><td>A pointer to a PangoLayoutLine. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1188_1" doxytag="GFC::Pango::LayoutLine::LayoutLine" ></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::LayoutLine::LayoutLine           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>src</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Copy constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>The source <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a>. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1189_8" doxytag="GFC::Pango::LayoutLine::get_clip_region" ></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="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classGFC_1_1Gdk_1_1Region.html">Gdk::Region</a>&gt; GFC::Pango::LayoutLine::get_clip_region           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap> <em>x_origin</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>y_origin</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const std::vector&lt; std::pair&lt; int, int &gt; &gt; &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>index_ranges</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Obtains a clip region which contains the areas where the given ranges of text would be drawn. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>x_origin</em>&nbsp;</td><td>The X pixel where you intend to draw the layout line with this clip. </td></tr>
    <tr><td></td><td valign=top><em>y_origin</em>&nbsp;</td><td>The baseline pixel where you intend to draw the layout line with this clip. </td></tr>
    <tr><td></td><td valign=top><em>index_ranges</em>&nbsp;</td><td>A reference to a vector of int/int pairs that holds the index ranges. The <em>first</em> value of each pair is the start index and the <em>second</em> value is the end index. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a new clip region containing the given ranges.</dd></dl>
<br>
<em>x_origin</em> and <em>y_origin</em> are the same position you would pass to <a class="el" href="classGFC_1_1Gdk_1_1Drawable.html#z135_19">Gdk::Drawable::draw_layout_line()</a>. <em>index_ranges</em> is a vector that should contain ranges of bytes in the layout's text as an int/int pair. The clip region will include space to the left or right of the line (to the layout bounding box) if you have indexes above or below the indexes contained inside the line. This is to draw the selection all the way to the side of the layout. However, the clip region is in line coordinates, not layout coordinates.<p>
See <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_24">Pango::Layout::get_clip_region()</a> for an example of how to create a vector of pair.     </td>
  </tr>
</table>
<a class="anchor" name="z1189_6" doxytag="GFC::Pango::LayoutLine::get_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::LayoutLine::get_extents           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *&nbsp;</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> *&nbsp;</td>
          <td class="mdname" nowrap> <em>logical_rect</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Compute the logical and ink extents of a layout 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>&nbsp;</td><td>The rectangle used to store the extents of the glyph string as drawn, or null to indicate that the result is not needed. </td></tr>
    <tr><td></td><td valign=top><em>logical_rect</em>&nbsp;</td><td>The rectangle used to store the logical extents of the glyph string, or null to indicate that the result is not needed.</td></tr>
  </table>
</dl>
<br>
See the documentation for <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_5">Pango::Font::get_glyph_extents()</a> for details about the interpretation of the rectangles.     </td>
  </tr>
</table>
<a class="anchor" name="z1189_7" doxytag="GFC::Pango::LayoutLine::get_pixel_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::LayoutLine::get_pixel_extents           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *&nbsp;</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> *&nbsp;</td>
          <td class="mdname" nowrap> <em>logical_rect</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Compute the logical and ink extents of a layout 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>&nbsp;</td><td>The rectangle used to store the extents of the glyph string as drawn, or null to indicate that the result is not needed. </td></tr>
    <tr><td></td><td valign=top><em>logical_rect</em>&nbsp;</td><td>The rectangle used to store the logical extents of the glyph string, or null to indicate that the result is not needed.</td></tr>
  </table>
</dl>
<br>
See the documentation for <a class="el" href="classGFC_1_1Pango_1_1Font.html#z1169_5">Pango::Font::get_glyph_extents()</a> for details about the interpretation of the rectangles. The returned rectangles are in device units, as opposed to <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_6">get_extents()</a>, which returns the extents in GlyphUnits.     </td>
  </tr>
</table>
<a class="anchor" name="z1189_5" doxytag="GFC::Pango::LayoutLine::get_x_ranges" ></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"> std::vector&lt;std::pair&lt;int, int&gt; &gt; GFC::Pango::LayoutLine::get_x_ranges           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap> <em>start_index</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap> <em>end_index</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get a list of visual ranges corresponding to a given logical range. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>start_index</em>&nbsp;</td><td>The starting byte index of the logical range. </td></tr>
    <tr><td></td><td valign=top><em>end_index</em>&nbsp;</td><td>The end byte index of the logical range. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A vector of int/int pairs (see example below).</dd></dl>
<br>
If <em>start_index</em> is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise it will start at the leading edge of the first character. If <em>end_index</em> is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character.<p>
This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line.<p>
The return value is not as strange as it looks. A std::pair is a container that stores 2 values, and vector you already know, so the return value is a vector of int/int pairs. In a std::pair the first value is called <em>first</em> and the second value is called <em>second</em>. In the returned vector each pair is a range. In each pair the first value is the start of the range and the second value is the width of the range. The coordinates are relative to the layout and are in GlyphUnits. To access the values returned in the pairs you would do something like this: <div class="fragment"><pre>             std::vector&lt;std::pair&lt;int, int&gt; &gt; ranges = <a class="code" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_5">get_x_ranges</a>(start_index, end_index);
             
             <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; ranges.size(); i++)
             {
                <span class="keywordtype">int</span> start_of_range = ranges[i].first;
                <span class="keywordtype">int</span> width_of_range = ranges[i].second;
                ...
             }
</pre></div>Note the space between the two  >s; >> is the right shift operator.     </td>
  </tr>
</table>
<a class="anchor" name="z1190_1" doxytag="GFC::Pango::LayoutLine::index_to_x" ></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::LayoutLine::index_to_x           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap> <em>index</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>trailing</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Converts an index within a line to a X position. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>index</em>&nbsp;</td><td>The byte offset of a grapheme within the layout. </td></tr>
    <tr><td></td><td valign=top><em>trailing</em>&nbsp;</td><td>Whether to compute the result for the leading or trailing edge of the grapheme. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The x_offset (in GlyphUnits). </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1189_4" doxytag="GFC::Pango::LayoutLine::is_paragraph_start" ></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::LayoutLine::is_paragraph_start           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determines whether this is the first line of a paragraph. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if this is the first line of a paragraph. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1188_3" doxytag="GFC::Pango::LayoutLine::operator=" ></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_1LayoutLine.html">LayoutLine</a>&amp; GFC::Pango::LayoutLine::operator=           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>src</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Assignment operator. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>src</em>&nbsp;</td><td>The source <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a>. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z1190_0" doxytag="GFC::Pango::LayoutLine::x_to_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"> bool GFC::Pango::LayoutLine::x_to_index           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap> <em>x_pos</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>int *&nbsp;</td>
          <td class="mdname" nowrap> <em>index</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>int *&nbsp;</td>
          <td class="mdname" nowrap> <em>trailing</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Convert from x offset to the byte index of the corresponding character within the text of the layout. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>x_pos</em>&nbsp;</td><td>The x offset (in GlyphUnits) from the left edge of the line. </td></tr>
    <tr><td></td><td valign=top><em>index</em>&nbsp;</td><td>The location to store the calculated byte offset for the grapheme in which the user clicked. </td></tr>
    <tr><td></td><td valign=top><em>trailing</em>&nbsp;</td><td>The location to store a integer indicating where in the grapheme the user clicked. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>false</em> if x_pos was outside the line, <em>true</em> if inside.</dd></dl>
<br>
If x_pos is outside the line, the start or end of the line will be stored at index. <em>trailing</em> will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the cluster.     </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>