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
|
<?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-gtkcombobox">
<refnamediv>
<refname>gtk.ComboBox</refname> <refpurpose>a widget used to choose from
a list of items (new in PyGTK 2.4)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.ComboBox</classname></ooclass>
<ooclass><classname><link linkend="class-gtkbin">gtk.Bin</link></classname></ooclass>
<ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkcombobox">gtk.ComboBox</link></methodname>
<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-has-entry">get_has_entry</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-entry-text-column">get_entry_text_column</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-entry-text-column">set_entry_text_column</link></methodname>
<methodparam><parameter role="keyword">text_column</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-wrap-width">get_wrap_width</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-wrap-width">set_wrap_width</link></methodname>
<methodparam><parameter role="keyword">width</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-row-span-column">get_row_span_column</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-row-span-column">set_row_span_column</link></methodname>
<methodparam><parameter role="keyword">row_span</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-column-span-column">get_column_span_column</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-column-span-column">set_column_span_column</link></methodname>
<methodparam><parameter role="keyword">column_span</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-button-sensitivity">get_button_sensitivity</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-button-sensitivity">set_button_sensitivity</link></methodname>
<methodparam><parameter role="keyword">sensitivity</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-active">get_active</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-active">set_active</link></methodname>
<methodparam><parameter role="keyword">index</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-active-iter">get_active_iter</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-active-iter">set_active_iter</link></methodname>
<methodparam><parameter role="keyword">iter</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-model">set_model</link></methodname>
<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-model">get_model</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--append-text">append_text</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--insert-text">insert_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--prepend-text">prepend_text</link></methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--remove-text">remove_text</link></methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-active-text">get_active_text</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--popup">popup</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--popdown">popdown</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-popup-accessible">get_popup_accessible</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<!-- NOT IMPLEMENTED
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox- -get-row-separator-func">get_row_separator_func</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
END NOT IMPLEMENTED -->
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-row-separator-func">set_row_separator_func</link></methodname>
<methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-add-tearoffs">get_add_tearoffs</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-add-tearoffs">set_add_tearoffs</link></methodname>
<methodparam><parameter role="keyword">add_tearoffs</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-focus-on-click">get_focus_on_click</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-focus-on-click">set_focus_on_click</link></methodname>
<methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-title">get_title</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--set-title">set_title</link></methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gtk--combo-box-new-text">gtk.combo_box_new_text</link></methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtkcombobox">gtk.ComboBox</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
<link linkend="class-atkimplementor"><classname>atk.ImplementorIFace</classname></link>
<link linkend="class-gtkcelleditable"><classname>gtk.CellEditable</classname></link>
<link linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkcombobox">
<title>gtk.ComboBox Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<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="4in"/>
<tbody>
<row valign="top">
<entry>"active"</entry>
<entry>Read-Write</entry>
<entry>The index of the item that is currently active.. If the
model is a non-flat treemodel, and the active item is not an
immediate child of the root of the tree, this property has the
value of the first index of the path of the item. This
property is available in GTK+ 2.4 and above.</entry>
</row>
<row valign="top">
<entry>"add-tearoffs"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> generated menus have tearoff
menu items. Note that this only affects menu style combo
boxes. Default value: <literal>False</literal>. Available in
GTK+ 2.6 and above.</entry>
</row>
<row valign="top">
<entry>"button-sensitivity"</entry>
<entry>Read-Write</entry>
<entry>Whether the dropdown button is sensitive when the model is empty.
Default value: gtk.SENSITIVITY_AUTO. Available in
GTK+ 2.14 and above.</entry>
</row>
<row valign="top">
<entry>"column-span-column"</entry>
<entry>Read-Write</entry>
<entry>The TreeModel column containing the column span values.
This property is available in GTK+ 2.4 and above</entry>
</row>
<row valign="top">
<entry>"entry-text-column"</entry>
<entry>Read-Write</entry>
<entry>The column in the combo box's model to associate with strings from
the entry if the combo was created with "has-entry" = <literal>True</literal>.
This property is available in GTK+ 2.24 and above</entry>
</row>
<row valign="top">
<entry>"focus-on-click"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> the combo box grabs focus
when it is clicked with the mouse. Default value:
<literal>True</literal></entry>
</row>
<row valign="top">
<entry>"has-entry"</entry>
<entry>Read-Write-Construct Only</entry>
<entry>Whether the combo box has an entry. Default value: <literal>False</literal>.
This property is available in GTK+ 2.24 and above</entry>
</row>
<row valign="top">
<entry>"has-frame"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> the combo box grabs focus
when it is clicked with the mouse. Default value:
<literal>True</literal>. Available in GTK+ 2.6 and
above.</entry>
</row>
<row valign="top">
<entry>"model"</entry>
<entry>Read-Write</entry>
<entry>The TreeModel for the combo box. This property is
available in GTK+ 2.4 and above.</entry>
</row>
<row valign="top">
<entry>"popup-shown"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> the dropdown menu of the
combobox is popped up. Note that this property is mainly
useful, because it allows you to connect to the
"notify::popup-shown" signal. Available in GTK+ 2.10 and
above.</entry>
</row>
<row valign="top">
<entry>"row-span-column"</entry>
<entry>Read-Write</entry>
<entry>The TreeModel column containing the row span
values. This property is available in GTK+ 2.4 and
above.</entry>
</row>
<row valign="top">
<entry>"tearoff-title"</entry>
<entry>Read-Write</entry>
<entry>A title that may be displayed by the window manager
when the popup is torn-off. Default value: "". Available in
GTK+ 2.10 and above</entry>
</row>
<row valign="top">
<entry>"wrap-width"</entry>
<entry>Read-Write</entry>
<entry>The number of columns to use to lay out the popup
items. This property is available in GTK+ 2.4 and
above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkcombobox">
<title>gtk.ComboBox Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<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="4in"/>
<tbody>
<row valign="top">
<entry>"appears-as-list"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, the combo box dropdowns
should look like lists rather than menus.</entry>
</row>
<row valign="top">
<entry>"arrow-size"</entry>
<entry>Read-Write</entry>
<entry>Sets the minimum size of the arrow in the combo box. Note that
the arrow size is coupled to the font size, so in case a larger font
is used, the arrow will be larger than set by arrow size.
Allowed values: >= 0. Default value: 15. Available in
GTK+ 2.12 and above.</entry>
</row>
<row valign="top">
<entry>"shadow-type"</entry>
<entry>Read-Write</entry>
<entry>Which kind of shadow to draw around the combo box.
Default value: gtk.SHADOW_NONE.
This property is available in GTK+ 2.12 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkcombobox">
<title>gtk.ComboBox Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcelleditable">gtk.CellEditable Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtkcombobox--changed">changed</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkcombobox--move-active">move-active</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>scroll_type</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkcombobox--popdown">popdown</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
<varlistentry>
<term>"<link linkend="signal-gtkcombobox--popup">popup</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This widget is available in GTK+ 2.4 and PyGTK 2.4 and above.</para>
</note>
<para>The <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
is a replacement for the <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>. The
<link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
implements the <link
linkend="class-gtkcelllayout"><classname>gtk.CellLayout</classname></link>
interface that provides a number of useful methods for managing the
contents. A <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
is created with the <link
linkend="constructor-gtkcombobox">gtk.ComboBox()</link> constructor that
is associated with the optional <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>. If
no <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
is specified it can be added later with the <link
linkend="method-gtkcombobox--set-model"><methodname>set_model</methodname>()</link>
method.</para>
<para>Alternatively, the <link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function creates a simple <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
and associated <link
linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
model. A <link
linkend="class-gtkcellrenderertext"><classname>gtk.CellRendererText</classname></link>
is also created and packed in the new combo box. In this simple combo
box each list item is a text string that can be selected. The
convenience methods <link
linkend="method-gtkcombobox--append-text"><methodname>append_text</methodname>()</link>,
<link
linkend="method-gtkcombobox--prepend-text"><methodname>prepend_text</methodname>()</link>,
<link
linkend="method-gtkcombobox--insert-text"><methodname>insert_text</methodname>()</link>
and <link
linkend="method-gtkcombobox--remove-text"><methodname>remove_text</methodname>()</link>
can be used to manage the contents of the <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>. Using
the <link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function is equivalent to:</para>
<programlisting>
liststore = gtk.ListStore(gobject.TYPE_STRING)
combobox = gtk.ComboBox(liststore)
cell = gtk.CellRendererText()
combobox.pack_start(cell, True)
combobox.add_attribute(cell, 'text', 0)
</programlisting>
</refsect1>
<refsect1 id="constructor-gtkcombobox">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.ComboBox</methodname>
<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">model</parameter> :</term>
<listitem><simpara>A valid <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A new <link linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.4 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
associated with the optional <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
specified by <parameter>model</parameter>. If
<parameter>model</parameter> is not specified the combo box will not
have an associated tree model.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkcombobox--get-has-entry">
<title>gtk.ComboBox.get_has_entry</title>
<programlisting><methodsynopsis language="python">
<methodname>get_has_entry</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>Whether there is an entry in the combo box.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>get_has_entry</methodname>() method returns
whether the combo box has an entry.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-entry-text-column">
<title>gtk.ComboBox.get_entry_text_column</title>
<programlisting><methodsynopsis language="python">
<methodname>get_entry_text_column</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A column in the data source model of the combo box.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>get_entry_text_column</methodname>() method returns
the columns which the combo box is using to get the strings
from to display in the internal entry.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-entry-text-column">
<title>gtk.ComboBox.set_entry_text_column</title>
<programlisting><methodsynopsis language="python">
<methodname>set_entry_text_column</methodname>
<methodparam><parameter role="keyword">text_column</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text_column</parameter> :</term>
<listitem><simpara>A column in the data source model to get the strings from for the internal entry.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.24 and above.</para>
</note>
<para>The <methodname>set_entry_text_column</methodname>() method sets the model column
which the combo box should use to get strings from to be text_column. The column text_column
in the model of combo box must be of type G_TYPE_STRING.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-wrap-width">
<title>gtk.ComboBox.get_wrap_width</title>
<programlisting><methodsynopsis language="python">
<methodname>get_wrap_width</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The wrap width.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_wrap_width</methodname>() method returns the
value of the "wrap-width" property of the combo box as set by the <link
linkend="method-gtkcombobox--set-wrap-width"><methodname>set_wrap_width</methodname>()</link>
method. The wrap width is basically the preferred number of columns to use
to lay out the popup i.e. lays out the popup items in a table with
<parameter>width</parameter> columns.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-wrap-width">
<title>gtk.ComboBox.set_wrap_width</title>
<programlisting><methodsynopsis language="python">
<methodname>set_wrap_width</methodname>
<methodparam><parameter role="keyword">width</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">width</parameter> :</term>
<listitem><simpara>The preferred number of columns of
width.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_wrap_width</methodname>() method sets the
wrap width (and the "wrap-width" property) of the combo box to the value
specified by <parameter>width</parameter>. The wrap width is basically the
preferred number of columns to use to lay out the popup i.e. lays out the
popup items in a table with <parameter>width</parameter> columns.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-row-span-column">
<title>gtk.ComboBox.get_row_span_column</title>
<programlisting><methodsynopsis language="python">
<methodname>get_row_span_column</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The row span column.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_row_span_column</methodname>() method
returns the value of the "row-span-column" property. The "row-span-column"
property indicates the column in the associated <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
that contains an integer that indicates how many rows the item should
span.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-row-span-column">
<title>gtk.ComboBox.set_row_span_column</title>
<programlisting><methodsynopsis language="python">
<methodname>set_row_span_column</methodname>
<methodparam><parameter role="keyword">row_span</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">row_span</parameter> :</term>
<listitem><simpara>A column in the model passed during construction.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_row_span_column</methodname>() method sets
the "row-span-column" property to the value specified by
<parameter>row_span</parameter>. The "row-span-column" property indicates
the column in the associated <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
that contains an integer that indicates how many rows the item should
span.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-column-span-column">
<title>gtk.ComboBox.get_column_span_column</title>
<programlisting><methodsynopsis language="python">
<methodname>get_column_span_column</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The column span column.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_column_span_column</methodname>() method
returns the value of the "column-span-column" property. The
"column-span-column" property indicates the column in the associated <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
that contains an integer that indicates how many columns the item should
span.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-column-span-column">
<title>gtk.ComboBox.set_column_span_column</title>
<programlisting><methodsynopsis language="python">
<methodname>set_column_span_column</methodname>
<methodparam><parameter role="keyword">column_span</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">column_span</parameter> :</term>
<listitem><simpara>A column in the model passed during construction.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_column_span_column</methodname>() method
sets the "column-span-column" property to the value specified by
<parameter>column_span</parameter>. The "column-span-column" property
indicates the column in the associated <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> row
that contains an integer that indicates how many columns the item should
span.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-button-sensitivity">
<title>gtk.ComboBox.get_button_sensitivity</title>
<programlisting><methodsynopsis language="python">
<methodname>get_button_sensitivity</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>gtk.SENSITIVITY_ON if the dropdown button is sensitive when
the model is empty, gtk.SENSITIVITY_OFF if the button is always insensitive
or gtk.SENSITIVITY_AUTO if it is only sensitive as long as the model
has one item to be selected.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>get_button_sensitivity</methodname>() method returns whether
the combo box sets the dropdown button sensitive or not when there are no items in the model.
</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-button-sensitivity">
<title>gtk.ComboBox.set_button_sensitivity</title>
<programlisting><methodsynopsis language="python">
<methodname>set_button_sensitivity</methodname>
<methodparam><parameter role="keyword">sensitivity</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">sensitivity</parameter> :</term>
<listitem><simpara>specify the sensitivity of the dropdown button.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>set_button_sensitivity</methodname>() method sets whether the
dropdown button of the combo box should be always sensitive (gtk.SENSITIVITY_ON),
never sensitive (gtk.SENSITIVITY_OFF) or only if there is at least one item to
display (gtk.SENSITIVITY_AUTO).
</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-active">
<title>gtk.ComboBox.get_active</title>
<programlisting><methodsynopsis language="python">
<methodname>get_active</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>An integer which is the model index of the
currently active item, or -1 if there's no active
item.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_active</methodname>() method returns the
value of the "active" property which is the index in the model of the
currently active item, or -1 if there's no active item. If the model
is a non-flat treemodel, and the active item is not an immediate child
of the root of the tree, this method returns the first path index of
the active item. For example if the path of the active item is (1, 0,
2) this method will return 1.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-active">
<title>gtk.ComboBox.set_active</title>
<programlisting><methodsynopsis language="python">
<methodname>set_active</methodname>
<methodparam><parameter role="keyword">index</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">index</parameter> :</term>
<listitem><simpara>An index in the model passed during
construction, or -1 to have no active item.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_active</methodname>() method sets the active
item of the combo_box to the item with the model index specified by
<parameter>index</parameter>. If <parameter>index</parameter> is -1 the
combo box will have no active item. The "active" property is also set to the
value of <parameter>index</parameter>.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-active-iter">
<title>gtk.ComboBox.get_active_iter</title>
<programlisting><methodsynopsis language="python">
<methodname>get_active_iter</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
that points at the active item or <literal>None</literal> if there
is no active item.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_active_iter</methodname>() method returns a
<link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
that points to the current active item or <literal>None</literal> if
there is no active item.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-active-iter">
<title>gtk.ComboBox.set_active_iter</title>
<programlisting><methodsynopsis language="python">
<methodname>set_active_iter</methodname>
<methodparam><parameter role="keyword">iter</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">iter</parameter> :</term>
<listitem><simpara>A valid <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
pointing at an item in the associated <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_active_iter</methodname>() method sets the
current active item to be the one referenced by <parameter>iter</parameter>
in the associated <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.
<parameter>iter</parameter> must correspond to a path of depth one. The
"active" property is also set by this method.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-model">
<title>gtk.ComboBox.set_model</title>
<programlisting><methodsynopsis language="python">
<methodname>set_model</methodname>
<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">model</parameter> :</term>
<listitem><simpara>A <link linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_model</methodname>() method sets the model
used by the combo box to the value specified by
<parameter>model</parameter>. The "model" property will also be set to the
value of <parameter>model</parameter>. A previously set model will be
unset. If <parameter>model</parameter> is <literal>None</literal> or not
specified, the old model will be unset.</para>
<note>
<para>In PyGTK 2.4.0 the model could not be <literal>None</literal>
and did not default to <literal>None</literal>.</para>
</note>
</refsect2>
<refsect2 id="method-gtkcombobox--get-model">
<title>gtk.ComboBox.get_model</title>
<programlisting><methodsynopsis language="python">
<methodname>get_model</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
or <literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_model</methodname>() method returns the
value of the "model" property which contains the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
that is acting as data source for the combo_box or <literal>None</literal>
if no <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link> is
associated with the combo box.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--append-text">
<title>gtk.ComboBox.append_text</title>
<programlisting><methodsynopsis language="python">
<methodname>append_text</methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>A string.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<warning>
<para>This method is deprecated since PyGTK 2.24 and should not be used in newly-written code.
Use <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
instead.</para>
</warning>
<para>The <methodname>append_text</methodname>() method appends the
string specified by <parameter>text</parameter> to the list of strings
stored in the combo box <link
linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>. Note
that you can only use this method with combo boxes constructed with the
<link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--insert-text">
<title>gtk.ComboBox.insert_text</title>
<programlisting><methodsynopsis language="python">
<methodname>insert_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>A model index where the
<parameter>text</parameter> should be
inserted.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>A string.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<warning>
<para>This method is deprecated since PyGTK 2.24 and should not be used in newly-written code.
Use <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
instead.</para>
</warning>
<para>The <methodname>insert_text</methodname>() method inserts the
string specified by <parameter>text</parameter> in the combo box <link
linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link> at
the index specified by <parameter>position</parameter>. Note that you can
only use this method with combo boxes constructed with the <link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--prepend-text">
<title>gtk.ComboBox.prepend_text</title>
<programlisting><methodsynopsis language="python">
<methodname>prepend_text</methodname>
<methodparam><parameter role="keyword">text</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">text</parameter> :</term>
<listitem><simpara>A string.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<warning>
<para>This method is deprecated since PyGTK 2.24 and should not be used in newly-written code.
Use <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
instead.</para>
</warning>
<para>The <methodname>prepend_text</methodname>() method prepends the
string specified by <parameter>text</parameter> to the list of strings
stored in the <link
linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>
associated with the combo_box. Note that you can only use this method with
combo boxes constructed with the <link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--remove-text">
<title>gtk.ComboBox.remove_text</title>
<programlisting><methodsynopsis language="python">
<methodname>remove_text</methodname>
<methodparam><parameter role="keyword">position</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">position</parameter> :</term>
<listitem><simpara>Index of the item to remove.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<warning>
<para>This method is deprecated since PyGTK 2.24 and should not be used in newly-written code.
Use <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
instead.</para>
</warning>
<para>The <methodname>remove_text</methodname>() method removes the
string at the index specified by <parameter>position</parameter> in the
associated <link
linkend="class-gtkliststore"><classname>gtk.ListStore</classname></link>. Note
that you can only use this function with combo boxes constructed with the
<link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-active-text">
<title>gtk.ComboBox.get_active_text</title>
<programlisting><methodsynopsis language="python">
<methodname>get_active_text</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The currently active text.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<warning>
<para>This method is deprecated since PyGTK 2.24 and should not be used in newly-written code.
Use <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
instead.</para>
</warning>
<para>The <methodname>get_active_text</methodname>() method returns
the currently active string or <literal>None</literal> if no entry is
selected. Note that you can only use this function with combo boxes
constructed with the <link
linkend="function-gtk--combo-box-new-text"><function>gtk.combo_box_new_text</function>()</link>
function.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--popup">
<title>gtk.ComboBox.popup</title>
<programlisting><methodsynopsis language="python">
<methodname>popup</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>popup</methodname>() method pops up the menu or
dropdown list of the combo box. This method is mostly intended for use
by accessibility technologies; applications should have little use for
it.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--popdown">
<title>gtk.ComboBox.popdown</title>
<programlisting><methodsynopsis language="python">
<methodname>popdown</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>popdown</methodname>() method hides the menu or
dropdown list of the combo box. This method is mostly intended for use by
accessibility technologies; applications should have little use for
it.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-popup-accessible">
<title>gtk.ComboBox.get_popup_accessible</title>
<programlisting><methodsynopsis language="python">
<methodname>get_popup_accessible</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the accessible object corresponding to the
popup.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_popup_accessible</methodname>() method gets
the accessible object corresponding to the popup. This method is mostly
intended for use by accessibility technologies; applications should have
little use for it.</para>
</refsect2>
<!-- NOT IMPLEMENTED
<refsect2 id="method-gtkcombobox- -get-row-separator-func">
<title>gtk.ComboBox.get_row_separator_func</title>
<programlisting><methodsynopsis language="python">
<methodname>get_row_separator_func</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara> the current row separator
function.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_row_separator_func</methodname>() method
returns the current row separator function as set by the <link
linkend="method-gtkcombobo- -set-row-separator-func"><methodname>set_row_separator_func</methodname>()</link>
method.</para>
</refsect2>
END NOT IMPLEMENTED -->
<refsect2 id="method-gtkcombobox--set-row-separator-func">
<title>gtk.ComboBox.set_row_separator_func</title>
<programlisting><methodsynopsis language="python">
<methodname>set_row_separator_func</methodname>
<methodparam><parameter role="keyword">func</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter role="keyword">data</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">func</parameter> :</term>
<listitem><simpara>a function or
<literal>None</literal></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">data</parameter> :</term>
<listitem><simpara>user data to pass to
<parameter>func</parameter></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>set_row_separator_func</methodname>() method
sets the row separator function to <parameter>func</parameter>, which is
used to determine if a row should be drawn as a separator. If func is
<literal>None</literal>, no separators are drawn. This is the default
value.</para>
<para>The signature of <parameter>func</parameter> is:</para>
<programlisting>
def func(model, iter, user_data):
</programlisting>
<para>where <parameter>model</parameter> is the <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
used by the combo box, <parameter>iter</parameter> is a <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>
pointing at a row in <parameter>model</parameter> and
<parameter>user_data</parameter> is
<parameter>data</parameter>. <parameter>func</parameter> returns
<literal>True</literal> if the row is a separator. A common way to implement
<parameter>func</parameter> is to have a boolean column in
<parameter>model</parameter>, that indicates if the row is a
separator.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-add-tearoffs">
<title>gtk.ComboBox.get_add_tearoffs</title>
<programlisting><methodsynopsis language="python">
<methodname>get_add_tearoffs</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if menus should have a
tearoff menuitem.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_add_tearoffs</methodname>() method returns the
value of the "add-tearoffs" property.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-add-tearoffs">
<title>gtk.ComboBox.set_add_tearoffs</title>
<programlisting><methodsynopsis language="python">
<methodname>set_add_tearoffs</methodname>
<methodparam><parameter role="keyword">add_tearoffs</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">add_tearoffs</parameter> :</term>
<listitem><simpara>if <literal>True</literal> add tearoff menu items</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>set_add_tearoffs</methodname>() method sets the
"add-tearoffs" property to the value of
<parameter>add_tearoffs</parameter>. If <parameter>add_tearoffs</parameter>
is <literal>True</literal>, the popup menu should have a tearoff menu
item.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-focus-on-click">
<title>gtk.ComboBox.get_focus_on_click</title>
<programlisting><methodsynopsis language="python">
<methodname>get_focus_on_click</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the combo box grabs
focus when it is clicked with the mouse.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>get_focus_on_click</methodname>() method returns
the value of the "focus-on-click" property.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-focus-on-click">
<title>gtk.ComboBox.set_focus_on_click</title>
<programlisting><methodsynopsis language="python">
<methodname>set_focus_on_click</methodname>
<methodparam><parameter role="keyword">focus_on_click</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">focus_on_click</parameter> :</term>
<listitem><simpara>if <literal>True</literal> the combo box grabs
focus when clicked with the mouse.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.6 and above.</para>
</note>
<para>The <methodname>set_focus_on_click</methodname>() method sets the
value of the "focus-on-click" property to the value of
<parameter>focus_on_click</parameter>. If
<parameter>focus_on_click</parameter> is <literal>True</literal> the combo
box grabs focus when clicked with the mouse.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--get-title">
<title>gtk.ComboBox.get_title</title>
<programlisting><methodsynopsis language="python">
<methodname>get_title</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the menu's title in tearoff
mode..</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>get_title</methodname>() method returns the
value of the "tearoff-title" property that contains the current title
of the menu in tearoff mode. See the <link
linkend="method-gtkcombobox--set-add-tearoffs"><methodname>set_add_tearoffs()</methodname></link>
method for more information.</para>
</refsect2>
<refsect2 id="method-gtkcombobox--set-title">
<title>gtk.ComboBox.set_title</title>
<programlisting><methodsynopsis language="python">
<methodname>set_title</methodname>
<methodparam><parameter role="keyword">title</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">title</parameter> :</term>
<listitem><simpara>a title for the menu in tearoff
mode.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.10 and above.</para>
</note>
<para>The <methodname>set_title</methodname>() method sets the
"tearoff-title" property to the value of
<parameter>title</parameter>. The "tearoff-title" property contains
the menu's title in tearoff mode.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gtk--combo-box-new-text">
<title>gtk.combo_box_new_text</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.combo_box_new_text</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A new <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link>
for text items.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.4 and above.</para>
</note>
<warning>
<para>This function is deprecated since PyGTK 2.24 and should not be used in newly-written code.
Use <link linkend="class-gtkcomboboxtext"><classname>gtk.ComboBoxText</classname></link>
instead.</para>
</warning>
<para>The <function>gtk.combo_box_new_text</function>() function is a
convenience function that constructs a new text combo box, which is a <link
linkend="class-gtkcombobox"><classname>gtk.ComboBox</classname></link> just
displaying strings. If you use this function to create a text combo box, you
should only manipulate its data source with the following convenience
methods: <link
linkend="method-gtkcombobox--append-text"><methodname>append_text</methodname>()</link>,
<link
linkend="method-gtkcombobox--insert-text"><methodname>insert_text</methodname>()</link>,
<link
linkend="method-gtkcombobox--prepend-text"><methodname>prepend_text</methodname>()</link>
and <link
linkend="method-gtkcombobox--remove-text"><methodname>remove_text</methodname>()</link>.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtkcombobox--changed">
<title>The "changed" gtk.ComboBox Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>combobox</parameter> :</term>
<listitem><simpara>the combo box that 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 PyGTK 2.4 and above.</para>
</note>
<para>The "changed" signal is emitted when a new item in the combo box
is selected.</para>
</refsect2>
<refsect2 id="signal-gtkcombobox--move-active">
<title>The "move-active" gtk.ComboBox Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>scroll_type</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>combobox</parameter> :</term>
<listitem><simpara>the combo box that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>scroll_type</parameter> :</term>
<listitem><simpara>a
<xref linkend="gtk-scroll-type-constants" endterm="gtk-scroll-type-constants-title">GtkScrollType</xref>
</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 PyGTK 2.12 and above.</para>
</note>
<para>The "move-active" signal is a keybinding signal which gets emitted to move the active selection.</para>
</refsect2>
<refsect2 id="signal-gtkcombobox--popdown">
<title>The "popdown" gtk.ComboBox Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>combobox</parameter> :</term>
<listitem><simpara>the combo box that 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 PyGTK 2.12 and above.</para>
</note>
<para>The "popdown" signal is a keybinding signal which gets emitted to popdown
the combo box list. The default bindings for this signal are Alt+Up and Escape.</para>
</refsect2>
<refsect2 id="signal-gtkcombobox--popup">
<title>The "popup" gtk.ComboBox Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>combobox</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>combobox</parameter> :</term>
<listitem><simpara>the combo box that 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 PyGTK 2.12 and above.</para>
</note>
<para>The "popup" signal is a keybinding signal which gets emitted to popup
the combo box list. The default bindings for this signal are Alt+Down.</para>
</refsect2>
</refsect1>
</refentry>
|