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
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
|
<!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::GlyphString Class Reference</h1>A PangoGlyphString C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="glyph_8hh-source.html">gfc/pango/glyph.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Pango::GlyphString:
<p><center><img src="classGFC_1_1Pango_1_1GlyphString.png" usemap="#GFC::Pango::GlyphString_map" border="0" alt=""></center>
<map name="GFC::Pango::GlyphString_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html" alt="GFC::G::Boxed" shape="rect" coords="0,112,152,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,152,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,152,24">
</map>
<a href="classGFC_1_1Pango_1_1GlyphString-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="anchor" name="z1179_0" doxytag="GFC::Pango::GlyphString::GlyphString" ></a>
<a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_0">GlyphString</a> ()
<dl class="el"><dd class="mdescRight">Construct a new glyph string. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_1">GlyphString</a> (const char *text, int length, const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> &analysis)
<dl class="el"><dd class="mdescRight">Given a segment of text and the corresponding <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> structure returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>, convert the characters in <em>text</em> into glyphs. <a href="#z1179_1"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_2">GlyphString</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &text, const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> &analysis)
<dl class="el"><dd class="mdescRight">Given a segment of text and the corresponding <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> structure returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>, convert the characters in <em>text</em> into glyphs. <a href="#z1179_2"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_3">GlyphString</a> (PangoGlyphString *string)
<dl class="el"><dd class="mdescRight">Construct a new glyph string from an existing PangoGlyphString. <a href="#z1179_3"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_4">GlyphString</a> (PangoGlyphString *string, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z5_0">copy</a>)
<dl class="el"><dd class="mdescRight">Construct a new glyph string from an existing PangoGlyphString. <a href="#z1179_4"></a><br></dl><li><a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_5">GlyphString</a> (const <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> &src)
<dl class="el"><dd class="mdescRight">Copy constructor. <a href="#z1179_5"></a><br></dl><li><a class="anchor" name="z1179_6" doxytag="GFC::Pango::GlyphString::~GlyphString" ></a>
virtual <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_6">~GlyphString</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> & <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1179_7">operator=</a> (const <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> &src)
<dl class="el"><dd class="mdescRight">Assignment operator. <a href="#z1179_7"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z1180_0" doxytag="GFC::Pango::GlyphString::pango_glyph_string" ></a>
PangoGlyphString * <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_0">pango_glyph_string</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoGlyphString structure. <br></dl><li><a class="anchor" name="z1180_1" doxytag="GFC::Pango::GlyphString::operator PangoGlyphString *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_1">operator PangoGlyphString *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> to a PangoGlyphString pointer. <br></dl><li><a class="anchor" name="z1180_2" doxytag="GFC::Pango::GlyphString::size" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_2">size</a> () const
<dl class="el"><dd class="mdescRight">Returns the number of glyphs in the string. <br></dl><li><a class="anchor" name="z1180_3" doxytag="GFC::Pango::GlyphString::glyphs" ></a>
std::vector< <a class="el" href="classGFC_1_1Pango_1_1GlyphInfo.html">GlyphInfo</a> > <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_3">glyphs</a> () const
<dl class="el"><dd class="mdescRight">Returns a vector of <a class="el" href="classGFC_1_1Pango_1_1GlyphInfo.html">GlyphInfo</a> that holds one <a class="el" href="classGFC_1_1Pango_1_1GlyphInfo.html">GlyphInfo</a> object for each glyph in the string. <br></dl><li>int * <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_4">log_clusters</a> () const
<dl class="el"><dd class="mdescRight">For each glyph, returns the byte index of the starting character for the cluster. <a href="#z1180_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_5">extents</a> (const <a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a> &font, <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, int start=0, int end=-1) const
<dl class="el"><dd class="mdescRight">Compute the logical and ink extents of a sub-portion the glyph string, or the entire glyph string. <a href="#z1180_5"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_6">get_logical_widths</a> (const char *text, int length, int embedding_level, std::vector< int > &logical_widths) const
<dl class="el"><dd class="mdescRight">Given a <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> resulting from pango_shape() and the corresponding text, determine the screen width corresponding to each character. <a href="#z1180_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1180_7">get_logical_widths</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &text, int embedding_level, std::vector< int > &logical_widths) const
<dl class="el"><dd class="mdescRight">Given a <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> resulting from pango_shape() and the corresponding text, determine the screen width corresponding to each character. <a href="#z1180_7"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1181_0">set_size</a> (int length)
<dl class="el"><dd class="mdescRight">Resize a glyph string to the given length. <a href="#z1181_0"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1181_1">index_to_x</a> (const char *text, int length, const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> &analysis, int index, bool trailing)
<dl class="el"><dd class="mdescRight">Converts from a character position to an x position. <a href="#z1181_1"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1181_2">index_to_x</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &text, const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> &analysis, int index, bool trailing)
<dl class="el"><dd class="mdescRight">Converts from a character position to an x position. <a href="#z1181_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1181_3">x_to_index</a> (const char *text, int length, const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> &analysis, int x_pos, int *index, bool *trailing)
<dl class="el"><dd class="mdescRight">Convert from an x offset to character position. <a href="#z1181_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html#z1181_4">x_to_index</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &text, const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> &analysis, int x_pos, int *index, bool *trailing)
<dl class="el"><dd class="mdescRight">Convert from an x offset to character position. <a href="#z1181_4"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoGlyphString C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> is used to store strings of glyphs with geometry and visual attribute information. The storage for the glyph information is owned by the structure which simplifies memory management.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1179_1" doxytag="GFC::Pango::GlyphString::GlyphString" ></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::GlyphString::GlyphString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & </td>
<td class="mdname" nowrap> <em>analysis</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Given a segment of text and the corresponding <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> structure returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>, convert the characters in <em>text</em> into glyphs.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>The text to process. </td></tr>
<tr><td></td><td valign=top><em>length</em> </td><td>The length of the text in bytes. </td></tr>
<tr><td></td><td valign=top><em>analysis</em> </td><td>The <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> structure from Pango::Context::Itemize().</td></tr>
</table>
</dl>
<br>
You may also pass in only a substring of the item from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>. This constructor calls pango_shape(). There is no shape() method. </td>
</tr>
</table>
<a class="anchor" name="z1179_2" doxytag="GFC::Pango::GlyphString::GlyphString" ></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::GlyphString::GlyphString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & </td>
<td class="mdname" nowrap> <em>analysis</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Given a segment of text and the corresponding <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> structure returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>, convert the characters in <em>text</em> into glyphs.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>The text to process. </td></tr>
<tr><td></td><td valign=top><em>analysis</em> </td><td>The <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> structure from Pango::Context::Itemize().</td></tr>
</table>
</dl>
<br>
You may also pass in only a substring of the item from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>. This constructor calls pango_shape(). There is no shape() method. </td>
</tr>
</table>
<a class="anchor" name="z1179_3" doxytag="GFC::Pango::GlyphString::GlyphString" ></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::GlyphString::GlyphString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoGlyphString * </td>
<td class="mdname1" valign="top" nowrap> <em>string</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 glyph string from an existing PangoGlyphString.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>string</em> </td><td>A pointer to a PangoGlyphString.</td></tr>
</table>
</dl>
<br>
The <em>string</em> can be a newly created PangoGlyphString or an existing PangoGlyphString. The glyph string object created is a temporary object. It doesn't take over the ownership of PangoGlyphString and PangoGlyphString is not freed by the destructor. </td>
</tr>
</table>
<a class="anchor" name="z1179_4" doxytag="GFC::Pango::GlyphString::GlyphString" ></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::GlyphString::GlyphString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoGlyphString * </td>
<td class="mdname" nowrap> <em>string</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>copy</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new glyph string from an existing PangoGlyphString.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>string</em> </td><td>A pointer to a PangoGlyphString. </td></tr>
<tr><td></td><td valign=top><em>copy</em> </td><td>Whether the <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> object should make a copy of PangoGlyphString or not.</td></tr>
</table>
</dl>
<br>
The <em>string</em> can be a newly created PangoGlyphString or an existing PangoGlyphString. If <em>copy</em> is true <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> will make a copy of PangoGlyphString. If <em>copy</em> is false <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> wont make a copy but instead takes over the ownership of PangoGlyphString. Either way, the destructor will free PangoGlyphString when the <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> object is destroyed. This constructor is used by <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html#z6_0">G::Boxed::wrap()</a> to wrap PangoGlyphString objects in a C++ wrapper. </td>
</tr>
</table>
<a class="anchor" name="z1179_5" doxytag="GFC::Pango::GlyphString::GlyphString" ></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::GlyphString::GlyphString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </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>
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> </td><td>The source <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1180_5" doxytag="GFC::Pango::GlyphString::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::GlyphString::extents </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a> & </td>
<td class="mdname" nowrap> <em>font</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>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 class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>start</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end</em> = <code>-1</code></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>
Compute the logical and ink extents of a sub-portion the glyph string, or the entire glyph string.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>font</em> </td><td>A <a class="el" href="classGFC_1_1Pango_1_1Font.html">Font</a>. </td></tr>
<tr><td></td><td valign=top><em>ink_rect</em> </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> </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>
<tr><td></td><td valign=top><em>start</em> </td><td>The start index in bytes, or 0 for the start of the string. </td></tr>
<tr><td></td><td valign=top><em>end</em> </td><td>The end index in bytes, or -1 for the end of the string.</td></tr>
</table>
</dl>
<br>
The extents are relative to the start of the glyph string range (the origin of their coordinate system is at the start of the range, not at the start of the entire glyph string).<p>
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="z1180_7" doxytag="GFC::Pango::GlyphString::get_logical_widths" ></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::GlyphString::get_logical_widths </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>embedding_level</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>std::vector< int > & </td>
<td class="mdname" nowrap> <em>logical_widths</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>
Given a <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> resulting from pango_shape() and the corresponding text, determine the screen width corresponding to each character.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>The text corresponding to the glyphs. </td></tr>
<tr><td></td><td valign=top><em>embedding_level</em> </td><td>The embedding level of the string. </td></tr>
<tr><td></td><td valign=top><em>logical_widths</em> </td><td>A reference to a vector of int to be filled in with the resulting character widths.</td></tr>
</table>
</dl>
<br>
When multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters. </td>
</tr>
</table>
<a class="anchor" name="z1180_6" doxytag="GFC::Pango::GlyphString::get_logical_widths" ></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::GlyphString::get_logical_widths </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>embedding_level</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>std::vector< int > & </td>
<td class="mdname" nowrap> <em>logical_widths</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>
Given a <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> resulting from pango_shape() and the corresponding text, determine the screen width corresponding to each character.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>The text corresponding to the glyphs. </td></tr>
<tr><td></td><td valign=top><em>length</em> </td><td>The length of the text in bytes. </td></tr>
<tr><td></td><td valign=top><em>embedding_level</em> </td><td>The embedding level of the string. </td></tr>
<tr><td></td><td valign=top><em>logical_widths</em> </td><td>A reference to a vector of int to be filled in with the resulting character widths.</td></tr>
</table>
</dl>
<br>
When multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters. </td>
</tr>
</table>
<a class="anchor" name="z1181_2" doxytag="GFC::Pango::GlyphString::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::GlyphString::index_to_x </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & </td>
<td class="mdname" nowrap> <em>analysis</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </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 </td>
<td class="mdname" nowrap> <em>trailing</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Converts from a character position to an 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>text</em> </td><td>The text for the run. </td></tr>
<tr><td></td><td valign=top><em>analysis</em> </td><td>The analysis information returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>. </td></tr>
<tr><td></td><td valign=top><em>index</em> </td><td>The byte index within text. </td></tr>
<tr><td></td><td valign=top><em>trailing</em> </td><td>Whether we should compute the result for the beginning or end of the character. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The x position.</dd></dl>
<br>
X position is measured from the left edge of the run. Character positions are computed by dividing up each cluster into equal portions. </td>
</tr>
</table>
<a class="anchor" name="z1181_1" doxytag="GFC::Pango::GlyphString::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::GlyphString::index_to_x </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & </td>
<td class="mdname" nowrap> <em>analysis</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </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 </td>
<td class="mdname" nowrap> <em>trailing</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Converts from a character position to an 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>text</em> </td><td>The text for the run. </td></tr>
<tr><td></td><td valign=top><em>length</em> </td><td>The length of the text in bytes. </td></tr>
<tr><td></td><td valign=top><em>analysis</em> </td><td>The analysis information returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>. </td></tr>
<tr><td></td><td valign=top><em>index</em> </td><td>The byte index within text. </td></tr>
<tr><td></td><td valign=top><em>trailing</em> </td><td>Whether we should compute the result for the beginning or end of the character. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The x position.</dd></dl>
<br>
X position is measured from the left edge of the run. Character positions are computed by dividing up each cluster into equal portions. </td>
</tr>
</table>
<a class="anchor" name="z1180_4" doxytag="GFC::Pango::GlyphString::log_clusters" ></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::GlyphString::log_clusters </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>
For each glyph, returns the byte index of the starting character for the cluster.
<p>
The indices are relative to the start of the text corresponding to the <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a>. </td>
</tr>
</table>
<a class="anchor" name="z1179_7" doxytag="GFC::Pango::GlyphString::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_1GlyphString.html">GlyphString</a>& GFC::Pango::GlyphString::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>src</em> </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>
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> </td><td>The source <a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1181_0" doxytag="GFC::Pango::GlyphString::set_size" ></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::GlyphString::set_size </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>length</em> </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>
Resize a glyph string to the given length.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>length</em> </td><td>The new length of the string. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1181_4" doxytag="GFC::Pango::GlyphString::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"> void GFC::Pango::GlyphString::x_to_index </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & </td>
<td class="mdname" nowrap> <em>analysis</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </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 * </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 * </td>
<td class="mdname" nowrap> <em>trailing</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Convert from an x offset to character position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>The text for the run. </td></tr>
<tr><td></td><td valign=top><em>analysis</em> </td><td>The analysis information returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>. </td></tr>
<tr><td></td><td valign=top><em>x_pos</em> </td><td>The x offset (in GlyphUnit). </td></tr>
<tr><td></td><td valign=top><em>index</em> </td><td>The location to store calculated byte index within the text. </td></tr>
<tr><td></td><td valign=top><em>trailing</em> </td><td>The location to store whether the user clicked on the leading or trailing edge of the character.</td></tr>
</table>
</dl>
<br>
Character positions are computed by dividing up each cluster into equal portions. In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position. </td>
</tr>
</table>
<a class="anchor" name="z1181_3" doxytag="GFC::Pango::GlyphString::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"> void GFC::Pango::GlyphString::x_to_index </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="el" href="classGFC_1_1Pango_1_1Analysis.html">Analysis</a> & </td>
<td class="mdname" nowrap> <em>analysis</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </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 * </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 * </td>
<td class="mdname" nowrap> <em>trailing</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Convert from an x offset to character position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>text</em> </td><td>The text for the run. </td></tr>
<tr><td></td><td valign=top><em>length</em> </td><td>The length of the text in bytes. </td></tr>
<tr><td></td><td valign=top><em>analysis</em> </td><td>The analysis information returned from <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_6">Pango::Context::itemize()</a>. </td></tr>
<tr><td></td><td valign=top><em>x_pos</em> </td><td>The x offset (in GlyphUnit). </td></tr>
<tr><td></td><td valign=top><em>index</em> </td><td>The location to store calculated byte index within the text. </td></tr>
<tr><td></td><td valign=top><em>trailing</em> </td><td>The location to store whether the user clicked on the leading or trailing edge of the character.</td></tr>
</table>
</dl>
<br>
Character positions are computed by dividing up each cluster into equal portions. In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="glyph_8hh-source.html">glyph.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>
|
