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 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
|
<!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::Layout Class Reference</h1>A PangoLayout 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::Layout:
<p><center><img src="classGFC_1_1Pango_1_1Layout.png" usemap="#GFC::Pango::Layout_map" border="0" alt=""></center>
<map name="GFC::Pango::Layout_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Pango_1_1Layout-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_1Layout.html#z1195_0">Layout</a> (const <a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a> &context)
<dl class="el"><dd class="mdescRight">Construct a new layout object with attributes initialized to the default values for the <em>context</em>. <a href="#z1195_0"></a><br></dl><li><a class="anchor" name="z1195_1" doxytag="GFC::Pango::Layout::~Layout" ></a>
virtual <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1195_1">~Layout</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="z1196_0" doxytag="GFC::Pango::Layout::pango_layout" ></a>
PangoLayout * <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_0">pango_layout</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the PangoLayout structure. <br></dl><li><a class="anchor" name="z1196_1" doxytag="GFC::Pango::Layout::operator PangoLayout *" ></a>
<a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_1">operator PangoLayout *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> to a PangoLayout pointer. <br></dl><li><a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a> * <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_2">get_context</a> () const
<dl class="el"><dd class="mdescRight">Returns the <a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a> used for this layout. <a href="#z1196_2"></a><br></dl><li><a class="anchor" name="z1196_3" doxytag="GFC::Pango::Layout::get_attributes" ></a>
<a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1AttrList.html">AttrList</a> > <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_3">get_attributes</a> () const
<dl class="el"><dd class="mdescRight">Returns a smart pointer to the attribute list for the layout, if any. <br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_4">get_text</a> () const
<dl class="el"><dd class="mdescRight">Gets the text in the layout. <a href="#z1196_4"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_5">get_width</a> () const
<dl class="el"><dd class="mdescRight">Gets the width to which the lines of the layout should be wrapped. <a href="#z1196_5"></a><br></dl><li><a class="anchor" name="z1196_6" doxytag="GFC::Pango::Layout::get_wrap" ></a>
<a class="el" href="namespaceGFC_1_1Pango.html#a142">WrapMode</a> <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_6">get_wrap</a> () const
<dl class="el"><dd class="mdescRight">Returns the active wrap mode for the layout. <br></dl><li><a class="anchor" name="z1196_7" doxytag="GFC::Pango::Layout::get_indent" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_7">get_indent</a> () const
<dl class="el"><dd class="mdescRight">Returns the amount by which the first line should be shorter than the rest of the lines. <br></dl><li><a class="anchor" name="z1196_8" doxytag="GFC::Pango::Layout::get_spacing" ></a>
int <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_8">get_spacing</a> () const
<dl class="el"><dd class="mdescRight">Gets the amount of spacing between the lines of the layout (in GlyphUnits). <br></dl><li><a class="anchor" name="z1196_9" doxytag="GFC::Pango::Layout::get_justify" ></a>
bool <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_9">get_justify</a> () const
<dl class="el"><dd class="mdescRight">Returns whether or not each complete line should be stretched to fill the entire width of the layout. <br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_10">get_auto_dir</a> () const
<dl class="el"><dd class="mdescRight">Gets whether to calculate the bidirectional base direction for the layout according to the contents of the layout (see <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_13">set_auto_dir()</a>). <a href="#z1196_10"></a><br></dl><li><a class="el" href="namespaceGFC_1_1Pango.html#a141">Alignment</a> <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_11">get_alignment</a> () const
<dl class="el"><dd class="mdescRight">Sets the alignment for the layout (how partial lines are positioned within the horizontal space available). <a href="#z1196_11"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a> > <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_12">get_tabs</a> () const
<dl class="el"><dd class="mdescRight">Get the current <a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a> used by this layout. <a href="#z1196_12"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_13">get_single_paragraph_mode</a> () const
<dl class="el"><dd class="mdescRight">Obtains the value set by <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_16">set_single_paragraph_mode()</a>. <a href="#z1196_13"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_14">get_logical_attributes</a> (std::vector< <a class="el" href="classGFC_1_1Pango_1_1LogAttr.html">LogAttr</a> > &attrs) const
<dl class="el"><dd class="mdescRight">Retrieve a list of logical attributes for each character in the layout. <a href="#z1196_14"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_15">get_cursor_pos</a> (int index, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *strong_pos, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> *weak_pos) const
<dl class="el"><dd class="mdescRight">Given an index within the layout, determine the positions that of the strong and weak cursors if the insertion point is at that index. <a href="#z1196_15"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_16">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 the layout. <a href="#z1196_16"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_17">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 the layout in device units. <a href="#z1196_17"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_18">get_size</a> (int *width, int *height) const
<dl class="el"><dd class="mdescRight">Determine the logical width and height of the layout in <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> units (device units divided by PANGO_SCALE). <a href="#z1196_18"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_19">get_pixel_size</a> (int *width, int *height) const
<dl class="el"><dd class="mdescRight">Determine the logical width and height of the layout in device units. <a href="#z1196_19"></a><br></dl><li>int <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_20">get_line_count</a> () const
<dl class="el"><dd class="mdescRight">Retrieve the count of lines for the layout. <a href="#z1196_20"></a><br></dl><li><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_1Layout.html#z1196_21">get_line</a> (int line) const
<dl class="el"><dd class="mdescRight">Retrieves a particular line from the layout. <a href="#z1196_21"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_22">get_lines</a> (std::vector< <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> > > &lines) const
<dl class="el"><dd class="mdescRight">Retrieves the lines of the layout. <a href="#z1196_22"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a> > <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_23">get_iter</a> () const
<dl class="el"><dd class="mdescRight">Obtains an iterator to iterate over the visual extents of the layout. <a href="#z1196_23"></a><br></dl><li><a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Pointer.html">Pointer</a>< <a class="el" href="classGFC_1_1Gdk_1_1Region.html">Gdk::Region</a> > <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_24">get_clip_region</a> (int x_origin, int y_origin, const std::vector< std::pair< int, int > > &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 (see <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_5">Pango::LayoutLine::get_x_ranges()</a> for more on using std::pair). <a href="#z1196_24"></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_1Layout.html#z1197_0">set_attributes</a> (<a class="el" href="classGFC_1_1Pango_1_1AttrList.html">AttrList</a> &attrs)
<dl class="el"><dd class="mdescRight">Sets the text attributes for a layout object. <a href="#z1197_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_2">set_text</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &text)
<dl class="el"><dd class="mdescRight">Set the text of the layout. <a href="#z1197_2"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_4">set_markup</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &markup)
<dl class="el"><dd class="mdescRight">Sets the layout text and attribute list from marked-up text (see markup format in the GTK+ documnetation). <a href="#z1197_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_6">set_markup</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &markup, gunichar accel_marker, gunichar *accel_char)
<dl class="el"><dd class="mdescRight">Sets the layout text and attribute list from marked-up text (see markup format in the <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> documnetation). <a href="#z1197_6"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_7">set_font_description</a> (const <a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> *desc)
<dl class="el"><dd class="mdescRight">Set the default font description for the layout. <a href="#z1197_7"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_8">set_width</a> (int width)
<dl class="el"><dd class="mdescRight">Sets the width to which the lines of the layout should be wrapped. <a href="#z1197_8"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_9">set_wrap</a> (<a class="el" href="namespaceGFC_1_1Pango.html#a142">WrapMode</a> <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z74_0">wrap</a>)
<dl class="el"><dd class="mdescRight">Sets the wrap style; the wrap style only has an effect if a width is set on the layout with <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_8">Pango::Layout::set_width()</a>. <a href="#z1197_9"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_10">set_indent</a> (int indent)
<dl class="el"><dd class="mdescRight">Sets the amount by which the first line should be shorter than the rest of the lines. <a href="#z1197_10"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_11">set_spacing</a> (int spacing)
<dl class="el"><dd class="mdescRight">Sets the amount of spacing between the lines of the layout. <a href="#z1197_11"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_12">set_justify</a> (bool justify)
<dl class="el"><dd class="mdescRight">Sets whether or not each complete line should be stretched to fill the entire width of the layout. <a href="#z1197_12"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_13">set_auto_dir</a> (bool auto_dir)
<dl class="el"><dd class="mdescRight">Sets whether to calculate the bidirectional base direction for the layout according to the contents of the layout. <a href="#z1197_13"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_14">set_alignment</a> (<a class="el" href="namespaceGFC_1_1Pango.html#a141">Alignment</a> alignment)
<dl class="el"><dd class="mdescRight">Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.). <a href="#z1197_14"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_15">set_tabs</a> (<a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a> *tabs)
<dl class="el"><dd class="mdescRight">Sets the tabs to use for the layout, overriding the default tabs (by default, tabs are every 8 spaces). <a href="#z1197_15"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_16">set_single_paragraph_mode</a> (bool setting)
<dl class="el"><dd class="mdescRight">If <em>setting</em> is <em>true</em>, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. <a href="#z1197_16"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_17">context_changed</a> ()
<dl class="el"><dd class="mdescRight">Forces recomputation of any state in the <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> that might depend on the layout's context. <a href="#z1197_17"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_18">index_to_pos</a> (int index, <a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> &pos)
<dl class="el"><dd class="mdescRight">Convert from an index within a layout to the onscreen position corresponding to the grapheme at that index, which is represented as a rectangle. <a href="#z1197_18"></a><br></dl><li>void <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_19">move_cursor_visually</a> (bool strong, int old_index, int old_trailing, int direction, int *new_index, int *new_trailing)
<dl class="el"><dd class="mdescRight">Computes a new cursor position from an old position and a count of positions to move visually. <a href="#z1197_19"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_20">xy_to_index</a> (int x, int y, int *index, int *trailing)
<dl class="el"><dd class="mdescRight">Convert from X and Y position within a layout to the byte index to the character at that logical position. <a href="#z1197_20"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1194_0">Layout</a> (PangoLayout *layout, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> from an existing PangoLayout. <a href="#z1194_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A PangoLayout C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> object represents and entire paragraph of text. It is initialized with a <a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a>, UTF-8 string and a set of attributes for that string. Once that is done, the set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout's text, and the physical position of the resulting glyphs can be made.<p>
There are also a number of parameters to adjust the formatting of a <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a>, which are illustrated in Figure 1. It is possible, as well, to ignore the 2-D setup, and simply treat the results of a <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> as a list of lines.<p>
<b>Figure 1:</b> Adjustable parameters for a <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a>. <div align="center">
<img src="layout.png" alt="layout.png">
</div>
<p>
<br>
The <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> object provides a high-level driver for formatting entire paragraphs of text at once. While complete access to the layout capabilities of <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> is provided using the detailed interfaces for itemization and shaping, using that functionality directly involves writing a fairly large amount of code.<p>
<b>Note:</b> <layout.h> is the main <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> header file that your application will include, so for convenience, it includes all the required header files, except <break.h> (<a class="el" href="classGFC_1_1Pango_1_1LogAttr.html">LogAttr</a>) and <glyph.h> (<a class="el" href="classGFC_1_1Pango_1_1GlyphString.html">GlyphString</a>).
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z1194_0" doxytag="GFC::Pango::Layout::Layout" ></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::Layout::Layout </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">PangoLayout * </td>
<td class="mdname" nowrap> <em>layout</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</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_1Layout.html">Layout</a> from an existing PangoLayout.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>layout</em> </td><td>A pointer to a PangoLayout. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>layout</em> can be a newly created PangoLayout or an existing PangoLayout. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<a class="anchor" name="z1195_0" doxytag="GFC::Pango::Layout::Layout" ></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::Layout::Layout </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>context</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 layout object with attributes initialized to the default values for the <em>context</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>context</em> </td><td>A <a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z1197_17" doxytag="GFC::Pango::Layout::context_changed" ></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::Layout::context_changed </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>
Forces recomputation of any state in the <a class="el" href="classGFC_1_1Pango_1_1Layout.html">Layout</a> that might depend on the layout's context.
<p>
This method should be called if you make changes to the context subsequent to creating the layout. </td>
</tr>
</table>
<a class="anchor" name="z1196_11" doxytag="GFC::Pango::Layout::get_alignment" ></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="namespaceGFC_1_1Pango.html#a141">Alignment</a> GFC::Pango::Layout::get_alignment </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>
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The alignment value. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1196_10" doxytag="GFC::Pango::Layout::get_auto_dir" ></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::Layout::get_auto_dir </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 whether to calculate the bidirectional base direction for the layout according to the contents of the layout (see <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_13">set_auto_dir()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>If <em>true</em>, the bidirectional base direction is computed from the layout's contents. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1196_24" doxytag="GFC::Pango::Layout::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><<a class="el" href="classGFC_1_1Gdk_1_1Region.html">Gdk::Region</a>> GFC::Pango::Layout::get_clip_region </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </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 </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< std::pair< int, int > > & </td>
<td class="mdname" nowrap> <em>index_ranges</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 a clip region which contains the areas where the given ranges of text would be drawn (see <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_5">Pango::LayoutLine::get_x_ranges()</a> for more on using std::pair).
<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> </td><td>The X pixel where you intend to draw the layout with this clip. </td></tr>
<tr><td></td><td valign=top><em>y_origin</em> </td><td>The Y pixel where you intend to draw the layout with this clip. </td></tr>
<tr><td></td><td valign=top><em>index_ranges</em> </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> should contain ranges of bytes in the layout's text.<p>
<a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html#z1189_5">Pango::LayoutLine::get_x_ranges()</a> shows you how to access the values returned in a vector of int/int pairs. The easiest way to create a vector of int/int pairs is to assign a pair to each vector element using the subscriipt operator, something like this: <div class="fragment"><pre> <span class="keyword">typedef</span> std::pair<int, int> Range;
std::vector<Range> ranges(count);
<span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < count; i++)
{
<span class="comment">// calculate start_index and end_index here</span>
...
ranges[i] = Range(start_index, end_index));
...
}
layout->get_clip_region(x_origin, y_origin, ranges);
</pre></div> </td>
</tr>
</table>
<a class="anchor" name="z1196_2" doxytag="GFC::Pango::Layout::get_context" ></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_1Context.html">Context</a>* GFC::Pango::Layout::get_context </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>
Returns the <a class="el" href="classGFC_1_1Pango_1_1Context.html">Context</a> used for this layout.
<p>
This does not have an additional reference count added, so if you want to keep a copy of this around, you must reference it yourself, or use a smart pointer. </td>
</tr>
</table>
<a class="anchor" name="z1196_15" doxytag="GFC::Pango::Layout::get_cursor_pos" ></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::Layout::get_cursor_pos </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">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><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> * </td>
<td class="mdname" nowrap> <em>strong_pos</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>weak_pos</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 an index within the layout, determine the positions that of the strong and weak cursors if the insertion point is at that index.
<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> </td><td>The byte index of the cursor. </td></tr>
<tr><td></td><td valign=top><em>strong_pos</em> </td><td>The location to store the strong cursor position (may be null). </td></tr>
<tr><td></td><td valign=top><em>weak_pos</em> </td><td>The location to store the weak cursor position (may be null).</td></tr>
</table>
</dl>
<br>
The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted. </td>
</tr>
</table>
<a class="anchor" name="z1196_16" doxytag="GFC::Pango::Layout::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::Layout::get_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>
Compute the logical and ink extents 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>ink_rect</em> </td><td>The rectangle used to store the extents of the layout 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 layout, or null to indicate that the result is not needed.</td></tr>
</table>
</dl>
<br>
Logical extents are usually what you want for positioning things. The extents are given in layout coordinates; layout coordinates begin at the top left corner of the layout. </td>
</tr>
</table>
<a class="anchor" name="z1196_23" doxytag="GFC::Pango::Layout::get_iter" ></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><<a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a>> GFC::Pango::Layout::get_iter </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>
Obtains an iterator to iterate over the visual extents of the layout.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A smart pointer to a new <a class="el" href="classGFC_1_1Pango_1_1LayoutIter.html">LayoutIter</a>. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1196_21" doxytag="GFC::Pango::Layout::get_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"> <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>> GFC::Pango::Layout::get_line </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>line</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>
Retrieves a particular line from 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>line</em> </td><td>The index of a line, which must be between 0 and <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_20">get_line_count()</a> - 1, inclusive. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The requested <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a>, or null if the index is out of range.</dd></dl>
<br>
This layout line can be retained, but will become invalid if changes are made to the layout. </td>
</tr>
</table>
<a class="anchor" name="z1196_20" doxytag="GFC::Pango::Layout::get_line_count" ></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::Layout::get_line_count </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>
Retrieve the count of lines for the layout.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The line count. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1196_22" doxytag="GFC::Pango::Layout::get_lines" ></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::Layout::get_lines </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< <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> > > & </td>
<td class="mdname1" valign="top" nowrap> <em>lines</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>
Retrieves the lines 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>lines</em> </td><td>A reference to a vector of <a class="el" href="classGFC_1_1Pango_1_1LayoutLine.html">LayoutLine</a> to hold the lines. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the vector is not empty.</dd></dl>
<br>
This returned lines will become invalid on any change to the layout's text or properties. </td>
</tr>
</table>
<a class="anchor" name="z1196_14" doxytag="GFC::Pango::Layout::get_logical_attributes" ></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::Layout::get_logical_attributes </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< <a class="el" href="classGFC_1_1Pango_1_1LogAttr.html">LogAttr</a> > & </td>
<td class="mdname1" valign="top" nowrap> <em>attrs</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>
Retrieve a list of logical attributes for each character in 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>attrs</em> </td><td>A reference to a vector of <a class="el" href="classGFC_1_1Pango_1_1LogAttr.html">LogAttr</a> to store the logical attributes.</td></tr>
</table>
</dl>
<br>
When this method returns the size of the vector will be equal to the total number of characters in the layout. </td>
</tr>
</table>
<a class="anchor" name="z1196_17" doxytag="GFC::Pango::Layout::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::Layout::get_pixel_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>
Compute the logical and ink extents of the layout in device units.
<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 used to store the extents of the layout 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 layout, or null to indicate that the result is not needed.</td></tr>
</table>
</dl>
<br>
See <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_16">get_extents()</a>; this method just calls <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_16">get_extents()</a> and then converts the extents to device units using the PANGO_SCALE factor. </td>
</tr>
</table>
<a class="anchor" name="z1196_19" doxytag="GFC::Pango::Layout::get_pixel_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::Layout::get_pixel_size </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>width</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>height</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>
Determine the logical width and height of the layout in device units.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>width</em> </td><td>The location to store the logical width, or null. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The location to store the logical height, or null.</td></tr>
</table>
</dl>
<br>
<a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_18">get_size()</a> returns the width and height in thousandths of a device unit. This is simply a convenience function around <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1196_16">get_extents()</a>. </td>
</tr>
</table>
<a class="anchor" name="z1196_13" doxytag="GFC::Pango::Layout::get_single_paragraph_mode" ></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::Layout::get_single_paragraph_mode </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>
Obtains the value set by <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_16">set_single_paragraph_mode()</a>.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the layout does not break paragraphs at paragraph separator characters. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1196_18" doxytag="GFC::Pango::Layout::get_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::Layout::get_size </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int * </td>
<td class="mdname" nowrap> <em>width</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>height</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>
Determine the logical width and height of the layout in <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> units (device units divided by PANGO_SCALE).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>width</em> </td><td>The location to store the logical width, or null. </td></tr>
<tr><td></td><td valign=top><em>height</em> </td><td>The location to store the logical height, or null.</td></tr>
</table>
</dl>
<br>
This is simply a convenience method around get_extents. </td>
</tr>
</table>
<a class="anchor" name="z1196_12" doxytag="GFC::Pango::Layout::get_tabs" ></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><<a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a>> GFC::Pango::Layout::get_tabs </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>
Get the current <a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a> used by this layout.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A copy of the tabs for this layout, or null.</dd></dl>
<br>
If no <a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a> has been set, then the default tabs are in use and null is returned. Default tabs are every 8 spaces. </td>
</tr>
</table>
<a class="anchor" name="z1196_4" doxytag="GFC::Pango::Layout::get_text" ></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_1String.html">String</a> GFC::Pango::Layout::get_text </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 text in the layout.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The text in the layout. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1196_5" doxytag="GFC::Pango::Layout::get_width" ></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::Layout::get_width </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 width to which the lines of the layout should be wrapped.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The width. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z1197_18" doxytag="GFC::Pango::Layout::index_to_pos" ></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::Layout::index_to_pos </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">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><a class="el" href="classGFC_1_1Pango_1_1Rectangle.html">Rectangle</a> & </td>
<td class="mdname" nowrap> <em>pos</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 index within a layout to the onscreen position corresponding to the grapheme at that index, which is represented as a rectangle.
<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> </td><td>The byte index within layout. </td></tr>
<tr><td></td><td valign=top><em>pos</em> </td><td>The rectangle in which to store the position of the grapheme.</td></tr>
</table>
</dl>
<br>
Note that pos.x() is always the leading edge of the grapheme and pos.x() + pos.width() the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then pos.width() will be negative. </td>
</tr>
</table>
<a class="anchor" name="z1197_19" doxytag="GFC::Pango::Layout::move_cursor_visually" ></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::Layout::move_cursor_visually </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname" nowrap> <em>strong</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>old_index</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>old_trailing</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>direction</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>new_index</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>new_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>
Computes a new cursor position from an old position and a count of positions to move visually.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>strong</em> </td><td>Whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout. </td></tr>
<tr><td></td><td valign=top><em>old_index</em> </td><td>The byte index of the grapheme for the old index. </td></tr>
<tr><td></td><td valign=top><em>old_trailing</em> </td><td>If 0, the cursor was at the trailing edge of the grapheme indicated by old_index, if > 0, the cursor was at the leading edge. </td></tr>
<tr><td></td><td valign=top><em>direction</em> </td><td>The direction to move cursor. A negative value indicates motion to the left. </td></tr>
<tr><td></td><td valign=top><em>new_index</em> </td><td>The location to store the new cursor byte index. A value of -1 indicates that the cursor has been moved off the beginning of the layout. A value of G_MAXINT indicates that the cursor has been moved off the end of the layout. </td></tr>
<tr><td></td><td valign=top><em>new_trailing</em> </td><td>The number of characters to move forward from the location returned for new_index to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. <em>new_index</em> is always on the line where the cursor should be displayed.</td></tr>
</table>
</dl>
<br>
If the position count is positive, then the new strong cursor position will be one position to the right of the old cursor position. If the count is negative then the new strong cursor position will be one position to the left of the old cursor position. In the presence of bidirectional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.<p>
Motion here is in cursor positions, not in characters, so a single call to <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_19">move_cursor_visually()</a> may move the cursor over multiple characters when multiple characters combine to form a single grapheme. </td>
</tr>
</table>
<a class="anchor" name="z1197_14" doxytag="GFC::Pango::Layout::set_alignment" ></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::Layout::set_alignment </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Pango.html#a141">Alignment</a> </td>
<td class="mdname1" valign="top" nowrap> <em>alignment</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>
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>alignment</em> </td><td>The new alignment. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1197_0" doxytag="GFC::Pango::Layout::set_attributes" ></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::Layout::set_attributes </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1AttrList.html">AttrList</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>attrs</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>
Sets the text attributes for a layout object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>attrs</em> </td><td>An <a class="el" href="classGFC_1_1Pango_1_1AttrList.html">AttrList</a> the list the attributes. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1197_13" doxytag="GFC::Pango::Layout::set_auto_dir" ></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::Layout::set_auto_dir </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>auto_dir</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>
Sets whether to calculate the bidirectional base direction for the layout according to the contents 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>auto_dir</em> </td><td>If <em>true</em>, compute the bidirectional base direction from the layout's contents.</td></tr>
</table>
</dl>
<br>
When this flag is on (the default), then paragraphs in the layout that begin with strong right-to-left characters (Arabic and Hebrew principally), will have right-to-left layout, paragraphs with letters from other scripts will have left-to-right layout. Paragraphs with only neutral characters get their direction from the surrounding paragraphs.<p>
When <em>false</em>, the choice between left-to-right and right-to-left layout is done by according to the base direction of the layout's <a class="el" href="classGFC_1_1Pango_1_1Context.html">Pango::Context</a> (see <a class="el" href="classGFC_1_1Pango_1_1Context.html#z1149_5">Pango::Context::set_base_dir()</a>).<p>
When the auto-computed direction or a paragraph differs from the base direction of the context, then the interpretation of <a class="el" href="namespaceGFC_1_1Pango.html#a141a54">Pango::ALIGN_LEFT</a> and <a class="el" href="namespaceGFC_1_1Pango.html#a141a56">Pango::ALIGN_RIGHT</a> are swapped. </td>
</tr>
</table>
<a class="anchor" name="z1197_7" doxytag="GFC::Pango::Layout::set_font_description" ></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::Layout::set_font_description </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Pango_1_1FontDescription.html">FontDescription</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>desc</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>
Set the default font description for 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>desc</em> </td><td>The new pango font description, or null to unset the current font description.</td></tr>
</table>
</dl>
<br>
If no font description is set on the layout, the font description from the layout's context is used. </td>
</tr>
</table>
<a class="anchor" name="z1197_10" doxytag="GFC::Pango::Layout::set_indent" ></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::Layout::set_indent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>indent</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>
Sets the amount by which the first line should be shorter than the rest of the lines.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>indent</em> </td><td>The amount by which to indent.</td></tr>
</table>
</dl>
<br>
The <em>indent</em> may be negative, in which case the subsequent lines will be shorter than the first line. </td>
</tr>
</table>
<a class="anchor" name="z1197_12" doxytag="GFC::Pango::Layout::set_justify" ></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::Layout::set_justify </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>justify</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>
Sets whether or not each complete line should be stretched to fill the entire width 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>justify</em> </td><td>Whether the lines in the layout should be justified.</td></tr>
</table>
</dl>
<br>
This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters. </td>
</tr>
</table>
<a class="anchor" name="z1197_6" doxytag="GFC::Pango::Layout::set_markup" ></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::Layout::set_markup </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>markup</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>gunichar </td>
<td class="mdname" nowrap> <em>accel_marker</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>gunichar * </td>
<td class="mdname" nowrap> <em>accel_char</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>
Sets the layout text and attribute list from marked-up text (see markup format in the <a class="el" href="namespaceGFC_1_1Pango.html">Pango</a> documnetation).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>markup</em> </td><td>Some marked-up text (see markup format in the GTK+ documnetation). </td></tr>
<tr><td></td><td valign=top><em>accel_marker</em> </td><td>The marker for accelerators in the text. </td></tr>
<tr><td></td><td valign=top><em>accel_char</em> </td><td>The return location for any located accelerators.</td></tr>
</table>
</dl>
<br>
Replaces the current text and attribute list. If accel_marker is nonzero, the given character will mark the character following it as an accelerator. For example, the accel marker might be an ampersand or underscore. All characters marked as an accelerator will receive a PANGO_UNDERLINE_LOW attribute, and the first character so marked will be returned in accel_char. Two accel_marker characters following each other produce a single literal accel_marker character. </td>
</tr>
</table>
<a class="anchor" name="z1197_4" doxytag="GFC::Pango::Layout::set_markup" ></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::Layout::set_markup </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="mdname1" valign="top" nowrap> <em>markup</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>
Sets the layout text and attribute list from marked-up text (see markup format in the GTK+ documnetation).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>markup</em> </td><td>The marked-up text.</td></tr>
</table>
</dl>
<br>
Replaces the current text and attribute list. This method doesn't scan the text for accelerators. </td>
</tr>
</table>
<a class="anchor" name="z1197_16" doxytag="GFC::Pango::Layout::set_single_paragraph_mode" ></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::Layout::set_single_paragraph_mode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>setting</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>
If <em>setting</em> is <em>true</em>, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>setting</em> </td><td>The new setting.</td></tr>
</table>
</dl>
<br>
This is used when you want to allow editing of newlines on a single text line. </td>
</tr>
</table>
<a class="anchor" name="z1197_11" doxytag="GFC::Pango::Layout::set_spacing" ></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::Layout::set_spacing </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>spacing</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>
Sets the amount of spacing between the lines 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>spacing</em> </td><td>The amount of spacing. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1197_15" doxytag="GFC::Pango::Layout::set_tabs" ></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::Layout::set_tabs </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>tabs</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>
Sets the tabs to use for the layout, overriding the default tabs (by default, tabs are every 8 spaces).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>tabs</em> </td><td>A <a class="el" href="classGFC_1_1Pango_1_1TabArray.html">TabArray</a>.</td></tr>
</table>
</dl>
<br>
If tabs is null, the default tabs are reinstated. <em>tabs</em> is copied into the layout so you must unreference your copy of <em>tabs</em> yourself, or create it using a smart pointer. </td>
</tr>
</table>
<a class="anchor" name="z1197_2" doxytag="GFC::Pango::Layout::set_text" ></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::Layout::set_text </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="mdname1" valign="top" nowrap> <em>text</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>
Set 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>text</em> </td><td>A UTF-8 <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1197_8" doxytag="GFC::Pango::Layout::set_width" ></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::Layout::set_width </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>width</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>
Sets the width to which the lines of the layout should be wrapped.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>width</em> </td><td>The desired width, or -1 to indicate that no wrapping should be performed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z1197_9" doxytag="GFC::Pango::Layout::set_wrap" ></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::Layout::set_wrap </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Pango.html#a142">WrapMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>wrap</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>
Sets the wrap style; the wrap style only has an effect if a width is set on the layout with <a class="el" href="classGFC_1_1Pango_1_1Layout.html#z1197_8">Pango::Layout::set_width()</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>wrap</em> </td><td>The wrap mode.</td></tr>
</table>
</dl>
<br>
To turn off wrapping, set the width to -1. </td>
</tr>
</table>
<a class="anchor" name="z1197_20" doxytag="GFC::Pango::Layout::xy_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::Layout::xy_to_index </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>y</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>int * </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 X and Y position within a layout to the byte index to the character at that logical position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>x</em> </td><td>The X offset (in GlyphUnits) from the left edge of the layout. </td></tr>
<tr><td></td><td valign=top><em>y</em> </td><td>The Y offset (in GlyphUnits) from the top edge of the layout. </td></tr>
<tr><td></td><td valign=top><em>index</em> </td><td>The location to store calculated byte index. </td></tr>
<tr><td></td><td valign=top><em>trailing</em> </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>true</em> if the coordinates were inside text.</dd></dl>
<br>
If the position is not inside the layout, the closest position is chosen (the x/y position will be clamped inside the layout). If a closest position is chosen, then the method returns false; on an exact hit, it returns true. <em>trailing</em> will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme. </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>
|