/usr/include/d/gtkd-3/gtk/FileChooserT.d is in libgtkd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module gtk.FileChooserT;
public import gio.FileIF;
public import glib.ErrorG;
public import glib.GException;
public import glib.ListSG;
public import glib.Str;
public import gobject.ObjectG;
public import gobject.Signals;
public import gtk.FileFilter;
public import gtk.Widget;
public import gtk.c.functions;
public import gtk.c.types;
public import gtkc.gtktypes;
public import std.algorithm;
/**
* #GtkFileChooser is an interface that can be implemented by file
* selection widgets. In GTK+, the main objects that implement this
* interface are #GtkFileChooserWidget, #GtkFileChooserDialog, and
* #GtkFileChooserButton. You do not need to write an object that
* implements the #GtkFileChooser interface unless you are trying to
* adapt an existing file selector to expose a standard programming
* interface.
*
* #GtkFileChooser allows for shortcuts to various places in the filesystem.
* In the default implementation these are displayed in the left pane. It
* may be a bit confusing at first that these shortcuts come from various
* sources and in various flavours, so lets explain the terminology here:
*
* - Bookmarks: are created by the user, by dragging folders from the
* right pane to the left pane, or by using the “Add”. Bookmarks
* can be renamed and deleted by the user.
*
* - Shortcuts: can be provided by the application. For example, a Paint
* program may want to add a shortcut for a Clipart folder. Shortcuts
* cannot be modified by the user.
*
* - Volumes: are provided by the underlying filesystem abstraction. They are
* the “roots” of the filesystem.
*
* # File Names and Encodings
*
* When the user is finished selecting files in a
* #GtkFileChooser, your program can get the selected names
* either as filenames or as URIs. For URIs, the normal escaping
* rules are applied if the URI contains non-ASCII characters.
* However, filenames are always returned in
* the character set specified by the
* `G_FILENAME_ENCODING` environment variable.
* Please see the GLib documentation for more details about this
* variable.
*
* This means that while you can pass the result of
* gtk_file_chooser_get_filename() to open() or fopen(),
* you may not be able to directly set it as the text of a
* #GtkLabel widget unless you convert it first to UTF-8,
* which all GTK+ widgets expect. You should use g_filename_to_utf8()
* to convert filenames into strings that can be passed to GTK+
* widgets.
*
* # Adding a Preview Widget
*
* You can add a custom preview widget to a file chooser and then
* get notification about when the preview needs to be updated.
* To install a preview widget, use
* gtk_file_chooser_set_preview_widget(). Then, connect to the
* #GtkFileChooser::update-preview signal to get notified when
* you need to update the contents of the preview.
*
* Your callback should use
* gtk_file_chooser_get_preview_filename() to see what needs
* previewing. Once you have generated the preview for the
* corresponding file, you must call
* gtk_file_chooser_set_preview_widget_active() with a boolean
* flag that indicates whether your callback could successfully
* generate a preview.
*
* ## Example: Using a Preview Widget ## {#gtkfilechooser-preview}
* |[<!-- language="C" -->
* {
* GtkImage *preview;
*
* ...
*
* preview = gtk_image_new ();
*
* gtk_file_chooser_set_preview_widget (my_file_chooser, preview);
* g_signal_connect (my_file_chooser, "update-preview",
* G_CALLBACK (update_preview_cb), preview);
* }
*
* static void
* update_preview_cb (GtkFileChooser *file_chooser, gpointer data)
* {
* GtkWidget *preview;
* char *filename;
* GdkPixbuf *pixbuf;
* gboolean have_preview;
*
* preview = GTK_WIDGET (data);
* filename = gtk_file_chooser_get_preview_filename (file_chooser);
*
* pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL);
* have_preview = (pixbuf != NULL);
* g_free (filename);
*
* gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf);
* if (pixbuf)
* g_object_unref (pixbuf);
*
* gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview);
* }
* ]|
*
* # Adding Extra Widgets
*
* You can add extra widgets to a file chooser to provide options
* that are not present in the default design. For example, you
* can add a toggle button to give the user the option to open a
* file in read-only mode. You can use
* gtk_file_chooser_set_extra_widget() to insert additional
* widgets in a file chooser.
*
* An example for adding extra widgets:
* |[<!-- language="C" -->
*
* GtkWidget *toggle;
*
* ...
*
* toggle = gtk_check_button_new_with_label ("Open file read-only");
* gtk_widget_show (toggle);
* gtk_file_chooser_set_extra_widget (my_file_chooser, toggle);
* }
* ]|
*
* If you want to set more than one extra widget in the file
* chooser, you can a container such as a #GtkBox or a #GtkGrid
* and include your widgets in it. Then, set the container as
* the whole extra widget.
*/
public template FileChooserT(TStruct)
{
/** Get the main Gtk struct */
public GtkFileChooser* getFileChooserStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return cast(GtkFileChooser*)getStruct();
}
/**
* Adds a 'choice' to the file chooser. This is typically implemented
* as a combobox or, for boolean choices, as a checkbutton. You can select
* a value using gtk_file_chooser_set_choice() before the dialog is shown,
* and you can obtain the user-selected value in the ::response signal handler
* using gtk_file_chooser_get_choice().
*
* Compare gtk_file_chooser_set_extra_widget().
*
* Params:
* id = id for the added choice
* label = user-visible label for the added choice
* options = ids for the options of the choice, or %NULL for a boolean choice
* optionLabels = user-visible labels for the options, must be the same length as @options
*
* Since: 3.22
*/
public void addChoice(string id, string label, string[] options, string[] optionLabels)
{
gtk_file_chooser_add_choice(getFileChooserStruct(), Str.toStringz(id), Str.toStringz(label), Str.toStringzArray(options), Str.toStringzArray(optionLabels));
}
/**
* Adds @filter to the list of filters that the user can select between.
* When a filter is selected, only files that are passed by that
* filter are displayed.
*
* Note that the @chooser takes ownership of the filter, so you have to
* ref and sink it if you want to keep a reference.
*
* Params:
* filter = a #GtkFileFilter
*
* Since: 2.4
*/
public void addFilter(FileFilter filter)
{
gtk_file_chooser_add_filter(getFileChooserStruct(), (filter is null) ? null : filter.getFileFilterStruct());
}
/**
* Adds a folder to be displayed with the shortcut folders in a file chooser.
* Note that shortcut folders do not get saved, as they are provided by the
* application. For example, you can use this to add a
* “/usr/share/mydrawprogram/Clipart” folder to the volume list.
*
* Params:
* folder = filename of the folder to add
*
* Returns: %TRUE if the folder could be added successfully, %FALSE
* otherwise. In the latter case, the @error will be set as appropriate.
*
* Since: 2.4
*
* Throws: GException on failure.
*/
public bool addShortcutFolder(string folder)
{
GError* err = null;
auto p = gtk_file_chooser_add_shortcut_folder(getFileChooserStruct(), Str.toStringz(folder), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Adds a folder URI to be displayed with the shortcut folders in a file
* chooser. Note that shortcut folders do not get saved, as they are provided
* by the application. For example, you can use this to add a
* “file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
*
* Params:
* uri = URI of the folder to add
*
* Returns: %TRUE if the folder could be added successfully, %FALSE
* otherwise. In the latter case, the @error will be set as appropriate.
*
* Since: 2.4
*
* Throws: GException on failure.
*/
public bool addShortcutFolderUri(string uri)
{
GError* err = null;
auto p = gtk_file_chooser_add_shortcut_folder_uri(getFileChooserStruct(), Str.toStringz(uri), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Gets the type of operation that the file chooser is performing; see
* gtk_file_chooser_set_action().
*
* Returns: the action that the file selector is performing
*
* Since: 2.4
*/
public GtkFileChooserAction getFileChooserAction()
{
return gtk_file_chooser_get_action(getFileChooserStruct());
}
/**
* Gets the currently selected option in the 'choice' with the given ID.
*
* Params:
* id = the ID of the choice to get
*
* Returns: the ID of the currenly selected option
*
* Since: 3.22
*/
public string getChoice(string id)
{
return Str.toString(gtk_file_chooser_get_choice(getFileChooserStruct(), Str.toStringz(id)));
}
/**
* Gets whether file choser will offer to create new folders.
* See gtk_file_chooser_set_create_folders().
*
* Returns: %TRUE if the Create Folder button should be displayed.
*
* Since: 2.18
*/
public bool getCreateFolders()
{
return gtk_file_chooser_get_create_folders(getFileChooserStruct()) != 0;
}
/**
* Gets the current folder of @chooser as a local filename.
* See gtk_file_chooser_set_current_folder().
*
* Note that this is the folder that the file chooser is currently displaying
* (e.g. "/home/username/Documents"), which is not the same
* as the currently-selected folder if the chooser is in
* %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER mode
* (e.g. "/home/username/Documents/selected-folder/". To get the
* currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection.
*
* Returns: the full path of the current
* folder, or %NULL if the current path cannot be represented as a local
* filename. Free with g_free(). This function will also return
* %NULL if the file chooser was unable to load the last folder that
* was requested from it; for example, as would be for calling
* gtk_file_chooser_set_current_folder() on a nonexistent folder.
*
* Since: 2.4
*/
public string getCurrentFolder()
{
auto retStr = gtk_file_chooser_get_current_folder(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the current folder of @chooser as #GFile.
* See gtk_file_chooser_get_current_folder_uri().
*
* Returns: the #GFile for the current folder.
*
* Since: 2.14
*/
public FileIF getCurrentFolderFile()
{
auto p = gtk_file_chooser_get_current_folder_file(getFileChooserStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(FileIF)(cast(GFile*) p, true);
}
/**
* Gets the current folder of @chooser as an URI.
* See gtk_file_chooser_set_current_folder_uri().
*
* Note that this is the folder that the file chooser is currently displaying
* (e.g. "file:///home/username/Documents"), which is not the same
* as the currently-selected folder if the chooser is in
* %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER mode
* (e.g. "file:///home/username/Documents/selected-folder/". To get the
* currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection.
*
* Returns: the URI for the current folder.
* Free with g_free(). This function will also return %NULL if the file chooser
* was unable to load the last folder that was requested from it; for example,
* as would be for calling gtk_file_chooser_set_current_folder_uri() on a
* nonexistent folder.
*
* Since: 2.4
*/
public string getCurrentFolderUri()
{
auto retStr = gtk_file_chooser_get_current_folder_uri(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the current name in the file selector, as entered by the user in the
* text entry for “Name”.
*
* This is meant to be used in save dialogs, to get the currently typed filename
* when the file itself does not exist yet. For example, an application that
* adds a custom extra widget to the file chooser for “file format” may want to
* change the extension of the typed filename based on the chosen format, say,
* from “.jpg” to “.png”.
*
* Returns: The raw text from the file chooser’s “Name” entry. Free this with
* g_free(). Note that this string is not a full pathname or URI; it is
* whatever the contents of the entry are. Note also that this string is in
* UTF-8 encoding, which is not necessarily the system’s encoding for filenames.
*
* Since: 3.10
*/
public string getCurrentName()
{
auto retStr = gtk_file_chooser_get_current_name(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Queries whether a file chooser is set to confirm for overwriting when the user
* types a file name that already exists.
*
* Returns: %TRUE if the file chooser will present a confirmation dialog;
* %FALSE otherwise.
*
* Since: 2.8
*/
public bool getDoOverwriteConfirmation()
{
return gtk_file_chooser_get_do_overwrite_confirmation(getFileChooserStruct()) != 0;
}
/**
* Gets the current extra widget; see
* gtk_file_chooser_set_extra_widget().
*
* Returns: the current extra widget, or %NULL
*
* Since: 2.4
*/
public Widget getExtraWidget()
{
auto p = gtk_file_chooser_get_extra_widget(getFileChooserStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
}
/**
* Gets the #GFile for the currently selected file in
* the file selector. If multiple files are selected,
* one of the files will be returned at random.
*
* If the file chooser is in folder mode, this function returns the selected
* folder.
*
* Returns: a selected #GFile. You own the returned file;
* use g_object_unref() to release it.
*
* Since: 2.14
*/
public FileIF getFile()
{
auto p = gtk_file_chooser_get_file(getFileChooserStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(FileIF)(cast(GFile*) p, true);
}
/**
* Gets the filename for the currently selected file in
* the file selector. The filename is returned as an absolute path. If
* multiple files are selected, one of the filenames will be returned at
* random.
*
* If the file chooser is in folder mode, this function returns the selected
* folder.
*
* Returns: The currently selected filename,
* or %NULL if no file is selected, or the selected file can't
* be represented with a local filename. Free with g_free().
*
* Since: 2.4
*/
public string getFilename()
{
auto retStr = gtk_file_chooser_get_filename(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Lists all the selected files and subfolders in the current folder of
* @chooser. The returned names are full absolute paths. If files in the current
* folder cannot be represented as local filenames they will be ignored. (See
* gtk_file_chooser_get_uris())
*
* Returns: a #GSList
* containing the filenames of all selected files and subfolders in
* the current folder. Free the returned list with g_slist_free(),
* and the filenames with g_free().
*
* Since: 2.4
*/
public ListSG getFilenames()
{
auto p = gtk_file_chooser_get_filenames(getFileChooserStruct());
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p, true);
}
/**
* Lists all the selected files and subfolders in the current folder of @chooser
* as #GFile. An internal function, see gtk_file_chooser_get_uris().
*
* Returns: a #GSList
* containing a #GFile for each selected file and subfolder in the
* current folder. Free the returned list with g_slist_free(), and
* the files with g_object_unref().
*
* Since: 2.14
*/
public ListSG getFiles()
{
auto p = gtk_file_chooser_get_files(getFileChooserStruct());
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p, true);
}
/**
* Gets the current filter; see gtk_file_chooser_set_filter().
*
* Returns: the current filter, or %NULL
*
* Since: 2.4
*/
public FileFilter getFilter()
{
auto p = gtk_file_chooser_get_filter(getFileChooserStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(FileFilter)(cast(GtkFileFilter*) p);
}
/**
* Gets whether only local files can be selected in the
* file selector. See gtk_file_chooser_set_local_only()
*
* Returns: %TRUE if only local files can be selected.
*
* Since: 2.4
*/
public bool getLocalOnly()
{
return gtk_file_chooser_get_local_only(getFileChooserStruct()) != 0;
}
/**
* Gets the #GFile that should be previewed in a custom preview
* Internal function, see gtk_file_chooser_get_preview_uri().
*
* Returns: the #GFile for the file to preview,
* or %NULL if no file is selected. Free with g_object_unref().
*
* Since: 2.14
*/
public FileIF getPreviewFile()
{
auto p = gtk_file_chooser_get_preview_file(getFileChooserStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(FileIF)(cast(GFile*) p, true);
}
/**
* Gets the filename that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget().
*
* Returns: the filename to preview, or %NULL if
* no file is selected, or if the selected file cannot be represented
* as a local filename. Free with g_free()
*
* Since: 2.4
*/
public string getPreviewFilename()
{
auto retStr = gtk_file_chooser_get_preview_filename(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the URI that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget().
*
* Returns: the URI for the file to preview,
* or %NULL if no file is selected. Free with g_free().
*
* Since: 2.4
*/
public string getPreviewUri()
{
auto retStr = gtk_file_chooser_get_preview_uri(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the current preview widget; see
* gtk_file_chooser_set_preview_widget().
*
* Returns: the current preview widget, or %NULL
*
* Since: 2.4
*/
public Widget getPreviewWidget()
{
auto p = gtk_file_chooser_get_preview_widget(getFileChooserStruct());
if(p is null)
{
return null;
}
return ObjectG.getDObject!(Widget)(cast(GtkWidget*) p);
}
/**
* Gets whether the preview widget set by gtk_file_chooser_set_preview_widget()
* should be shown for the current filename. See
* gtk_file_chooser_set_preview_widget_active().
*
* Returns: %TRUE if the preview widget is active for the current filename.
*
* Since: 2.4
*/
public bool getPreviewWidgetActive()
{
return gtk_file_chooser_get_preview_widget_active(getFileChooserStruct()) != 0;
}
/**
* Gets whether multiple files can be selected in the file
* selector. See gtk_file_chooser_set_select_multiple().
*
* Returns: %TRUE if multiple files can be selected.
*
* Since: 2.4
*/
public bool getSelectMultiple()
{
return gtk_file_chooser_get_select_multiple(getFileChooserStruct()) != 0;
}
/**
* Gets whether hidden files and folders are displayed in the file selector.
* See gtk_file_chooser_set_show_hidden().
*
* Returns: %TRUE if hidden files and folders are displayed.
*
* Since: 2.6
*/
public bool getShowHidden()
{
return gtk_file_chooser_get_show_hidden(getFileChooserStruct()) != 0;
}
/**
* Gets the URI for the currently selected file in
* the file selector. If multiple files are selected,
* one of the filenames will be returned at random.
*
* If the file chooser is in folder mode, this function returns the selected
* folder.
*
* Returns: The currently selected URI, or %NULL
* if no file is selected. If gtk_file_chooser_set_local_only() is set to
* %TRUE (the default) a local URI will be returned for any FUSE locations.
* Free with g_free()
*
* Since: 2.4
*/
public string getUri()
{
auto retStr = gtk_file_chooser_get_uri(getFileChooserStruct());
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Lists all the selected files and subfolders in the current folder of
* @chooser. The returned names are full absolute URIs.
*
* Returns: a #GSList containing the URIs of all selected
* files and subfolders in the current folder. Free the returned list
* with g_slist_free(), and the filenames with g_free().
*
* Since: 2.4
*/
public ListSG getUris()
{
auto p = gtk_file_chooser_get_uris(getFileChooserStruct());
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p, true);
}
/**
* Gets whether a stock label should be drawn with the name of the previewed
* file. See gtk_file_chooser_set_use_preview_label().
*
* Returns: %TRUE if the file chooser is set to display a label with the
* name of the previewed file, %FALSE otherwise.
*/
public bool getUsePreviewLabel()
{
return gtk_file_chooser_get_use_preview_label(getFileChooserStruct()) != 0;
}
/**
* Lists the current set of user-selectable filters; see
* gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
*
* Returns: a
* #GSList containing the current set of user selectable filters. The
* contents of the list are owned by GTK+, but you must free the list
* itself with g_slist_free() when you are done with it.
*
* Since: 2.4
*/
public ListSG listFilters()
{
auto p = gtk_file_chooser_list_filters(getFileChooserStruct());
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p);
}
/**
* Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder_uri().
*
* Returns: A list of
* folder URIs, or %NULL if there are no shortcut folders. Free the
* returned list with g_slist_free(), and the URIs with g_free().
*
* Since: 2.4
*/
public ListSG listShortcutFolderUris()
{
auto p = gtk_file_chooser_list_shortcut_folder_uris(getFileChooserStruct());
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p, true);
}
/**
* Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder().
*
* Returns: A list
* of folder filenames, or %NULL if there are no shortcut folders.
* Free the returned list with g_slist_free(), and the filenames with
* g_free().
*
* Since: 2.4
*/
public ListSG listShortcutFolders()
{
auto p = gtk_file_chooser_list_shortcut_folders(getFileChooserStruct());
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p, true);
}
/**
* Removes a 'choice' that has been added with gtk_file_chooser_add_choice().
*
* Params:
* id = the ID of the choice to remove
*
* Since: 3.22
*/
public void removeChoice(string id)
{
gtk_file_chooser_remove_choice(getFileChooserStruct(), Str.toStringz(id));
}
/**
* Removes @filter from the list of filters that the user can select between.
*
* Params:
* filter = a #GtkFileFilter
*
* Since: 2.4
*/
public void removeFilter(FileFilter filter)
{
gtk_file_chooser_remove_filter(getFileChooserStruct(), (filter is null) ? null : filter.getFileFilterStruct());
}
/**
* Removes a folder from a file chooser’s list of shortcut folders.
*
* Params:
* folder = filename of the folder to remove
*
* Returns: %TRUE if the operation succeeds, %FALSE otherwise.
* In the latter case, the @error will be set as appropriate.
*
* See also: gtk_file_chooser_add_shortcut_folder()
*
* Since: 2.4
*
* Throws: GException on failure.
*/
public bool removeShortcutFolder(string folder)
{
GError* err = null;
auto p = gtk_file_chooser_remove_shortcut_folder(getFileChooserStruct(), Str.toStringz(folder), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Removes a folder URI from a file chooser’s list of shortcut folders.
*
* Params:
* uri = URI of the folder to remove
*
* Returns: %TRUE if the operation succeeds, %FALSE otherwise.
* In the latter case, the @error will be set as appropriate.
*
* See also: gtk_file_chooser_add_shortcut_folder_uri()
*
* Since: 2.4
*
* Throws: GException on failure.
*/
public bool removeShortcutFolderUri(string uri)
{
GError* err = null;
auto p = gtk_file_chooser_remove_shortcut_folder_uri(getFileChooserStruct(), Str.toStringz(uri), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Selects all the files in the current folder of a file chooser.
*
* Since: 2.4
*/
public void selectAll()
{
gtk_file_chooser_select_all(getFileChooserStruct());
}
/**
* Selects the file referred to by @file. An internal function. See
* _gtk_file_chooser_select_uri().
*
* Params:
* file = the file to select
*
* Returns: Not useful.
*
* Since: 2.14
*
* Throws: GException on failure.
*/
public bool selectFile(FileIF file)
{
GError* err = null;
auto p = gtk_file_chooser_select_file(getFileChooserStruct(), (file is null) ? null : file.getFileStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Selects a filename. If the file name isn’t in the current
* folder of @chooser, then the current folder of @chooser will
* be changed to the folder containing @filename.
*
* Params:
* filename = the filename to select
*
* Returns: Not useful.
*
* See also: gtk_file_chooser_set_filename()
*
* Since: 2.4
*/
public bool selectFilename(string filename)
{
return gtk_file_chooser_select_filename(getFileChooserStruct(), Str.toStringz(filename)) != 0;
}
/**
* Selects the file to by @uri. If the URI doesn’t refer to a
* file in the current folder of @chooser, then the current folder of
* @chooser will be changed to the folder containing @filename.
*
* Params:
* uri = the URI to select
*
* Returns: Not useful.
*
* Since: 2.4
*/
public bool selectUri(string uri)
{
return gtk_file_chooser_select_uri(getFileChooserStruct(), Str.toStringz(uri)) != 0;
}
/**
* Sets the type of operation that the chooser is performing; the
* user interface is adapted to suit the selected action. For example,
* an option to create a new folder might be shown if the action is
* %GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is
* %GTK_FILE_CHOOSER_ACTION_OPEN.
*
* Params:
* action = the action that the file selector is performing
*
* Since: 2.4
*/
public void setFileChooserAction(GtkFileChooserAction action)
{
gtk_file_chooser_set_action(getFileChooserStruct(), action);
}
/**
* Selects an option in a 'choice' that has been added with
* gtk_file_chooser_add_choice(). For a boolean choice, the
* possible options are "true" and "false".
*
* Params:
* id = the ID of the choice to set
* option = the ID of the option to select
*
* Since: 3.22
*/
public void setChoice(string id, string option)
{
gtk_file_chooser_set_choice(getFileChooserStruct(), Str.toStringz(id), Str.toStringz(option));
}
/**
* Sets whether file choser will offer to create new folders.
* This is only relevant if the action is not set to be
* %GTK_FILE_CHOOSER_ACTION_OPEN.
*
* Params:
* createFolders = %TRUE if the Create Folder button should be displayed
*
* Since: 2.18
*/
public void setCreateFolders(bool createFolders)
{
gtk_file_chooser_set_create_folders(getFileChooserStruct(), createFolders);
}
/**
* Sets the current folder for @chooser from a local filename.
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
* In general, you should not use this function. See the
* [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
* for the rationale behind this.
*
* Params:
* filename = the full path of the new current folder
*
* Returns: Not useful.
*
* Since: 2.4
*/
public bool setCurrentFolder(string filename)
{
return gtk_file_chooser_set_current_folder(getFileChooserStruct(), Str.toStringz(filename)) != 0;
}
/**
* Sets the current folder for @chooser from a #GFile.
* Internal function, see gtk_file_chooser_set_current_folder_uri().
*
* Params:
* file = the #GFile for the new folder
*
* Returns: %TRUE if the folder could be changed successfully, %FALSE
* otherwise.
*
* Since: 2.14
*
* Throws: GException on failure.
*/
public bool setCurrentFolderFile(FileIF file)
{
GError* err = null;
auto p = gtk_file_chooser_set_current_folder_file(getFileChooserStruct(), (file is null) ? null : file.getFileStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Sets the current folder for @chooser from an URI.
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
* In general, you should not use this function. See the
* [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
* for the rationale behind this.
*
* Params:
* uri = the URI for the new current folder
*
* Returns: %TRUE if the folder could be changed successfully, %FALSE
* otherwise.
*
* Since: 2.4
*/
public bool setCurrentFolderUri(string uri)
{
return gtk_file_chooser_set_current_folder_uri(getFileChooserStruct(), Str.toStringz(uri)) != 0;
}
/**
* Sets the current name in the file selector, as if entered
* by the user. Note that the name passed in here is a UTF-8
* string rather than a filename. This function is meant for
* such uses as a suggested name in a “Save As...” dialog. You can
* pass “Untitled.doc” or a similarly suitable suggestion for the @name.
*
* If you want to preselect a particular existing file, you should use
* gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead.
* Please see the documentation for those functions for an example of using
* gtk_file_chooser_set_current_name() as well.
*
* Params:
* name = the filename to use, as a UTF-8 string
*
* Since: 2.4
*/
public void setCurrentName(string name)
{
gtk_file_chooser_set_current_name(getFileChooserStruct(), Str.toStringz(name));
}
/**
* Sets whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present
* a confirmation dialog if the user types a file name that already exists. This
* is %FALSE by default.
*
* If set to %TRUE, the @chooser will emit the
* #GtkFileChooser::confirm-overwrite signal when appropriate.
*
* If all you need is the stock confirmation dialog, set this property to %TRUE.
* You can override the way confirmation is done by actually handling the
* #GtkFileChooser::confirm-overwrite signal; please refer to its documentation
* for the details.
*
* Params:
* doOverwriteConfirmation = whether to confirm overwriting in save mode
*
* Since: 2.8
*/
public void setDoOverwriteConfirmation(bool doOverwriteConfirmation)
{
gtk_file_chooser_set_do_overwrite_confirmation(getFileChooserStruct(), doOverwriteConfirmation);
}
/**
* Sets an application-supplied widget to provide extra options to the user.
*
* Params:
* extraWidget = widget for extra options
*
* Since: 2.4
*/
public void setExtraWidget(Widget extraWidget)
{
gtk_file_chooser_set_extra_widget(getFileChooserStruct(), (extraWidget is null) ? null : extraWidget.getWidgetStruct());
}
/**
* Sets @file as the current filename for the file chooser, by changing
* to the file’s parent folder and actually selecting the file in list. If
* the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name
* will also appear in the dialog’s file name entry.
*
* If the file name isn’t in the current folder of @chooser, then the current
* folder of @chooser will be changed to the folder containing @filename. This
* is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
* gtk_file_chooser_select_filename().
*
* Note that the file must exist, or nothing will be done except
* for the directory change.
*
* If you are implementing a save dialog,
* you should use this function if you already have a file name to which the
* user may save; for example, when the user opens an existing file and then
* does Save As... If you don’t have
* a file name already — for example, if the user just created a new
* file and is saving it for the first time, do not call this function.
* Instead, use something similar to this:
* |[<!-- language="C" -->
* if (document_is_new)
* {
* // the user just created a new document
* gtk_file_chooser_set_current_folder_file (chooser, default_file_for_saving);
* gtk_file_chooser_set_current_name (chooser, "Untitled document");
* }
* else
* {
* // the user edited an existing document
* gtk_file_chooser_set_file (chooser, existing_file);
* }
* ]|
*
* Params:
* file = the #GFile to set as current
*
* Returns: Not useful.
*
* Since: 2.14
*
* Throws: GException on failure.
*/
public bool setFile(FileIF file)
{
GError* err = null;
auto p = gtk_file_chooser_set_file(getFileChooserStruct(), (file is null) ? null : file.getFileStruct(), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Sets @filename as the current filename for the file chooser, by changing to
* the file’s parent folder and actually selecting the file in list; all other
* files will be unselected. If the @chooser is in
* %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in
* the dialog’s file name entry.
*
* Note that the file must exist, or nothing will be done except
* for the directory change.
*
* You should use this function only when implementing a save
* dialog for which you already have a file name to which
* the user may save. For example, when the user opens an existing file and
* then does Save As... to save a copy or
* a modified version. If you don’t have a file name already — for
* example, if the user just created a new file and is saving it for the first
* time, do not call this function. Instead, use something similar to this:
* |[<!-- language="C" -->
* if (document_is_new)
* {
* // the user just created a new document
* gtk_file_chooser_set_current_name (chooser, "Untitled document");
* }
* else
* {
* // the user edited an existing document
* gtk_file_chooser_set_filename (chooser, existing_filename);
* }
* ]|
*
* In the first case, the file chooser will present the user with useful suggestions
* as to where to save his new file. In the second case, the file’s existing location
* is already known, so the file chooser will use it.
*
* Params:
* filename = the filename to set as current
*
* Returns: Not useful.
*
* Since: 2.4
*/
public bool setFilename(string filename)
{
return gtk_file_chooser_set_filename(getFileChooserStruct(), Str.toStringz(filename)) != 0;
}
/**
* Sets the current filter; only the files that pass the
* filter will be displayed. If the user-selectable list of filters
* is non-empty, then the filter should be one of the filters
* in that list. Setting the current filter when the list of
* filters is empty is useful if you want to restrict the displayed
* set of files without letting the user change it.
*
* Params:
* filter = a #GtkFileFilter
*
* Since: 2.4
*/
public void setFilter(FileFilter filter)
{
gtk_file_chooser_set_filter(getFileChooserStruct(), (filter is null) ? null : filter.getFileFilterStruct());
}
/**
* Sets whether only local files can be selected in the
* file selector. If @local_only is %TRUE (the default),
* then the selected file or files are guaranteed to be
* accessible through the operating systems native file
* system and therefore the application only
* needs to worry about the filename functions in
* #GtkFileChooser, like gtk_file_chooser_get_filename(),
* rather than the URI functions like
* gtk_file_chooser_get_uri(),
*
* On some systems non-native files may still be
* available using the native filesystem via a userspace
* filesystem (FUSE).
*
* Params:
* localOnly = %TRUE if only local files can be selected
*
* Since: 2.4
*/
public void setLocalOnly(bool localOnly)
{
gtk_file_chooser_set_local_only(getFileChooserStruct(), localOnly);
}
/**
* Sets an application-supplied widget to use to display a custom preview
* of the currently selected file. To implement a preview, after setting the
* preview widget, you connect to the #GtkFileChooser::update-preview
* signal, and call gtk_file_chooser_get_preview_filename() or
* gtk_file_chooser_get_preview_uri() on each change. If you can
* display a preview of the new file, update your widget and
* set the preview active using gtk_file_chooser_set_preview_widget_active().
* Otherwise, set the preview inactive.
*
* When there is no application-supplied preview widget, or the
* application-supplied preview widget is not active, the file chooser
* will display no preview at all.
*
* Params:
* previewWidget = widget for displaying preview.
*
* Since: 2.4
*/
public void setPreviewWidget(Widget previewWidget)
{
gtk_file_chooser_set_preview_widget(getFileChooserStruct(), (previewWidget is null) ? null : previewWidget.getWidgetStruct());
}
/**
* Sets whether the preview widget set by
* gtk_file_chooser_set_preview_widget() should be shown for the
* current filename. When @active is set to false, the file chooser
* may display an internally generated preview of the current file
* or it may display no preview at all. See
* gtk_file_chooser_set_preview_widget() for more details.
*
* Params:
* active = whether to display the user-specified preview widget
*
* Since: 2.4
*/
public void setPreviewWidgetActive(bool active)
{
gtk_file_chooser_set_preview_widget_active(getFileChooserStruct(), active);
}
/**
* Sets whether multiple files can be selected in the file selector. This is
* only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or
* %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
*
* Params:
* selectMultiple = %TRUE if multiple files can be selected.
*
* Since: 2.4
*/
public void setSelectMultiple(bool selectMultiple)
{
gtk_file_chooser_set_select_multiple(getFileChooserStruct(), selectMultiple);
}
/**
* Sets whether hidden files and folders are displayed in the file selector.
*
* Params:
* showHidden = %TRUE if hidden files and folders should be displayed.
*
* Since: 2.6
*/
public void setShowHidden(bool showHidden)
{
gtk_file_chooser_set_show_hidden(getFileChooserStruct(), showHidden);
}
/**
* Sets the file referred to by @uri as the current file for the file chooser,
* by changing to the URI’s parent folder and actually selecting the URI in the
* list. If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI’s base
* name will also appear in the dialog’s file name entry.
*
* Note that the URI must exist, or nothing will be done except for the
* directory change.
*
* You should use this function only when implementing a save
* dialog for which you already have a file name to which
* the user may save. For example, when the user opens an existing file and then
* does Save As... to save a copy or a
* modified version. If you don’t have a file name already — for example,
* if the user just created a new file and is saving it for the first time, do
* not call this function. Instead, use something similar to this:
* |[<!-- language="C" -->
* if (document_is_new)
* {
* // the user just created a new document
* gtk_file_chooser_set_current_name (chooser, "Untitled document");
* }
* else
* {
* // the user edited an existing document
* gtk_file_chooser_set_uri (chooser, existing_uri);
* }
* ]|
*
*
* In the first case, the file chooser will present the user with useful suggestions
* as to where to save his new file. In the second case, the file’s existing location
* is already known, so the file chooser will use it.
*
* Params:
* uri = the URI to set as current
*
* Returns: Not useful.
*
* Since: 2.4
*/
public bool setUri(string uri)
{
return gtk_file_chooser_set_uri(getFileChooserStruct(), Str.toStringz(uri)) != 0;
}
/**
* Sets whether the file chooser should display a stock label with the name of
* the file that is being previewed; the default is %TRUE. Applications that
* want to draw the whole preview area themselves should set this to %FALSE and
* display the name themselves in their preview widget.
*
* See also: gtk_file_chooser_set_preview_widget()
*
* Params:
* useLabel = whether to display a stock label with the name of the previewed file
*
* Since: 2.4
*/
public void setUsePreviewLabel(bool useLabel)
{
gtk_file_chooser_set_use_preview_label(getFileChooserStruct(), useLabel);
}
/**
* Unselects all the files in the current folder of a file chooser.
*
* Since: 2.4
*/
public void unselectAll()
{
gtk_file_chooser_unselect_all(getFileChooserStruct());
}
/**
* Unselects the file referred to by @file. If the file is not in the current
* directory, does not exist, or is otherwise not currently selected, does nothing.
*
* Params:
* file = a #GFile
*
* Since: 2.14
*/
public void unselectFile(FileIF file)
{
gtk_file_chooser_unselect_file(getFileChooserStruct(), (file is null) ? null : file.getFileStruct());
}
/**
* Unselects a currently selected filename. If the filename
* is not in the current directory, does not exist, or
* is otherwise not currently selected, does nothing.
*
* Params:
* filename = the filename to unselect
*
* Since: 2.4
*/
public void unselectFilename(string filename)
{
gtk_file_chooser_unselect_filename(getFileChooserStruct(), Str.toStringz(filename));
}
/**
* Unselects the file referred to by @uri. If the file
* is not in the current directory, does not exist, or
* is otherwise not currently selected, does nothing.
*
* Params:
* uri = the URI to unselect
*
* Since: 2.4
*/
public void unselectUri(string uri)
{
gtk_file_chooser_unselect_uri(getFileChooserStruct(), Str.toStringz(uri));
}
protected class OnConfirmOverwriteDelegateWrapper
{
GtkFileChooserConfirmation delegate(FileChooserIF) dlg;
gulong handlerId;
this(GtkFileChooserConfirmation delegate(FileChooserIF) dlg)
{
this.dlg = dlg;
onConfirmOverwriteListeners ~= this;
}
void remove(OnConfirmOverwriteDelegateWrapper source)
{
foreach(index, wrapper; onConfirmOverwriteListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onConfirmOverwriteListeners[index] = null;
onConfirmOverwriteListeners = std.algorithm.remove(onConfirmOverwriteListeners, index);
break;
}
}
}
}
OnConfirmOverwriteDelegateWrapper[] onConfirmOverwriteListeners;
/**
* This signal gets emitted whenever it is appropriate to present a
* confirmation dialog when the user has selected a file name that
* already exists. The signal only gets emitted when the file
* chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode.
*
* Most applications just need to turn on the
* #GtkFileChooser:do-overwrite-confirmation property (or call the
* gtk_file_chooser_set_do_overwrite_confirmation() function), and
* they will automatically get a stock confirmation dialog.
* Applications which need to customize this behavior should do
* that, and also connect to the #GtkFileChooser::confirm-overwrite
* signal.
*
* A signal handler for this signal must return a
* #GtkFileChooserConfirmation value, which indicates the action to
* take. If the handler determines that the user wants to select a
* different filename, it should return
* %GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN. If it determines
* that the user is satisfied with his choice of file name, it
* should return %GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME.
* On the other hand, if it determines that the stock confirmation
* dialog should be used, it should return
* %GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM. The following example
* illustrates this.
*
* ## Custom confirmation ## {#gtkfilechooser-confirmation}
*
* |[<!-- language="C" -->
* static GtkFileChooserConfirmation
* confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
* {
* char *uri;
*
* uri = gtk_file_chooser_get_uri (chooser);
*
* if (is_uri_read_only (uri))
* {
* if (user_wants_to_replace_read_only_file (uri))
* return GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME;
* else
* return GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN;
* } else
* return GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM; // fall back to the default dialog
* }
*
* ...
*
* chooser = gtk_file_chooser_dialog_new (...);
*
* gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE);
* g_signal_connect (chooser, "confirm-overwrite",
* G_CALLBACK (confirm_overwrite_callback), NULL);
*
* if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT)
* save_to_file (gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (chooser));
*
* gtk_widget_destroy (chooser);
* ]|
*
* Returns: a #GtkFileChooserConfirmation value that indicates which
* action to take after emitting the signal.
*
* Since: 2.8
*/
gulong addOnConfirmOverwrite(GtkFileChooserConfirmation delegate(FileChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnConfirmOverwriteDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"confirm-overwrite",
cast(GCallback)&callBackConfirmOverwrite,
cast(void*)wrapper,
cast(GClosureNotify)&callBackConfirmOverwriteDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static GtkFileChooserConfirmation callBackConfirmOverwrite(GtkFileChooser* filechooserStruct, OnConfirmOverwriteDelegateWrapper wrapper)
{
return wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackConfirmOverwriteDestroy(OnConfirmOverwriteDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnCurrentFolderChangedDelegateWrapper
{
void delegate(FileChooserIF) dlg;
gulong handlerId;
this(void delegate(FileChooserIF) dlg)
{
this.dlg = dlg;
onCurrentFolderChangedListeners ~= this;
}
void remove(OnCurrentFolderChangedDelegateWrapper source)
{
foreach(index, wrapper; onCurrentFolderChangedListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onCurrentFolderChangedListeners[index] = null;
onCurrentFolderChangedListeners = std.algorithm.remove(onCurrentFolderChangedListeners, index);
break;
}
}
}
}
OnCurrentFolderChangedDelegateWrapper[] onCurrentFolderChangedListeners;
/**
* This signal is emitted when the current folder in a #GtkFileChooser
* changes. This can happen due to the user performing some action that
* changes folders, such as selecting a bookmark or visiting a folder on the
* file list. It can also happen as a result of calling a function to
* explicitly change the current folder in a file chooser.
*
* Normally you do not need to connect to this signal, unless you need to keep
* track of which folder a file chooser is showing.
*
* See also: gtk_file_chooser_set_current_folder(),
* gtk_file_chooser_get_current_folder(),
* gtk_file_chooser_set_current_folder_uri(),
* gtk_file_chooser_get_current_folder_uri().
*/
gulong addOnCurrentFolderChanged(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnCurrentFolderChangedDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"current-folder-changed",
cast(GCallback)&callBackCurrentFolderChanged,
cast(void*)wrapper,
cast(GClosureNotify)&callBackCurrentFolderChangedDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackCurrentFolderChanged(GtkFileChooser* filechooserStruct, OnCurrentFolderChangedDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackCurrentFolderChangedDestroy(OnCurrentFolderChangedDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnFileActivatedDelegateWrapper
{
void delegate(FileChooserIF) dlg;
gulong handlerId;
this(void delegate(FileChooserIF) dlg)
{
this.dlg = dlg;
onFileActivatedListeners ~= this;
}
void remove(OnFileActivatedDelegateWrapper source)
{
foreach(index, wrapper; onFileActivatedListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onFileActivatedListeners[index] = null;
onFileActivatedListeners = std.algorithm.remove(onFileActivatedListeners, index);
break;
}
}
}
}
OnFileActivatedDelegateWrapper[] onFileActivatedListeners;
/**
* This signal is emitted when the user "activates" a file in the file
* chooser. This can happen by double-clicking on a file in the file list, or
* by pressing `Enter`.
*
* Normally you do not need to connect to this signal. It is used internally
* by #GtkFileChooserDialog to know when to activate the default button in the
* dialog.
*
* See also: gtk_file_chooser_get_filename(),
* gtk_file_chooser_get_filenames(), gtk_file_chooser_get_uri(),
* gtk_file_chooser_get_uris().
*/
gulong addOnFileActivated(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnFileActivatedDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"file-activated",
cast(GCallback)&callBackFileActivated,
cast(void*)wrapper,
cast(GClosureNotify)&callBackFileActivatedDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackFileActivated(GtkFileChooser* filechooserStruct, OnFileActivatedDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackFileActivatedDestroy(OnFileActivatedDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnSelectionChangedDelegateWrapper
{
void delegate(FileChooserIF) dlg;
gulong handlerId;
this(void delegate(FileChooserIF) dlg)
{
this.dlg = dlg;
onSelectionChangedListeners ~= this;
}
void remove(OnSelectionChangedDelegateWrapper source)
{
foreach(index, wrapper; onSelectionChangedListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onSelectionChangedListeners[index] = null;
onSelectionChangedListeners = std.algorithm.remove(onSelectionChangedListeners, index);
break;
}
}
}
}
OnSelectionChangedDelegateWrapper[] onSelectionChangedListeners;
/**
* This signal is emitted when there is a change in the set of selected files
* in a #GtkFileChooser. This can happen when the user modifies the selection
* with the mouse or the keyboard, or when explicitly calling functions to
* change the selection.
*
* Normally you do not need to connect to this signal, as it is easier to wait
* for the file chooser to finish running, and then to get the list of
* selected files using the functions mentioned below.
*
* See also: gtk_file_chooser_select_filename(),
* gtk_file_chooser_unselect_filename(), gtk_file_chooser_get_filename(),
* gtk_file_chooser_get_filenames(), gtk_file_chooser_select_uri(),
* gtk_file_chooser_unselect_uri(), gtk_file_chooser_get_uri(),
* gtk_file_chooser_get_uris().
*/
gulong addOnSelectionChanged(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnSelectionChangedDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"selection-changed",
cast(GCallback)&callBackSelectionChanged,
cast(void*)wrapper,
cast(GClosureNotify)&callBackSelectionChangedDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackSelectionChanged(GtkFileChooser* filechooserStruct, OnSelectionChangedDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackSelectionChangedDestroy(OnSelectionChangedDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
protected class OnUpdatePreviewDelegateWrapper
{
void delegate(FileChooserIF) dlg;
gulong handlerId;
this(void delegate(FileChooserIF) dlg)
{
this.dlg = dlg;
onUpdatePreviewListeners ~= this;
}
void remove(OnUpdatePreviewDelegateWrapper source)
{
foreach(index, wrapper; onUpdatePreviewListeners)
{
if (wrapper.handlerId == source.handlerId)
{
onUpdatePreviewListeners[index] = null;
onUpdatePreviewListeners = std.algorithm.remove(onUpdatePreviewListeners, index);
break;
}
}
}
}
OnUpdatePreviewDelegateWrapper[] onUpdatePreviewListeners;
/**
* This signal is emitted when the preview in a file chooser should be
* regenerated. For example, this can happen when the currently selected file
* changes. You should use this signal if you want your file chooser to have
* a preview widget.
*
* Once you have installed a preview widget with
* gtk_file_chooser_set_preview_widget(), you should update it when this
* signal is emitted. You can use the functions
* gtk_file_chooser_get_preview_filename() or
* gtk_file_chooser_get_preview_uri() to get the name of the file to preview.
* Your widget may not be able to preview all kinds of files; your callback
* must call gtk_file_chooser_set_preview_widget_active() to inform the file
* chooser about whether the preview was generated successfully or not.
*
* Please see the example code in
* [Using a Preview Widget][gtkfilechooser-preview].
*
* See also: gtk_file_chooser_set_preview_widget(),
* gtk_file_chooser_set_preview_widget_active(),
* gtk_file_chooser_set_use_preview_label(),
* gtk_file_chooser_get_preview_filename(),
* gtk_file_chooser_get_preview_uri().
*/
gulong addOnUpdatePreview(void delegate(FileChooserIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
auto wrapper = new OnUpdatePreviewDelegateWrapper(dlg);
wrapper.handlerId = Signals.connectData(
this,
"update-preview",
cast(GCallback)&callBackUpdatePreview,
cast(void*)wrapper,
cast(GClosureNotify)&callBackUpdatePreviewDestroy,
connectFlags);
return wrapper.handlerId;
}
extern(C) static void callBackUpdatePreview(GtkFileChooser* filechooserStruct, OnUpdatePreviewDelegateWrapper wrapper)
{
wrapper.dlg(wrapper.outer);
}
extern(C) static void callBackUpdatePreviewDestroy(OnUpdatePreviewDelegateWrapper wrapper, GClosure* closure)
{
wrapper.remove(wrapper);
}
}
|