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 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkprintoperation">
<refnamediv>
<refname>gtk.PrintOperation</refname>
<refpurpose>a high-level printing API (new in PyGTK 2.10)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.PrintOperation</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<ooclass><classname><link linkend="class-gtkprintoperationpreview">gtk.PrintOperationPreview</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkprintoperation">gtk.PrintOperation</link></methodname>
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-default-page-setup">set_default_page_setup</link></methodname>
<methodparam><parameter role="keyword">default_page_setup</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-default-page-setup">get_default_page_setup</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-print-settings">set_print_settings</link></methodname>
<methodparam><parameter role="keyword">print_settings</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-print-settings">get_print_settings</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-job-name">set_job_name</link></methodname>
<methodparam><parameter role="keyword">job_name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-n-pages">set_n_pages</link></methodname>
<methodparam><parameter role="keyword">n_pages</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-current-page">set_current_page</link></methodname>
<methodparam><parameter role="keyword">current_page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-use-full-page">set_use_full_page</link></methodname>
<methodparam><parameter role="keyword">full_page</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-unit">set_unit</link></methodname>
<methodparam><parameter role="keyword">unit</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-export-filename">set_export_filename</link></methodname>
<methodparam><parameter role="keyword">filename</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-track-print-status">set_track_print_status</link></methodname>
<methodparam><parameter role="keyword">track_status</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-show-progress">set_show_progress</link></methodname>
<methodparam><parameter role="keyword">show_progress</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-allow-async">set_allow_async</link></methodname>
<methodparam><parameter role="keyword">allow_async</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-custom-tab-label">set_custom_tab_label</link></methodname>
<methodparam><parameter role="keyword">label</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--run">run</link></methodname>
<methodparam><parameter role="keyword">action</parameter></methodparam>
<methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-error">get_error</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-status">get_status</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-status-string">get_status_string</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--is-finished">is_finished</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--cancel">cancel</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-support-selection">set_support_selection</link></methodname>
<methodparam><parameter role="keyword">support_selection</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-support-selection">get_support_selection</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-has-selection">set_has_selection</link></methodname>
<methodparam><parameter role="keyword">has_selection</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-has-selection">get_has_selection</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-embed-page-setup">set_embed_page_setup</link></methodname>
<methodparam><parameter role="keyword">embed</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-embed-page-setup">get_embed_page_setup</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--get-n-pages-to-print">get_n_pages_to_print</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--draw-page-finish">draw_page_finish</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkprintoperation--set-defer-drawing">set_defer_drawing</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkprintoperation">gtk.PrintOperation</link> (implements <link linkend="class-gtkprintoperationpreview">gtk.PrintOperationPreview</link>)
</synopsis>
</refsect1>
<refsect1 id="properties-gtkprintoperation">
<title>gtk.PrintOperation Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"allow-async"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> the print operation may run
asynchronously or not. Some systems don't support asynchronous
printing, but those that do will return
<literal>gtk.PRINT_OPERATION_RESULT_IN_PROGRESS</literal> as the
status, and emit the done signal when the operation is actually
done. This property is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"current-page"</entry>
<entry>Read-Write</entry>
<entry>The current page in the document. If this is set before
<link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>,
the user will be able to select to print only the current page.
Note that this only makes sense for pre-paginated documents. This
property is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"custom-tab-label"</entry>
<entry>Read-Write</entry>
<entry>Used as the label of the tab containing custom widgets.
Note that this property may be ignored on some platforms. If this
is <literal>None</literal>, GTK+ uses a default label. This
property is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"default-page-setup"</entry>
<entry>Read-Write</entry>
<entry>The <link
linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>
used by default. This page setup will be used by <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>,
but it can be overridden on a per-page basis by connecting to the
"request-page-setup" signal. This property is available in GTK+
2.10 and above.</entry>
</row>
<row valign="top">
<entry>"export-filename"</entry>
<entry>Read-Write</entry>
<entry>The name of a file file to generate instead of showing the
print dialog. Currently, PDF is the only supported format. The
intended use of this property is for implementing "Export to PDF"
actions. "Print to PDF" support is independent of this and is
done by letting the user pick the "Print to PDF" item from the
list of printers in the print dialog. This property is available
in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"has-selection"</entry>
<entry>Read-Write</entry>
<entry>Determines whether there is a selection in your application.
This can allow your application to print the selection. This is
typically used to make a "Selection" button sensitive.
Default value: <literal>False</literal>
This property is available in GTK+ 2.18 and above.</entry>
</row>
<row valign="top">
<entry>"job-name"</entry>
<entry>Read-Write</entry>
<entry>A string used to identify the job (e.g. in monitoring
applications like eggcups). If you don't set a job name, GTK+
picks a default one by numbering successive print jobs. This
property is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"n-pages"</entry>
<entry>Read-Write</entry>
<entry>The number of pages in the document. This
<emphasis>must</emphasis> be set to a positive number before the
rendering starts. It may be set in a "begin-print" signal hander.
Note that the page numbers passed to the "request-page-setup" and
"draw-page" signals are 0-based, i.e. if the user chooses to print
all pages, the last "draw-page" signal will be for page
<parameter>n_pages</parameter> - 1. This property is available in
GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"n-pages-to-print"</entry>
<entry>Read</entry>
<entry>The number of pages that will be printed.
Note that this value is set during print preparation phase
(<literal>gtk.PRINT_STATUS_PREPARING</literal>), so this value
should never be get before the data generation phase
(<literal>gtk.PRINT_STATUS_GENERATING_DATA</literal>).
You can connect to the "status-changed" signal and call
gtk_print_operation_get_n_pages_to_print() when print status is
<literal>gtk.PRINT_STATUS_GENERATING_DATA</literal>. This is
typically used to track the progress of print operation.
Default value: -1
This property is available in GTK+ 2.18 and above.</entry>
</row>
<row valign="top">
<entry>"print-settings"</entry>
<entry>Read-Write</entry>
<entry>The <link
linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
used for initializing the dialog. Setting this property is
typically used to re-establish print settings from a previous
print operation, see the <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
method. This property is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"show-progress"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> show a progress dialog during
the print operation. This property is available in GTK+ 2.10 and
above.</entry>
</row>
<row valign="top">
<entry>"status"</entry>
<entry>Read</entry>
<entry>The status of the print operation. This property is
available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"status-string"</entry>
<entry>Read</entry>
<entry>A string representation of the status of the print
operation. The string is translated and suitable for displaying
the print status e.g. in a <link
linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>.
See the "status" property for a status value that is suitable for
programmatic use. This property is available in GTK+ 2.10 and
above.</entry>
</row>
<row valign="top">
<entry>"support-selection"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, the print operation will support print
of selection. This allows the print dialog to show a "Selection" button.
Default value: <literal>False</literal>
This property is available in GTK+ 2.18 and above.</entry>
</row>
<row valign="top">
<entry>"track-print-status"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, the print operation will try to
continue report on the status of the print job in the printer
queues and printer. This can allow your application to show
things like "out of paper" issues, and when the print job actually
reaches the printer. However, this is often implemented using
polling, and should not be enabled unless needed. This property
is available in GTK+ 2.10 and above.</entry>
</row>
<row valign="top">
<entry>"unit"</entry>
<entry>Read-Write</entry>
<entry>The transformation for the cairo context obtained from
<link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
is set up in such a way that distances are measured in units of
<parameter>unit</parameter>. This property is available in GTK+
2.10 and above.</entry>
</row>
<row valign="top">
<entry>"use-full-page"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, the transformation for the
cairo context obtained from <link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
puts the origin at the top left corner of the page (which may not
be the top left corner of the sheet, depending on page orientation
and the number of pages per sheet). Otherwise, the origin is at
the top left corner of the imageable area (i.e. inside the
margins). This property is available in GTK+ 2.10 and
above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkprintoperation">
<title>gtk.PrintOperation Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkprintoperationpreview">gtk.PrintOperationPreview Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--begin-print">begin-print</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--create-custom-widget">create-custom-widget</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--custom-widget-apply">custom-widget-apply</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>widget</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--done">done</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>result</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--draw-page">draw-page</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>page_nr</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--end-print">end-print</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--paginate">paginate</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>printoperation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--preview">preview</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>preview</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>parent</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--request-page-setup">request-page-setup</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>page_nr</parameter></methodparam>
<methodparam><parameter>setup</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkprintoperation--status-changed">status-changed</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>printoperation</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para><link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
is the high-level, portable printing API. It looks a bit different than
other GTK+ dialogs such as the <link
linkend="class-gtkfilechooser"><classname>gtk.FileChooser</classname></link>,
since some platforms don't expose enough infrastructure to implement a
good print dialog. On such platforms, <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
uses the native print dialog. On platforms which do not provide a native
print dialog, GTK+ uses its own, see <link
linkend="class-gtkprintunixdialog"><classname>gtkunixprint.PrintUnixDialog</classname></link>.</para>
<para>The typical way to use the high-level printing API is to create a
<link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
object with the <link
linkend="constructor-gtkprintoperation"><methodname>gtk.PrintOperation</methodname></link>
constructor when the user selects to print. Then you set some properties
on it, e.g. the page size, any <link
linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>
from previous print operations, the number of pages, the current page,
etc.</para>
<para>Then you start the print operation by calling the <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
method. It will then show a dialog, let the user select a printer and
options. When the user finished the dialog various signals will be
emitted on the <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>,
the main one being "draw-page", which you are supposed to catch and
render the page on the provided <link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
using Cairo.</para>
<example>
<title>The high-level printing API</title>
<programlisting>
settings = None
def do_print():
print_op = gtk.PrintOperation()
if settings != None:
print_op.set_print_settings(settings)
print_op.connect("begin_print", begin_print)
print_op.connect("draw_page", draw_page)
res = print_op.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, main_window)
if res == gtk.PRINT_OPERATION_RESULT_APPLY:
settings = print_op.get_print_settings()
</programlisting>
</example>
<para>Printing support was added in GTK+ 2.10.</para>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-gtkprintoperation">
<title>gtk.PrintOperation</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.PrintOperation</methodname>
<methodparam></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.10 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkprintoperation--set-default-page-setup">
<title>gtk.PrintOperation.set_default_page_setup</title>
<programlisting><methodsynopsis language="python">
<methodname>set_default_page_setup</methodname>
<methodparam><parameter role="keyword">default_page_setup</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">default_page_setup</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link>,
or <literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_default_page_setup</methodname>() method
makes <parameter>default_page_setup</parameter> the default page
setup.</para>
<para>This page setup will be used by the <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
method, but it can be overridden on a per-page basis by connecting to
the "request-page-setup" signal.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-default-page-setup">
<title>gtk.PrintOperation.get_default_page_setup</title>
<programlisting><methodsynopsis language="python">
<methodname>get_default_page_setup</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the default page setup</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_default_page_setup</methodname>() method
returns the default page setup, see the <link
linkend="method-gtkprintoperation--set-default-page-setup"><methodname>gtk.PrintOperation.set_default_page_setup()</methodname></link>
method.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-print-settings">
<title>gtk.PrintOperation.set_print_settings</title>
<programlisting><methodsynopsis language="python">
<methodname>set_print_settings</methodname>
<methodparam><parameter role="keyword">print_settings</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">print_settings</parameter> :</term>
<listitem><simpara><link
linkend="class-gtkprintsettings"><classname>gtk.PrintSettings</classname></link>,
or <literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_print_settings</methodname>() method sets
the print settings. This is typically used to re-establish print
settings from a previous print operation, see the <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
method.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-print-settings">
<title>gtk.PrintOperation.get_print_settings</title>
<programlisting><methodsynopsis language="python">
<methodname>get_print_settings</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the current print settings.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_print_settings</methodname>() method returns
the current print settings.</para>
<para>Note that the return value is <literal>None</literal> until
either the <link
linkend="method-gtkprintoperation--set-print-settings"><methodname>gtk.PrintOperation.set_print_settings()</methodname></link>
or <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
methods have been called.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-job-name">
<title>gtk.PrintOperation.set_job_name</title>
<programlisting><methodsynopsis language="python">
<methodname>set_job_name</methodname>
<methodparam><parameter role="keyword">job_name</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">job_name</parameter> :</term>
<listitem><simpara>a string that identifies the print
job</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_job_name</methodname>() method sets the name
of the print job. The name is used to identify the job (e.g. in
monitoring applications like eggcups).</para>
<para>If you don't set a job name, GTK+ picks a default one by
numbering successive print jobs.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-n-pages">
<title>gtk.PrintOperation.set_n_pages</title>
<programlisting><methodsynopsis language="python">
<methodname>set_n_pages</methodname>
<methodparam><parameter role="keyword">n_pages</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">n_pages</parameter> :</term>
<listitem><simpara>the number of pages</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_n_pages</methodname>() >method sets the
number of pages in the document. </para>
<para>This <emphasis>must</emphasis> be set to a positive number
before the rendering starts. It may be set in a "begin-print" signal
hander.</para>
<para>Note that the page numbers passed to the "request-page-setup"
and "draw-page" signals are 0-based, i.e. if the user chooses to print
all pages, the last "draw-page" signal will be for page
<parameter>n_pages</parameter> - 1.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-current-page">
<title>gtk.PrintOperation.set_current_page</title>
<programlisting><methodsynopsis language="python">
<methodname>set_current_page</methodname>
<methodparam><parameter role="keyword">current_page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">current_page</parameter> :</term>
<listitem><simpara>the current page, 0-based</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_current_page</methodname>() method sets the
current page.</para>
<para>If this is called before <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>,
the user will be able to select to print only the current page.</para>
<para>Note that this only makes sense for pre-paginated
documents.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-use-full-page">
<title>gtk.PrintOperation.set_use_full_page</title>
<programlisting><methodsynopsis language="python">
<methodname>set_use_full_page</methodname>
<methodparam><parameter role="keyword">full_page</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">full_page</parameter> :</term>
<listitem><simpara><literal>True</literal> to set up the <link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
for the full page</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_use_full_page</methodname>() method sets the
"full-page" property to the value of
<parameter>full_page</parameter>. If <parameter>full_page</parameter>
is <literal>True</literal>, the transformation for the cairo context
obtained from <link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
puts the origin at the top left corner of the page (which may not be
the top left corner of the sheet, depending on page orientation and
the number of pages per sheet). Otherwise, the origin is at the top
left corner of the imageable area (i.e. inside the margins).</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-unit">
<title>gtk.PrintOperation.set_unit</title>
<programlisting><methodsynopsis language="python">
<methodname>set_unit</methodname>
<methodparam><parameter role="keyword">unit</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">unit</parameter> :</term>
<listitem><simpara>the unit to use</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_unit</methodname>() method sets up the
transformation for the cairo context such distances are measured in
units of <parameter>unit</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-export-filename">
<title>gtk.PrintOperation.set_export_filename</title>
<programlisting><methodsynopsis language="python">
<methodname>set_export_filename</methodname>
<methodparam><parameter role="keyword">filename</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">filename</parameter> :</term>
<listitem><simpara>the filename for the exported file</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_export_filename</methodname>() method sets
up the <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
to generate a file instead of showing the print dialog. The intended
use of this method is for implementing "Export to PDF"
actions. Currently, PDF is the only supported format.</para>
<para>"Print to PDF" support is independent of this and is done by
letting the user pick the "Print to PDF" item from the list of
printers in the print dialog.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-track-print-status">
<title>gtk.PrintOperation.set_track_print_status</title>
<programlisting><methodsynopsis language="python">
<methodname>set_track_print_status</methodname>
<methodparam><parameter role="keyword">track_status</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">track_status</parameter> :</term>
<listitem><simpara>if <literal>True</literal> track status after
printing</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_track_print_status</methodname>() method
sets the "track-print-status" to the value of
<parameter>track_status</parameter>. If
<parameter>track_status</parameter> is <literal>True</literal>, the
print operation will try to continue report on the status of the print
job in the printer queues and printer. This can allow your application
to show things like "out of paper" issues, and when the print job
actually reaches the printer.</para>
<para>This method is often implemented using some form of polling, so
it should not be enabled unless needed.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-show-progress">
<title>gtk.PrintOperation.set_show_progress</title>
<programlisting><methodsynopsis language="python">
<methodname>set_show_progress</methodname>
<methodparam><parameter role="keyword">show_progress</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">show_progress</parameter> :</term>
<listitem><simpara>if <literal>True</literal> show a progress
dialog</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_show_progress</methodname>() method sets the
"show-progress" property to the value of
<parameter>show_progress</parameter>. If
<parameter>show_progress</parameter> is <literal>True</literal>, the
print operation will show a progress dialog during the print
operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-allow-async">
<title>gtk.PrintOperation.set_allow_async</title>
<programlisting><methodsynopsis language="python">
<methodname>set_allow_async</methodname>
<methodparam><parameter role="keyword">allow_async</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">allow_async</parameter> :</term>
<listitem><simpara>if <literal>True</literal> allow asynchronous
operation</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_allow_async</methodname>() method sets the
"allow-async" to the value of <parameter>allow_async</parameter>. If
<parameter>allow_async</parameter> is <literal>True</literal> the
<link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
may return before the print operation is completed. Note that some
platforms may not allow asynchronous operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-custom-tab-label">
<title>gtk.PrintOperation.set_custom_tab_label</title>
<programlisting><methodsynopsis language="python">
<methodname>set_custom_tab_label</methodname>
<methodparam><parameter role="keyword">label</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">label</parameter> :</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_custom_tab_label</methodname>() method sets
the label for the tab holding custom widgets.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--run">
<title>gtk.PrintOperation.run</title>
<programlisting><methodsynopsis language="python">
<methodname>run</methodname>
<methodparam><parameter role="keyword">action</parameter></methodparam>
<methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">action</parameter> :</term>
<listitem><simpara>the action to start - one of the <xref
linkend="gtk-print-operation-action-constants"
endterm="gtk-print-operation-action-constants-title"></xref></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">parent</parameter> :</term>
<listitem><simpara>Transient parent of the dialog, or <literal>None</literal></simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the result of the print operation - one of the
<xref linkend="gtk-print-operation-result-constants"
endterm="gtk-print-operation-result-constants-title"></xref>. A
return value of
<literal>gtk.PRINT_OPERATION_RESULT_APPLY</literal> indicates that
the printing was completed successfully. In this case, it is a
good idea to obtain the used print settings with the <link
linkend="method-gtkprintoperation--get-print-settings"><methodname>gtk.PrintOperation.get_print_settings()</methodname></link>
method and store them for reuse with the next print operation. A
value of <literal>gtk.PRINT_OPERATION_RESULT_IN_PROGRESS</literal>
means the operation is running asynchronously, and will emit the
"done" signal when done.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>run</methodname>() method runs the print
operation, by first letting the user modify print settings in the
print dialog, and then print the document.</para>
<para>Normally that this method does not return until the rendering of
all pages is complete. You can connect to the "status-changed" signal
to obtain some information about the progress of the print operation.
Furthermore, it may use a recursive mainloop to show the print
dialog.</para>
<para>If you call the <link
linkend="method-gtkprintoperation--set-allow-async"><methodname>gtk.PrintOperation.set_allow_async()</methodname></link>
method or set the "allow-async" property the operation will run
asyncronously if this is supported on the platform. The "done" signal
will be emitted with the operation results when the operation is done
(i.e. when the dialog is canceled, or when the print succeeds or
fails).</para>
<para><informalexample><programlisting>
if settings != None:
print.set_print_settings( settings)
if page_setup != None:
print.set_default_page_setup(page_setup)
print.connect( "begin-print", begin_print, data)
print.connect("draw-page", draw_page, data)
res = print.run(gtk.PRINT_OPERATION_ACTION_PRINT_DIALOG, parent)
if res == gtkprint_OPERATION_RESULT_ERROR:
error_dialog = gtk.MessageDialog(parent,
gtk.DIALOG_DESTROY_WITH_PARENT,
gtk.MESSAGE_ERROR,
gtk.BUTTONS_CLOSE,
"Error printing file:\n")
error_dialog.connect("response", lambda w,id: w.destroy())
error_dialog.show()
elif res == gtk.PRINT_OPERATION_RESULT_APPLY:
settings = print.get_print_settings()
</programlisting></informalexample></para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-error">
<title>gtk.PrintOperation.get_error</title>
<programlisting><methodsynopsis language="python">
<methodname>get_error</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the error message or
<literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_error</methodname>() method returns the
error message or <literal>None</literal>. Call this when the result of
a print operation is
<literal>gtk.PRINT_OPERATION_RESULT_ERROR</literal>, either as
returned by the <link
linkend="method-gtkprintoperation--run"><methodname>gtk.PrintOperation.run()</methodname></link>
method, or in the "done" signal handler.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-status">
<title>gtk.PrintOperation.get_status</title>
<programlisting><methodsynopsis language="python">
<methodname>get_status</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the status of the print
operation</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_status</methodname>() method returns the
status of the print operation as one of the <xref
linkend="gtk-print-status-constants"
endterm="gtk-print-status-constants-title"></xref>. Also see the <link
linkend="method-gtkprintoperation--get-status-string"><methodname>gtk.PrintOperation.get_status_string()</methodname></link>
method.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-status-string">
<title>gtk.PrintOperation.get_status_string</title>
<programlisting><methodsynopsis language="python">
<methodname>get_status_string</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a string representation of the status of the
print operation</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_status_string</methodname>() method returns
a string representation of the status of the print operation. The
string is translated and suitable for displaying the print status
e.g. in a <link
linkend="class-gtkstatusbar"><classname>gtk.Statusbar</classname></link>.</para>
<para>Use the <link
linkend="method-gtkprintoperation--get-status"><methodname>gtk.PrintOperation.get_status()</methodname></link>
method to obtain a status value that is suitable for
programmatic use.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--is-finished">
<title>gtk.PrintOperation.is_finished</title>
<programlisting><methodsynopsis language="python">
<methodname>is_finished</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal>, if the print operation
is finished.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The method returns True if the print operation is
completed. This is a convenience method to find out if the print
operation is finished, either successfully
(<literal>gtk.PRINT_STATUS_FINISHED</literal>) or unsuccessfully
(<literal>gtk.PRINT_STATUS_FINISHED_ABORTED</literal>).</para>
<note>
<para>When you enable print status tracking, the print operation can
be in a non-finished state even after done has been called, as the
operation status then tracks the print job status on the
printer.</para>
</note>
</refsect2>
<refsect2 id="method-gtkprintoperation--cancel">
<title>gtk.PrintOperation.cancel</title>
<programlisting><methodsynopsis language="python">
<methodname>cancel</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>cancel</methodname>() method cancels a running
print operation. This method may be called from a "begin-print",
"paginate" or "draw-page" signal handler to stop the currently running
print operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-support-selection">
<title>gtk.PrintOperation.set_support_selection</title>
<programlisting><methodsynopsis language="python">
<methodname>set_support_selection</methodname>
<methodparam><parameter role="keyword">support_selection</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">support_selection</parameter> :</term>
<listitem><simpara><literal>True</literal> to support selection.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>set_support_selection</methodname>() method sets whether "print selection" is supported by the print operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-support-selection">
<title>gtk.PrintOperation.get_support_selection</title>
<programlisting><methodsynopsis language="python">
<methodname>get_support_selection</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>whether the application supports print of selection.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_support_selection</methodname>() method gets whether "print selection" is supported by the print operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-has-selection">
<title>gtk.PrintOperation.set_has_selection</title>
<programlisting><methodsynopsis language="python">
<methodname>set_has_selection</methodname>
<methodparam><parameter role="keyword">has_selection</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">has_selection</parameter> :</term>
<listitem><simpara><literal>True</literal> indicates that a selection exists.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>set_has_selection</methodname>() method sets whether there is a selection to print.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-has-selection">
<title>gtk.PrintOperation.get_has_selection</title>
<programlisting><methodsynopsis language="python">
<methodname>get_has_selection</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> when a selection exists.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_has_selection</methodname>() method gets whether there is a selection to print.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-embed-page-setup">
<title>gtk.PrintOperation.set_embed_page_setup</title>
<programlisting><methodsynopsis language="python">
<methodname>set_embed_page_setup</methodname>
<methodparam><parameter role="keyword">embed</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">embed</parameter> :</term>
<listitem><simpara><literal>True</literal> to embed page setup selection in the GtkPrintDialog.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>set_embed_page_setup</methodname>() method embeds the page size combo box and orientation combo box
into the page setup page. Selected page setup is stored as default page setup in the print operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-embed-page-setup">
<title>gtk.PrintOperation.get_embed_page_setup</title>
<programlisting><methodsynopsis language="python">
<methodname>get_embed_page_setup</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> when page setup selection combos are embedded.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_embed_page_setup</methodname>() method XXX.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--get-n-pages-to-print">
<title>gtk.PrintOperation.get_n_pages_to_print</title>
<programlisting><methodsynopsis language="python">
<methodname>get_n_pages_to_print</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the number of pages that will be printed.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.22 and above.</para>
</note>
<para>The <methodname>get_n_pages_to_print</methodname>() method returns the number of pages that will be printed.</para>
<para>Note that this value is set during print preparation phase (<literal>gtk.PRINT_STATUS_PREPARING)</literal>, so this
function should never be called before the data generation phase (<literal>gtk.PRINT_STATUS_GENERATING_DATA</literal>). You
can connect to the "status-changed" signal and call <methodname>get_n_pages_to_print</methodname>() when print status is
<literal>gtk.PRINT_STATUS_GENERATING_DATA</literal>. This is typically used to track the progress of print operation.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--draw-page-finish">
<title>gtk.PrintOperation.draw_page_finish</title>
<programlisting><methodsynopsis language="python">
<methodname>draw_page_finish</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>The <methodname>draw_page_finish</methodname>() method signals that the drawing of a particular page is complete.</para>
<para>It is called after completion of page drawing (e.g. drawing in another thread). If
<methodname><link linkend="method-gtkprintoperation--set-defer-drawing">set_defer_drawing</link></methodname>()
was called before, then this function has to be called by application. In another case it is called by the library itself.</para>
</refsect2>
<refsect2 id="method-gtkprintoperation--set-defer-drawing">
<title>gtk.PrintOperation.set_defer_drawing</title>
<programlisting><methodsynopsis language="python">
<methodname>set_defer_drawing</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>The <methodname>set_defer_drawing</methodname>() method sets up the print operation to wait for calling of
<methodname><link linkend="method-gtkprintoperation--draw-page-finish">draw_page_finish</link></methodname>()
from application. It can be used for drawing page in another thread.</para>
<para>This function must be called in the callback of "draw-page" signal. .</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkprintoperation--begin-print">
<title>The "begin-print" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link>
on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
for the current operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "begin-print" signal is emitted after the user has finished
changing print settings in the dialog, before the actual rendering
starts.</para>
<para>A typical use for this signal is to use the parameters from the
<link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
and paginate the document accordingly, and then set the number of
pages with <link
linkend="method-gtkprintoperation--set-n-pages"><methodname>gtk.PrintOperation.set_n_pages()</methodname></link>.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--create-custom-widget">
<title>The "create-custom-widget" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A custom widget that gets embedded in the print
dialog, or <literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "create-custom-widget" signal is emitted when displaying the
print dialog. If you return a widget in a handler for this signal it
will be added to a custom tab in the print dialog. You typically
return a container widget with multiple widgets in it.</para>
<para>The print dialog owns the returned widget, and its lifetime
isn't controlled by the app. However, the widget is guaranteed to stay
around until the "custom-widget-apply" signal is emitted on the
operation. Then you can read out any information you need from the
widgets.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--custom-widget-apply">
<title>The "custom-widget-apply" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>widget</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>widget</parameter> :</term>
<listitem><simpara>the custom widget added in create-custom-widget</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "custom-widget-apply" signal is emitted right before
"begin-print" if you added a custom widget in the
"create-custom-widget" handler. When you get this signal you should
read the information from the custom widgets, as the widgets are not
guaraneed to be around at a later time.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--done">
<title>The "done" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>result</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>result</parameter> :</term>
<listitem><simpara>the result of the print operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "done" signal is emitted when the print operation run has
finished doing everything required for
printing. <parameter>result</parameter> (one of the <xref
linkend="gtk-print-operation-result-constants"
endterm="gtk-print-operation-result-constants-title"></xref>) gives
you information about what happened during the run. If
<parameter>result</parameter> is
<literal>gtk.PRINT_OPERATION_RESULT_ERROR</literal> then you can call
the <link
linkend="method-gtkprintoperation--get-error"><methodname>gtk.PrintOperation.get_error()</methodname></link>
method for more information.</para>
<para>If you enabled print status tracking then the <link
linkend="method-gtkprintoperation--is-finished"><methodname>gtk.PrintOperation.is_finished()</methodname></link>
method may still return <literal>False</literal> after this was
emitted.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--draw-page">
<title>The "draw-page" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>page_nr</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> for the current operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>page_nr</parameter> :</term>
<listitem><simpara>the number of the currently printed page</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "draw-page" signal is emitted for every page that is
printed. The signal handler must render the
<parameter>page_nr</parameter>'s page onto the cairo context obtained
from <parameter>context</parameter> using <link
linkend="method-gtkprintcontext--get-cairo-context"><methodname>gtk.PrintContext.get_cairo_context()</methodname></link>.</para>
<para><informalexample><programlisting>
def draw_page(operation, context, page_nr, user_data):
cr = context.get_cairo_context()
width = context.get_width()
cr.rectangle(0, 0, width, HEADER_HEIGHT)
cr.set_source_rgb(0.8, 0.8, 0.8);
cr.fill()
layout = context.create_pango_layout()
desc = pango.FontDescription("sans 14")
layout.set_font_description(desc)
layout.set_text("some text")
layout.set_width(width)
layout.set_alignment(pango.ALIGN_CENTER)
x,layout_height = layout.get_size()
text_height = layout_height / pango.SCALE
cr.move_to(width / 2, (HEADER_HEIGHT - text_height) / 2)
cr.show_layout(layout)
</programlisting></informalexample></para>
<para>Use the <link
linkend="method-gtkprintoperation--set-use-full-page"><methodname>gtk.PrintOperation.set_use_full_page()</methodname></link>
and <link
linkend="method-gtkprintoperation--set-unit"><methodname>gtk.PrintOperation.set_unit()</methodname></link>
methods before starting the print operation to set up the
transformation of the cairo context according to your
needs.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--end-print">
<title>The "end-print" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> for the current operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "end-print" signal is emitted after all pages have been
rendered. A handler for this signal can clean up any resources that
have been allocated in the "begin-print" handler.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--paginate">
<title>The "paginate" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>printoperation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>printoperation</parameter> :</term>
<listitem><simpara>the object which received the signal.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter> :</term>
<listitem><simpara>the <link
linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link>
for the current operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "paginate" signal is emitted after the "begin-print" signal,
but before the actual rendering starts. It keeps getting emitted until
it returns <literal>False</literal>.</para>
<para>This signal is intended to be used for paginating the document
in small chunks, to avoid blocking the user interface for a long
time. The signal handler should update the number of pages using the
<link
linkend="method-gtkprintoperation--set-n-pages"><methodname>gtk.PrintOperation.set_n_pages</methodname>()</link>
method, and return <literal>True</literal> if the document has been
completely paginated.</para>
<para>If you don't need to do pagination in chunks, you can simply do
it all in the "begin-print" handler, and set the number of pages from
there.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--preview">
<title>The "preview" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>preview</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>parent</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>preview</parameter> :</term>
<listitem><simpara>the <literal>GtkPrintPreviewOperation</literal> for the current operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> that will be used</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>parent</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to use as window parent, or <literal>None</literal></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the listener wants to take over control of the preview</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "preview" signal is emitted when a preview is requested from
the native dialog. If you handle this you must set the cairo context
on the printing context.</para>
<para>If you don't override this, a default implementation using an
external viewer will be used.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--request-page-setup">
<title>The "request-page-setup" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>context</parameter></methodparam>
<methodparam><parameter>page_nr</parameter></methodparam>
<methodparam><parameter>setup</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintcontext"><classname>gtk.PrintContext</classname></link> for the current operation</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>page_nr</parameter> :</term>
<listitem><simpara>the number of the currently printed page</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>setup</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkpagesetup"><classname>gtk.PageSetup</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "request-page-setup" signal is emitted once for every page
that is printed, to give the application a chance to modify the page
setup. Any changes done to <parameter>setup</parameter> will be in
force only for printing this page.</para>
</refsect2>
<refsect2 id="signal-gtkprintoperation--status-changed">
<title>The "status-changed" gtk.PrintOperation Signal</title>
<programlisting><methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>operation</parameter></methodparam>
<methodparam><parameter>printoperation</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>operation</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkprintoperation"><classname>gtk.PrintOperation</classname></link> on which the signal was emitted</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>printoperation</parameter> :</term>
<listitem><simpara>the object which received the signal.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.10 and above.</para>
</note>
<para>The "status-changed" signal is emitted at between the various
phases of the print operation. See the <xref
linkend="gtk-print-status-constants"
endterm="gtk-print-status-constants-title"></xref> for the phases that
are being discriminated. Use the <link
linkend="method-gtkprintoperation--get-status"><methodname>gtk.PrintOperation.get_status</methodname>()</link>
method to find out the current status.</para>
</refsect2>
</refsect1>
</refentry>
|