/usr/include/giomm-2.4/giomm/file.h is in libglibmm-2.4-dev 2.56.0-1.
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 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 | // Generated by gmmproc 2.54.1 -- DO NOT MODIFY!
#ifndef _GIOMM_FILE_H
#define _GIOMM_FILE_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2007 The gtkmm Development Team
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <glibmm/error.h>
#include <glibmm/interface.h>
#include <giomm/appinfo.h>
#include <giomm/asyncresult.h>
#include <giomm/fileattributeinfolist.h>
#include <giomm/fileenumerator.h>
#include <giomm/fileinfo.h>
#include <giomm/fileinputstream.h>
#include <giomm/fileiostream.h>
#include <giomm/filemonitor.h>
#include <giomm/fileoutputstream.h>
#include <giomm/mountoperation.h>
#include <giomm/drive.h>
#include <giomm/error.h> //Because this is thrown by some of these methods.
//#include <giomm/volume.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GFileIface GFileIface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GFile = struct _GFile;
using GFileClass = struct _GFileClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gio
{ class File_Class; } // namespace Gio
#endif // DOXYGEN_SHOULD_SKIP_THIS
namespace Gio
{
class Mount;
class Volume;
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var FileQueryInfoFlags FILE_QUERY_INFO_NONE
* No flags set.
*
* @var FileQueryInfoFlags FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
* Don't follow symlinks.
*
* @enum FileQueryInfoFlags
*
* Flags used when querying a FileInfo.
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%FileQueryInfoFlags operator|(FileQueryInfoFlags, FileQueryInfoFlags)</tt><br>
* <tt>%FileQueryInfoFlags operator&(FileQueryInfoFlags, FileQueryInfoFlags)</tt><br>
* <tt>%FileQueryInfoFlags operator^(FileQueryInfoFlags, FileQueryInfoFlags)</tt><br>
* <tt>%FileQueryInfoFlags operator~(FileQueryInfoFlags)</tt><br>
* <tt>%FileQueryInfoFlags& operator|=(FileQueryInfoFlags&, FileQueryInfoFlags)</tt><br>
* <tt>%FileQueryInfoFlags& operator&=(FileQueryInfoFlags&, FileQueryInfoFlags)</tt><br>
* <tt>%FileQueryInfoFlags& operator^=(FileQueryInfoFlags&, FileQueryInfoFlags)</tt><br>
*/
enum FileQueryInfoFlags
{
FILE_QUERY_INFO_NONE = 0x0,
FILE_QUERY_INFO_NOFOLLOW_SYMLINKS = (1 << 0)
};
/** @ingroup giommEnums */
inline FileQueryInfoFlags operator|(FileQueryInfoFlags lhs, FileQueryInfoFlags rhs)
{ return static_cast<FileQueryInfoFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileQueryInfoFlags operator&(FileQueryInfoFlags lhs, FileQueryInfoFlags rhs)
{ return static_cast<FileQueryInfoFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileQueryInfoFlags operator^(FileQueryInfoFlags lhs, FileQueryInfoFlags rhs)
{ return static_cast<FileQueryInfoFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileQueryInfoFlags operator~(FileQueryInfoFlags flags)
{ return static_cast<FileQueryInfoFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline FileQueryInfoFlags& operator|=(FileQueryInfoFlags& lhs, FileQueryInfoFlags rhs)
{ return (lhs = static_cast<FileQueryInfoFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileQueryInfoFlags& operator&=(FileQueryInfoFlags& lhs, FileQueryInfoFlags rhs)
{ return (lhs = static_cast<FileQueryInfoFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileQueryInfoFlags& operator^=(FileQueryInfoFlags& lhs, FileQueryInfoFlags rhs)
{ return (lhs = static_cast<FileQueryInfoFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @var FileCreateFlags FILE_CREATE_NONE
* No flags set.
*
* @var FileCreateFlags FILE_CREATE_PRIVATE
* Create a file that can only be
* accessed by the current user.
*
* @var FileCreateFlags FILE_CREATE_REPLACE_DESTINATION
* Replace the destination
* as if it didn't exist before. Don't try to keep any old
* permissions, replace instead of following links. This
* is generally useful if you're doing a "copy over"
* rather than a "save new version of" replace operation.
* You can think of it as "unlink destination" before
* writing to it, although the implementation may not
* be exactly like that. @newin{2,20}
*
* @enum FileCreateFlags
*
* Flags used when an operation may create a file.
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%FileCreateFlags operator|(FileCreateFlags, FileCreateFlags)</tt><br>
* <tt>%FileCreateFlags operator&(FileCreateFlags, FileCreateFlags)</tt><br>
* <tt>%FileCreateFlags operator^(FileCreateFlags, FileCreateFlags)</tt><br>
* <tt>%FileCreateFlags operator~(FileCreateFlags)</tt><br>
* <tt>%FileCreateFlags& operator|=(FileCreateFlags&, FileCreateFlags)</tt><br>
* <tt>%FileCreateFlags& operator&=(FileCreateFlags&, FileCreateFlags)</tt><br>
* <tt>%FileCreateFlags& operator^=(FileCreateFlags&, FileCreateFlags)</tt><br>
*/
enum FileCreateFlags
{
FILE_CREATE_NONE = 0x0,
FILE_CREATE_PRIVATE = (1 << 0),
FILE_CREATE_REPLACE_DESTINATION = (1 << 1)
};
/** @ingroup giommEnums */
inline FileCreateFlags operator|(FileCreateFlags lhs, FileCreateFlags rhs)
{ return static_cast<FileCreateFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileCreateFlags operator&(FileCreateFlags lhs, FileCreateFlags rhs)
{ return static_cast<FileCreateFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileCreateFlags operator^(FileCreateFlags lhs, FileCreateFlags rhs)
{ return static_cast<FileCreateFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileCreateFlags operator~(FileCreateFlags flags)
{ return static_cast<FileCreateFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline FileCreateFlags& operator|=(FileCreateFlags& lhs, FileCreateFlags rhs)
{ return (lhs = static_cast<FileCreateFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileCreateFlags& operator&=(FileCreateFlags& lhs, FileCreateFlags rhs)
{ return (lhs = static_cast<FileCreateFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileCreateFlags& operator^=(FileCreateFlags& lhs, FileCreateFlags rhs)
{ return (lhs = static_cast<FileCreateFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @var FileCopyFlags FILE_COPY_NONE
* No flags set.
*
* @var FileCopyFlags FILE_COPY_OVERWRITE
* Overwrite any existing files.
*
* @var FileCopyFlags FILE_COPY_BACKUP
* Make a backup of any existing files.
*
* @var FileCopyFlags FILE_COPY_NOFOLLOW_SYMLINKS
* Don't follow symlinks.
*
* @var FileCopyFlags FILE_COPY_ALL_METADATA
* Copy all file metadata instead of just default set used for copy (see FileInfo).
*
* @var FileCopyFlags FILE_COPY_NO_FALLBACK_FOR_MOVE
* Don't use copy and delete fallback if native move not supported.
*
* @var FileCopyFlags FILE_COPY_TARGET_DEFAULT_PERMS
* Leaves target file with default perms, instead of setting the source file perms.
*
* @enum FileCopyFlags
*
* Flags used when copying or moving files.
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%FileCopyFlags operator|(FileCopyFlags, FileCopyFlags)</tt><br>
* <tt>%FileCopyFlags operator&(FileCopyFlags, FileCopyFlags)</tt><br>
* <tt>%FileCopyFlags operator^(FileCopyFlags, FileCopyFlags)</tt><br>
* <tt>%FileCopyFlags operator~(FileCopyFlags)</tt><br>
* <tt>%FileCopyFlags& operator|=(FileCopyFlags&, FileCopyFlags)</tt><br>
* <tt>%FileCopyFlags& operator&=(FileCopyFlags&, FileCopyFlags)</tt><br>
* <tt>%FileCopyFlags& operator^=(FileCopyFlags&, FileCopyFlags)</tt><br>
*/
enum FileCopyFlags
{
FILE_COPY_NONE = 0x0,
FILE_COPY_OVERWRITE = (1 << 0),
FILE_COPY_BACKUP = (1 << 1),
FILE_COPY_NOFOLLOW_SYMLINKS = (1 << 2),
FILE_COPY_ALL_METADATA = (1 << 3),
FILE_COPY_NO_FALLBACK_FOR_MOVE = (1 << 4),
FILE_COPY_TARGET_DEFAULT_PERMS = (1 << 5)
};
/** @ingroup giommEnums */
inline FileCopyFlags operator|(FileCopyFlags lhs, FileCopyFlags rhs)
{ return static_cast<FileCopyFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileCopyFlags operator&(FileCopyFlags lhs, FileCopyFlags rhs)
{ return static_cast<FileCopyFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileCopyFlags operator^(FileCopyFlags lhs, FileCopyFlags rhs)
{ return static_cast<FileCopyFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileCopyFlags operator~(FileCopyFlags flags)
{ return static_cast<FileCopyFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline FileCopyFlags& operator|=(FileCopyFlags& lhs, FileCopyFlags rhs)
{ return (lhs = static_cast<FileCopyFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileCopyFlags& operator&=(FileCopyFlags& lhs, FileCopyFlags rhs)
{ return (lhs = static_cast<FileCopyFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileCopyFlags& operator^=(FileCopyFlags& lhs, FileCopyFlags rhs)
{ return (lhs = static_cast<FileCopyFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @var FileMonitorFlags FILE_MONITOR_NONE
* No flags set.
*
* @var FileMonitorFlags FILE_MONITOR_WATCH_MOUNTS
* Watch for mount events.
*
* @var FileMonitorFlags FILE_MONITOR_SEND_MOVED
* Pair DELETED and CREATED events caused
* by file renames (moves) and send a single G_FILE_MONITOR_EVENT_MOVED
* event instead (NB: not supported on all backends; the default
* behaviour -without specifying this flag- is to send single DELETED
* and CREATED events). Deprecated since 2.46: use
* FILE_MONITOR_WATCH_MOVES instead.
*
* @var FileMonitorFlags FILE_MONITOR_WATCH_HARD_LINKS
* Watch for changes to the file made
* via another hard link. @newin{2,36}
*
* @var FileMonitorFlags FILE_MONITOR_WATCH_MOVES
* Watch for rename operations on a
* monitored directory. This causes FILE_MONITOR_EVENT_RENAMED,
* FILE_MONITOR_EVENT_MOVED_IN and FILE_MONITOR_EVENT_MOVED_OUT
* events to be emitted when possible. @newin{2,46}
*
* @enum FileMonitorFlags
*
* Flags used to set what a FileMonitor will watch for.
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%FileMonitorFlags operator|(FileMonitorFlags, FileMonitorFlags)</tt><br>
* <tt>%FileMonitorFlags operator&(FileMonitorFlags, FileMonitorFlags)</tt><br>
* <tt>%FileMonitorFlags operator^(FileMonitorFlags, FileMonitorFlags)</tt><br>
* <tt>%FileMonitorFlags operator~(FileMonitorFlags)</tt><br>
* <tt>%FileMonitorFlags& operator|=(FileMonitorFlags&, FileMonitorFlags)</tt><br>
* <tt>%FileMonitorFlags& operator&=(FileMonitorFlags&, FileMonitorFlags)</tt><br>
* <tt>%FileMonitorFlags& operator^=(FileMonitorFlags&, FileMonitorFlags)</tt><br>
*/
enum FileMonitorFlags
{
FILE_MONITOR_NONE = 0x0,
FILE_MONITOR_WATCH_MOUNTS = (1 << 0),
FILE_MONITOR_SEND_MOVED = (1 << 1),
FILE_MONITOR_WATCH_HARD_LINKS = (1 << 2),
FILE_MONITOR_WATCH_MOVES = (1 << 3)
};
/** @ingroup giommEnums */
inline FileMonitorFlags operator|(FileMonitorFlags lhs, FileMonitorFlags rhs)
{ return static_cast<FileMonitorFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileMonitorFlags operator&(FileMonitorFlags lhs, FileMonitorFlags rhs)
{ return static_cast<FileMonitorFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileMonitorFlags operator^(FileMonitorFlags lhs, FileMonitorFlags rhs)
{ return static_cast<FileMonitorFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileMonitorFlags operator~(FileMonitorFlags flags)
{ return static_cast<FileMonitorFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline FileMonitorFlags& operator|=(FileMonitorFlags& lhs, FileMonitorFlags rhs)
{ return (lhs = static_cast<FileMonitorFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileMonitorFlags& operator&=(FileMonitorFlags& lhs, FileMonitorFlags rhs)
{ return (lhs = static_cast<FileMonitorFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileMonitorFlags& operator^=(FileMonitorFlags& lhs, FileMonitorFlags rhs)
{ return (lhs = static_cast<FileMonitorFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/**
* @var FileMeasureFlags FILE_MEASURE_NONE
* No flags set.
*
* @var FileMeasureFlags FILE_MEASURE_REPORT_ANY_ERROR
* Report any error encountered
* while traversing the directory tree. Normally errors are only
* reported for the toplevel file.
*
* @var FileMeasureFlags FILE_MEASURE_APPARENT_SIZE
* Tally usage based on apparent file
* sizes. Normally, the block-size is used, if available, as this is a
* more accurate representation of disk space used.
* Compare with `du --apparent-size`.
*
* @var FileMeasureFlags FILE_MEASURE_NO_XDEV
* Do not cross mount point boundaries.
* Compare with `du -x`.
*
* @enum FileMeasureFlags
*
* Flags that can be used with g_file_measure_disk_usage().
*
* @newin{2,38}
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%FileMeasureFlags operator|(FileMeasureFlags, FileMeasureFlags)</tt><br>
* <tt>%FileMeasureFlags operator&(FileMeasureFlags, FileMeasureFlags)</tt><br>
* <tt>%FileMeasureFlags operator^(FileMeasureFlags, FileMeasureFlags)</tt><br>
* <tt>%FileMeasureFlags operator~(FileMeasureFlags)</tt><br>
* <tt>%FileMeasureFlags& operator|=(FileMeasureFlags&, FileMeasureFlags)</tt><br>
* <tt>%FileMeasureFlags& operator&=(FileMeasureFlags&, FileMeasureFlags)</tt><br>
* <tt>%FileMeasureFlags& operator^=(FileMeasureFlags&, FileMeasureFlags)</tt><br>
*/
enum FileMeasureFlags
{
FILE_MEASURE_NONE = 0x0,
FILE_MEASURE_REPORT_ANY_ERROR = (1 << 1),
FILE_MEASURE_APPARENT_SIZE = (1 << 2),
FILE_MEASURE_NO_XDEV = (1 << 3)
};
/** @ingroup giommEnums */
inline FileMeasureFlags operator|(FileMeasureFlags lhs, FileMeasureFlags rhs)
{ return static_cast<FileMeasureFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileMeasureFlags operator&(FileMeasureFlags lhs, FileMeasureFlags rhs)
{ return static_cast<FileMeasureFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileMeasureFlags operator^(FileMeasureFlags lhs, FileMeasureFlags rhs)
{ return static_cast<FileMeasureFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline FileMeasureFlags operator~(FileMeasureFlags flags)
{ return static_cast<FileMeasureFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline FileMeasureFlags& operator|=(FileMeasureFlags& lhs, FileMeasureFlags rhs)
{ return (lhs = static_cast<FileMeasureFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileMeasureFlags& operator&=(FileMeasureFlags& lhs, FileMeasureFlags rhs)
{ return (lhs = static_cast<FileMeasureFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline FileMeasureFlags& operator^=(FileMeasureFlags& lhs, FileMeasureFlags rhs)
{ return (lhs = static_cast<FileMeasureFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
/** File and directory handling.
* Gio::File is a high level abstraction for manipulating files on a virtual file system. Gio::Files are lightweight, immutable objects that do no
* I/O upon creation. It is necessary to understand that a Gio::File object does not represent a file, merely a handle to a file. All file I/O is
* implemented as streaming operations (see Gio::InputStream and Gio::OutputStream).
*
* A GioFile can be constructed from a path, URI, or a command line argument.
*
* You can move through the filesystem with Gio::File handles with get_parent() to get a handle to the parent directory,
* get_child() to get a handle to a child within a directory, and resolve_relative_path() to resolve a relative path between two Gio::Files.
*
* Many Gio::File operations have both synchronous and asynchronous versions to suit your application. Asynchronous versions of synchronous
* functions simply have _async() appended to their function names. The asynchronous I/O functions call a SlotAsyncReady callback slot which is
* then used to finalize the operation, producing a AsyncResult which is then passed to the function's matching _finish() operation.
*
* Some Gio::File operations do not have synchronous analogs, as they may take a very long time to finish, and blocking may leave an application
* unusable. Notable cases include: mount_mountable() to mount a mountable file, unmount_mountable() to unmount a mountable file,
* and eject_mountable() to eject a mountable file.
*
* One notable feature of Gio::Files are entity tags, or "etags" for short. Entity tags are somewhat like a more abstract version of the
* traditional mtime, and can be used to quickly determine if the file has been modified from the version on the file system.
* See the HTTP 1.1 specification for HTTP Etag headers, which are a very similar concept.
*
* @newin{2,16}
*/
class File : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = File;
using CppClassType = File_Class;
using BaseObjectType = GFile;
using BaseClassType = GFileIface;
// noncopyable
File(const File&) = delete;
File& operator=(const File&) = delete;
private:
friend class File_Class;
static CppClassType file_class_;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
/**
* You should derive from this class to use it.
*/
File();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Called by constructors of derived classes. Provide the result of
* the Class init() function to ensure that it is properly
* initialized.
*
* @param interface_class The Class object for the derived type.
*/
explicit File(const Glib::Interface_Class& interface_class);
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit File(GFile* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
File(File&& src) noexcept;
File& operator=(File&& src) noexcept;
~File() noexcept override;
static void add_interface(GType gtype_implementer);
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GFile* gobj() { return reinterpret_cast<GFile*>(gobject_); }
///Provides access to the underlying C GObject.
const GFile* gobj() const { return reinterpret_cast<GFile*>(gobject_); }
private:
public:
//g_file_icon_new is not a GFile method.
// Although this is an interface, it is possible to create objects using
// its static create* members. In the implementation, these would lead
// to functions of the default GVfs implementation, which, in case of
// this class' create methods, would rely on concrete GFile implementations
// such as GLocalFile and GDummyFile.
/** Constructs a File for a given path.
* This operation never fails, but the returned object might not support any I/O operation if path is malformed.
*
* @param path A string containing a relative or absolute path.
* @result A new instantiation of an appropriate Gio::File class.
*/
static Glib::RefPtr<File> create_for_path(const std::string& path);
/** Constructs a File for a given URI.
* This operation never fails, but the returned object might not support any I/O operation if path is malformed.
*
* @param uri A string containing a URI.
* @result A new instantiation of an appropriate Gio::File class.
*/
static Glib::RefPtr<File> create_for_uri(const std::string& uri);
/** Constructs a File for a given argument from the command line.
* The value of @a arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory.
* This operation never fails, but the returned object might not support any I/O operation if arg points to a malformed path.
*
* @param arg A string containing a relative or absolute path.
* @result A new instantiation of an appropriate Gio::File class.
*/
static Glib::RefPtr<File> create_for_commandline_arg(const std::string& arg);
// parse_name is a UTF8-guaranteed "nice" string that can both
// be resolved to a GFile (via create_for_parse_name) and put in
// e.g. a GtkEntry. In practice, it is either a UTF8-only absolute
// filename (if it starts with a /), or an IRI (i.e. a URI that allows
// UTF8-encoded unicode chars instead of escaping them).
static Glib::RefPtr<File> create_for_parse_name(const Glib::ustring& parse_name);
/** Duplicates a File handle. This operation does not duplicate
* the actual file or directory represented by the File; see
* g_file_copy() if attempting to copy a file.
*
* This call does no blocking I/O.
*
* @return A new File that is a duplicate
* of the given File.
*/
Glib::RefPtr<File> dup() const;
// The method intended to be used for making hash tables
// (g_hash_table_new in C).
/** Creates a hash value for a File.
*
* This call does no blocking I/O.
*
* Virtual: hash
*
* @return 0 if @a file is not a valid File, otherwise an
* integer that can be used as hash value for the File.
* This function is intended for easily hashing a File to
* add to a HashTable or similar data structure.
*/
guint hash() const;
//Note that the implementation of equal() is already virtual via equal_vfunc().
/** Checks equality of two given Files.
*
* Note that two Files that differ can still refer to the same
* file on the filesystem due to various forms of filename
* aliasing.
*
* This call does no blocking I/O.
* @param other The other File.
* @return <tt>true</tt> if @a *this and @a other are equal.
* <tt>false</tt> if either is not a File.
*/
bool equal(const Glib::RefPtr<const File>& other) const;
/** Gets the base name (the last component of the path) for a given File.
*
* If called for the top level of a system (such as the filesystem root
* or a uri like sftp://host/) it will return a single directory separator
* (and on Windows, possibly a drive letter).
*
* The base name is a byte string (not UTF-8). It has no defined encoding
* or rules other than it may not contain zero bytes. If you want to use
* filenames in a user interface you should use the display name that you
* can get by requesting the G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
* attribute with g_file_query_info().
*
* This call does no blocking I/O.
*
* @return String containing the File's
* base name, or <tt>nullptr</tt> if given File is invalid.
*/
std::string get_basename() const;
/** Gets the local pathname for File, if one exists. If non-<tt>nullptr</tt>, this is
* guaranteed to be an absolute, canonical path. It might contain symlinks.
*
* This call does no blocking I/O.
*
* @return String containing the File's path,
* or <tt>nullptr</tt> if no such path exists.
*/
std::string get_path() const;
/** Gets the URI for the @a file.
*
* This call does no blocking I/O.
*
* @return A string containing the File's URI.
*/
std::string get_uri() const;
/** Gets the parse name of the @a file.
* A parse name is a UTF-8 string that describes the
* file such that one can get the File back using
* g_file_parse_name().
*
* This is generally used to show the File as a nice
* full-pathname kind of string in a user interface,
* like in a location entry.
*
* For local files with names that can safely be converted
* to UTF-8 the pathname is used, otherwise the IRI is used
* (a form of URI that allows UTF-8 characters unescaped).
*
* This call does no blocking I/O.
*
* @return A string containing the File's parse name.
*/
Glib::ustring get_parse_name() const;
//Note that these return a reference (usually new instances),
//so we don't need to use refreturn.
//TODO: Do we need const and unconst versions of these get_*() methods,
//or do we consider that the returned File cannot be used to change "this".
//murrayc.
/** Gets the parent directory for the @a file.
* If the @a file represents the root directory of the
* file system, then <tt>nullptr</tt> will be returned.
*
* This call does no blocking I/O.
*
* @return A File structure to the
* parent of the given File or <tt>nullptr</tt> if there is no parent. Free
* the returned object with Glib::object_unref().
*/
Glib::RefPtr<File> get_parent() const;
/** Checks if @a file has a parent, and optionally, if it is @a parent.
*
* If @a parent is <tt>nullptr</tt> then this function returns <tt>true</tt> if @a file has any
* parent at all. If @a parent is non-<tt>nullptr</tt> then <tt>true</tt> is only returned
* if @a file is an immediate child of @a parent.
*
* @newin{2,24}
*
* @param parent The parent to check for, or <tt>nullptr</tt>.
* @return <tt>true</tt> if @a file is an immediate child of @a parent (or any parent in
* the case that @a parent is <tt>nullptr</tt>).
*/
bool has_parent(const Glib::RefPtr<File>& parent) const;
/** Checks if the file has any parent at all.
* @result true if the file is a child of any parent.
*
* @newin{2,24}
*/
bool has_parent() const;
/** Gets a child of @a file with basename equal to @a name.
*
* Note that the file with that specific name might not exist, but
* you can still have a File that points to it. You can use this
* for instance to create that file.
*
* This call does no blocking I/O.
*
* @param name String containing the child's basename.
* @return A File to a child specified by @a name.
* Free the returned object with Glib::object_unref().
*/
Glib::RefPtr<File> get_child(const std::string& name) const;
/** Gets the child of @a file for a given @a display_name (i.e.\ a UTF-8
* version of the name). If this function fails, it returns <tt>nullptr</tt>
* and @a error will be set. This is very useful when constructing a
* File for a new file and the user entered the filename in the
* user interface, for instance when you select a directory and
* type a filename in the file selector.
*
* This call does no blocking I/O.
*
* @param display_name String to a possible child.
* @return A File to the specified child, or
* <tt>nullptr</tt> if the display name couldn't be converted.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<File> get_child_for_display_name(const Glib::ustring& display_name) const;
/** Checks whether @a file has the prefix specified by @a prefix.
*
* In other words, if the names of initial elements of @a file's
* pathname match @a prefix. Only full pathname elements are matched,
* so a path like /foo is not considered a prefix of /foobar, only
* of /foo/bar.
*
* A File is not a prefix of itself. If you want to check for
* equality, use g_file_equal().
*
* This call does no I/O, as it works purely on names. As such it can
* sometimes return <tt>false</tt> even if @a file is inside a @a prefix (from a
* filesystem point of view), because the prefix of @a file is an alias
* of @a prefix.
*
* Virtual: prefix_matches
*
* @param prefix Input File.
* @return <tt>true</tt> if the @a files's parent, grandparent, etc is @a prefix,
* <tt>false</tt> otherwise.
*/
bool has_prefix(const Glib::RefPtr<const File>& prefix) const;
/** Gets the path for @a descendant relative to @a parent.
*
* This call does no blocking I/O.
*
* @param descendant Input File.
* @return String with the relative path from
* @a descendant to @a parent, or <tt>nullptr</tt> if @a descendant doesn't have @a parent as
* prefix.
*/
std::string get_relative_path(const Glib::RefPtr<const File>& descendant) const;
/** Resolves a relative path for @a file to an absolute path.
*
* This call does no blocking I/O.
*
* @param relative_path A given relative path string.
* @return File to the resolved path.
* <tt>nullptr</tt> if @a relative_path is <tt>nullptr</tt> or if @a file is invalid.
* Free the returned object with Glib::object_unref().
*/
Glib::RefPtr<File> resolve_relative_path(const std::string& relative_path) const;
/** Checks to see if a file is native to the platform.
*
* A native file s one expressed in the platform-native filename format,
* e.g. "C:\\Windows" or "/usr/bin/". This does not mean the file is local,
* as it might be on a locally mounted remote filesystem.
*
* On some systems non-native files may be available using the native
* filesystem via a userspace filesystem (FUSE), in these cases this call
* will return <tt>false</tt>, but g_file_get_path() will still return a native path.
*
* This call does no blocking I/O.
*
* @return <tt>true</tt> if @a file is native.
*/
bool is_native() const;
/** Checks to see if a File has a given URI scheme.
*
* This call does no blocking I/O.
*
* @param uri_scheme A string containing a URI scheme.
* @return <tt>true</tt> if File's backend supports the
* given URI scheme, <tt>false</tt> if URI scheme is <tt>nullptr</tt>,
* not supported, or File is invalid.
*/
bool has_uri_scheme(const std::string& uri_scheme) const;
/** Gets the URI scheme for a File.
* RFC 3986 decodes the scheme as:
*
* [C example ellipted]
* Common schemes include "file", "http", "ftp", etc.
*
* This call does no blocking I/O.
*
* @return A string containing the URI scheme for the given
* File.
*/
std::string get_uri_scheme() const;
//TODO: We don't have both const and unconst versions because a FileInputStream can't really change the File.
/** Opens a file for reading. The result is a FileInputStream that
* can be used to read the contents of the file.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* If the file is a directory, a Gio::Error with IS_DIRECTORY will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
* @param cancellable A Cancellable.
* @return FileInputStream or <tt>nullptr</tt> on error.
*
* @throws Glib::Error
*/
Glib::RefPtr<FileInputStream> read(const Glib::RefPtr<Cancellable>& cancellable);
/// A read() convenience overload.
Glib::RefPtr<FileInputStream> read();
/** Asynchronously opens the file for reading.
* For more details, see read() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call read_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param io_priority The I/O priority of the request.
*/
void read_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously opens the file for reading.
* For more details, see read() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call read_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param io_priority The I/O priority of the request.
*/
void read_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file read operation started with
* g_file_read_async().
*
* @param res A AsyncResult.
* @return A FileInputStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileInputStream> read_finish(const Glib::RefPtr<AsyncResult>& res);
/** Gets an output stream for appending data to the file. If
* the file doesn't already exist it is created.
*
* By default files created are generally readable by everyone,
* but if you pass FILE_CREATE_PRIVATE in @a flags the file
* will be made readable only to the current user, to the level that
* is supported on the target filesystem.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* Some filesystems don't allow all filenames, and may
* throw a Gio::Error with INVALID_FILENAME.
* If the file is a directory a Gio::Error with IS_DIRECTORY will be
* thrown. Other errors are possible too, and depend on what kind of
* filesystem the file is on.
* @param flags A set of FileCreateFlags.
* @param cancellable Optional Cancellable object.
* @return A FileOutputStream.
*/
Glib::RefPtr<FileOutputStream> append_to(const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE);
/** Gets an output stream for appending data to the file. If
* the file doesn't already exist it is created.
*
* By default files created are generally readable by everyone,
* but if you pass FILE_CREATE_PRIVATE in @a flags the file
* will be made readable only to the current user, to the level that
* is supported on the target filesystem.
*
* Some filesystems don't allow all filenames, and may
* throw a Gio::Error with INVALID_FILENAME.
* If the file is a directory a Gio::Error with IS_DIRECTORY will be
* thrown. Other errors are possible too, and depend on what kind of
* filesystem the file is on.
* @param flags A set of FileCreateFlags.
* @return A FileOutputStream.
*/
Glib::RefPtr<FileOutputStream> append_to(FileCreateFlags flags = FILE_CREATE_NONE);
//We renamed this to create_file from (g_file_create() and g_file_create_readwrite), to avoid confusion with static create() methods,
//but I would still like to choose a different word, but can't think of a good one. murrayc.
/** Creates a new file and returns an output stream for writing to it.
* The file must not already exist.
*
* By default files created are generally readable by everyone,
* but if you pass FILE_CREATE_PRIVATE in @a flags the file
* will be made readable only to the current user, to the level that
* is supported on the target filesystem.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If a file with this name already exists a Gio::Error with EXISTS
* will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY
* will be thrown.
*
* Some filesystems don't allow all filenames, and may
* throw a Gio::Error with INVALID_FILENAME, and if the name
* is to longa Gio::Error with FILENAME_TOO_LONG will be thrown.
* Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags a set of FileCreateFlags.
* @return A FileOutputStream for the newly created file.
*/
Glib::RefPtr<FileOutputStream> create_file(const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE);
/** Creates a new file and returns an output stream for writing to it.
* The file must not already exist.
*
* By default files created are generally readable by everyone,
* but if you pass FILE_CREATE_PRIVATE in @a flags the file
* will be made readable only to the current user, to the level that
* is supported on the target filesystem.
*
* If a file with this name already exists a Gio::Error with EXISTS
* will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY
* will be thrown.
*
* Some filesystems don't allow all filenames, and may
* throw a Gio::Error with INVALID_FILENAME, and if the name
* is to longa Gio::Error with FILENAME_TOO_LONG will be thrown.
* Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
* @param flags a set of FileCreateFlags.
* @return A FileOutputStream for the newly created file.
*/
Glib::RefPtr<FileOutputStream> create_file(FileCreateFlags flags = FILE_CREATE_NONE);
/** Creates a new file and returns a stream for reading and writing to it.
* The file must not already exist.
*
* By default files created are generally readable by everyone,
* but if you pass FILE_CREATE_PRIVATE in @a flags the file
* will be made readable only to the current user, to the level that
* is supported on the target filesystem.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If a file with this name already exists a Gio::Error with EXISTS
* will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY
* will be thrown.
*
* Some filesystems don't allow all filenames, and may
* throw a Gio::Error with INVALID_FILENAME, and if the name
* is to longa Gio::Error with FILENAME_TOO_LONG will be thrown.
* Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
* Note that in many non-local file cases read and write streams are not
* supported, so make sure you really need to do read and write streaming,
* rather than just opening for reading or writing.
*
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags a set of FileCreateFlags.
* @return A FileOutputStream for the newly created file.
*/
Glib::RefPtr<FileIOStream> create_file_readwrite(const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE);
/** Creates a new file and returns a stream for reading and writing to it.
* The file must not already exist.
*
* By default files created are generally readable by everyone,
* but if you pass FILE_CREATE_PRIVATE in @a flags the file
* will be made readable only to the current user, to the level that
* is supported on the target filesystem.
*
* If a file with this name already exists a Gio::Error with EXISTS
* will be thrown. If the file is a directory a Gio::Error with IS_DIRECTORY
* will be thrown.
*
* Some filesystems don't allow all filenames, and may
* throw a Gio::Error with INVALID_FILENAME, and if the name
* is to longa Gio::Error with FILENAME_TOO_LONG will be thrown.
* Other errors are possible too, and depend on what kind of
* filesystem the file is on.
*
* Note that in many non-local file cases read and write streams are not
* supported, so make sure you really need to do read and write streaming,
* rather than just opening for reading or writing.
*
* @param flags a set of FileCreateFlags.
* @return A FileOutputStream for the newly created file.
*/
Glib::RefPtr<FileIOStream> create_file_readwrite(FileCreateFlags flags = FILE_CREATE_NONE);
/** Returns an output stream for overwriting the file, possibly creating a backup copy of the file first.
* This will try to replace the file in the safest way possible so that any errors during the writing will
* not affect an already existing copy of the file. For instance, for local files it may write to a
* temporary file and then atomically rename over the destination when the stream is closed.
*
* By default files created are generally readable by everyone, but if you pass FILE_CREATE_PRIVATE in
* @a flags the file will be made readable only to the current user, to the level that is supported on the
* target filesystem.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If you pass in an etag value, then this value is compared to the current entity tag of the file,
* and if they differ a Gio::Error with WRONG_ETAG will be thrown. This generally means that the file has
* been changed since you last read it. You can get the new etag from FileOutputStream::get_etag()
* after you've finished writing and closed the FileOutputStream. When you load a new file you can
* use FileInputStream::query_info() to get the etag of the file.
*
* If @a make_backup is true, this function will attempt to make a backup of the current file before
* overwriting it. If this fails aa Gio::Error with CANT_CREATE_BACKUP will be thrown. If you want to replace
* anyway, try again with @a make_backup set to false.
*
* If the file is a directory a Gio::Error with IS_DIRECTORY will be thrown, and if the file is some
* other form of non-regular file then aa Gio::Error with NOT_REGULAR_FILE will be thrown. Some file
* systems don't allow all file names, and may throw a Gio::Error with INVALID_FILENAME, and if the
* name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and
* depend on what kind of filesystem the file is on.
*
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param etag An optional entity tag for the current Glib::File.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @return A FileOutputStream.
*/
Glib::RefPtr<FileOutputStream> replace(const Glib::RefPtr<Cancellable>& cancellable, const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Returns an output stream for overwriting the file, possibly creating a backup copy of the file first.
* This will try to replace the file in the safest way possible so that any errors during the writing will
* not affect an already existing copy of the file. For instance, for local files it may write to a
* temporary file and then atomically rename over the destination when the stream is closed.
*
* By default files created are generally readable by everyone, but if you pass FILE_CREATE_PRIVATE in
* @a flags the file will be made readable only to the current user, to the level that is supported on the
* target filesystem.
*
* If you pass in an etag value, then this value is compared to the current entity tag of the file,
* and if they differ a Gio::Error with WRONG_ETAG will be thrown. This generally means that the file has
* been changed since you last read it. You can get the new etag from FileOutputStream::get_etag()
* after you've finished writing and closed the FileOutputStream. When you load a new file you can
* use FileInputStream::query_info() to get the etag of the file.
*
* If @a make_backup is true, this function will attempt to make a backup of the current file before
* overwriting it. If this fails aa Gio::Error with CANT_CREATE_BACKUP will be thrown. If you want to replace
* anyway, try again with @a make_backup set to false.
*
* If the file is a directory a Gio::Error with IS_DIRECTORY will be thrown, and if the file is some
* other form of non-regular file then aa Gio::Error with NOT_REGULAR_FILE will be thrown. Some file
* systems don't allow all file names, and may throw a Gio::Error with INVALID_FILENAME, and if the
* name is to longa Gio::Error with FILENAME_TOO_LONG will be thrown. Other errors are possible too, and
* depend on what kind of filesystem the file is on.
*
* @param etag An optional entity tag for the current Glib::File.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @return A FileOutputStream.
*/
Glib::RefPtr<FileOutputStream> replace(const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Asynchronously opens the file for appending.
* For more details, see append_to() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call append_to_finish() to get the result of the operation.
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags a set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*/
void append_to_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously opens the file for appending.
* For more details, see append_to() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call append_to_finish() to get the result of the operation.
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags a set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*/
void append_to_async(const SlotAsyncReady& slot, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file append operation started with
* g_file_append_to_async().
*
* @param res AsyncResult.
* @return A valid FileOutputStream
* or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileOutputStream> append_to_finish(const Glib::RefPtr<AsyncResult>& res);
//We renamed this to create_file_async from (g_file_create_async() and g_file_create_readwrite_async), to avoid confusion with static create() methods,
//but I would still like to choose a different word, but can't think of a good one. murrayc. See also create_file().
/** Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist.
* For more details, see create_file() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call create_file_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags a set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*/
void create_file_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist.
* For more details, see create_file() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call create_file_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags a set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*/
void create_file_async(const SlotAsyncReady& slot, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file create operation started with
* g_file_create_async().
*
* @param res A AsyncResult.
* @return A FileOutputStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileOutputStream> create_file_finish(const Glib::RefPtr<AsyncResult>& res);
/** Asynchronously creates a new file and returns a stream for reading and
* writing to it. The file must not already exist.
*
* For more details, see create_file_readwrite() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call create_file_readwrite_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags a set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*
* @newin{2,24}
*/
void create_file_readwrite_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously creates a new file and returns a stream for reading and
* writing to it. The file must not already exist.
*
* For more details, see create_file_readwrite() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call create_file_readwrite_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags a set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*
* @newin{2,24}
*/
void create_file_readwrite_async(const SlotAsyncReady& slot, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file create operation started with
* g_file_create_readwrite_async().
*
* @newin{2,22}
*
* @param res A AsyncResult.
* @return A FileIOStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileIOStream> create_file_readwrite_finish(const Glib::RefPtr<AsyncResult>& res);
/** Asyncronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first.
* For more details, see replace() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call replace_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param etag An entity tag for the current Gio::File.
* @param make_backup true if a backup of the existing file should be made.
* @param flags A set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*/
void replace_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asyncronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first.
* For more details, see replace() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call replace_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param etag An entity tag for the current Gio::File.
* @param make_backup true if a backup of the existing file should be made.
* @param flags A set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*/
void replace_async(const SlotAsyncReady& slot, const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file replace operation started with
* g_file_replace_async().
*
* @param res A AsyncResult.
* @return A FileOutputStream, or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileOutputStream> replace_finish(const Glib::RefPtr<AsyncResult>& res);
/** Opens an existing file for reading and writing. The result is
* a FileIOStream that can be used to read and write the contents
* of the file.
*
* If @a cancellable is not <tt>nullptr</tt>, then the operation can be cancelled
* by triggering the cancellable object from another thread. If the
* operation was cancelled, the error IO_ERROR_CANCELLED will be
* returned.
*
* If the file does not exist, the IO_ERROR_NOT_FOUND error will
* be returned. If the file is a directory, the IO_ERROR_IS_DIRECTORY
* error will be returned. Other errors are possible too, and depend on
* what kind of filesystem the file is on. Note that in many non-local
* file cases read and write streams are not supported, so make sure you
* really need to do read and write streaming, rather than just opening
* for reading or writing.
*
* @newin{2,22}
*
* @param cancellable A Cancellable.
* @return FileIOStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileIOStream> open_readwrite(const Glib::RefPtr<Cancellable>& cancellable);
/// A open_readwrite() convenience overload.
Glib::RefPtr<FileIOStream> open_readwrite();
/** Opens an existing file for reading and writing.
* The result is a FileIOStream that can be used to read and write the contents of the file.
*
* For more details, see open_readwrite() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call open_readwrite_finish() to get the result of the operation.
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* If the file is a directory, a Gio::Error with IS_DIRECTORY will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
* Note that in many non-local file cases read and write streams are not supported,
* so make sure you really need to do read and write streaming, rather than
* just opening for reading or writing.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param io_priority The I/O priority of the request.
*
* @newin{2,24}
*/
void open_readwrite_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Opens an existing file for reading and writing.
* The result is a FileIOStream that can be used to read and write the contents of the file.
*
* For more details, see open_readwrite() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call open_readwrite_finish() to get the result of the operation.
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* If the file is a directory, a Gio::Error with IS_DIRECTORY will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
* Note that in many non-local file cases read and write streams are not supported,
* so make sure you really need to do read and write streaming, rather than
* just opening for reading or writing.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param io_priority The I/O priority of the request.
*
* @newin{2,24}
*/
void open_readwrite_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file read operation started with
* g_file_open_readwrite_async().
*
* @newin{2,22}
*
* @param res A AsyncResult.
* @return A FileIOStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileIOStream> open_readwrite_finish(const Glib::RefPtr<AsyncResult>& res);
/** Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first.
*
* If the file doesn't exist, it will be created.
*
* For details about the behaviour, see replace() which does the same thing but returns an output stream only.
*
* Note that in many non-local file cases read and write streams are not supported,
* so make sure you really need to do read and write streaming,
* rather than just opening for reading or writing.
*
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param etag An optional entity tag for the current Glib::File.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @return A FileOutputStream.
*
* @newin{2,24}
*/
Glib::RefPtr<FileIOStream> replace_readwrite(const Glib::RefPtr<Cancellable>& cancellable, const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first.
*
* If the file doesn't exist, it will be created.
*
* For details about the behaviour, see replace() which does the same thing but returns an output stream only.
*
* Note that in many non-local file cases read and write streams are not supported,
* so make sure you really need to do read and write streaming,
* rather than just opening for reading or writing.
*
* @param etag An optional entity tag for the current Glib::File.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @return A FileOutputStream.
*
* @newin{2,24}
*/
Glib::RefPtr<FileIOStream> replace_readwrite(const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Asyncronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first.
*
* For more details, see replace_readwrite() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call replace_readwrite_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param etag An entity tag for the current Gio::File.
* @param make_backup true if a backup of the existing file should be made.
* @param flags A set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*
* @newin{2,24}
*/
void replace_readwrite_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asyncronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first.
*
* For more details, see replace_readwrite() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call replace_readwrite_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param etag An entity tag for the current Gio::File.
* @param make_backup true if a backup of the existing file should be made.
* @param flags A set of FileCreateFlags.
* @param io_priority The I/O priority of the request.
*
* @newin{2,24}
*/
void replace_readwrite_async(const SlotAsyncReady& slot, const std::string& etag = std::string(), bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file replace operation started with
* g_file_replace_readwrite_async().
*
* @newin{2,22}
*
* @param res A AsyncResult.
* @return A FileIOStream, or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileIOStream> replace_readwrite_finish(const Glib::RefPtr<AsyncResult>& res);
/** Gets the requested information about the file. The result
* is a FileInfo object that contains key-value attributes (such as the type or size
* of the file).
*
* The @a attribute value is a string that specifies the file attributes that
* should be gathered. It is not an error if it's not possible to read a particular
* requested attribute from a file - it just won't be set. @a attribute should
* be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
* means all attributes, and a wildcard like "standard::*" means all attributes in the standard
* namespace. An example attribute query be "standard::*,owner::user".
* The standard attributes are available as defines, like G_FILE_ATTRIBUTE_STANDARD_NAME.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* For symlinks, normally the information about the target of the
* symlink is returned, rather than information about the symlink itself.
* However if you pass FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @a flags the
* information about the symlink itself will be returned. Also, for symlinks
* that point to non-existing files the information about the symlink itself
* will be returned.
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
* @param cancellable A Cancellable object.
* @param attributes: An attribute query string.
* @param flags: A set of FileQueryInfoFlags.
* @result a FileInfo for the file, or an empty RefPtr on error.
*/
Glib::RefPtr<FileInfo> query_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE) const;
/** Gets the requested information about the file. The result
* is a FileInfo object that contains key-value attributes (such as the type or size
* of the file).
*
* The @a attribute value is a string that specifies the file attributes that
* should be gathered. It is not an error if it's not possible to read a particular
* requested attribute from a file - it just won't be set. @a attribute should
* be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
* means all attributes, and a wildcard like "standard::*" means all attributes in the standard
* namespace. An example attribute query be "standard::*,owner::user".
* The standard attributes are available as defines, like G_FILE_ATTRIBUTE_STANDARD_NAME.
*
* For symlinks, normally the information about the target of the
* symlink is returned, rather than information about the symlink itself.
* However if you pass FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @a flags the
* information about the symlink itself will be returned. Also, for symlinks
* that point to non-existing files the information about the symlink itself
* will be returned.
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
*
* @param attributes: An attribute query string.
* @param flags: A set of FileQueryInfoFlags.
* @result a FileInfo for the file, or an empty RefPtr on error.
*/
Glib::RefPtr<FileInfo> query_info(const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE) const;
/** Utility function to check if a particular file exists. This is
* implemented using query_info() and as such does blocking I/O.
*
* Note that in many cases it is racy to first check for file existence
* and then execute something based on the outcome of that, because the
* file might have been created or removed in between the operations. The
* general approach to handling that is to not check, but just do the
* operation and handle the errors as they come.
*
* As an example of race-free checking, take the case of reading a file, and
* if it doesn't exist, creating it. There are two racy versions: read it, and
* on error create it; and: check if it exists, if not create it. These
* can both result in two processes creating the file (with perhaps a partially
* written file as the result). The correct approach is to always try to create
* the file with File::create() which will either atomically create the file
* or fail with a Gio::Error exception with EXISTS.
*
* However, in many cases an existence check is useful in a user
* interface, for instance to make a menu item sensitive/insensitive, so that
* you don't have to fool users that something is possible and then just show
* and error dialog. If you do this, you should make sure to also handle the
* errors that can happen due to races when you execute the operation.
*
* @param cancellable Optional Cancellable object, <tt>nullptr</tt> to ignore.
* @return <tt>true</tt> if the file exists (and can be detected without error), <tt>false</tt> otherwise (or if cancelled).
*/
bool query_exists(const Glib::RefPtr<Cancellable>& cancellable) const;
/// A query_exists() convenience overload.
bool query_exists() const;
//We cannot use the {?} format here because we want a default value for flags, but gmmproc then generates a method with a default value for flags when it is not the last parameter.
/** Utility function to inspect the FileType of a file. This is
* implemented using g_file_query_info() and as such does blocking I/O.
*
* The primary use case of this method is to check if a file is
* a regular file, directory, or symlink.
*
* @newin{2,18}
*
* @param flags A set of FileQueryInfoFlags passed to g_file_query_info().
* @param cancellable Optional Cancellable object,
* <tt>nullptr</tt> to ignore.
* @return The FileType of the file and FILE_TYPE_UNKNOWN
* if the file does not exist.
*/
FileType query_file_type(FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable) const;
/** Utility function to inspect the FileType of a file. This is
* implemented using query_info() and as such does blocking I/O.
*
* The primary use case of this method is to check if a file is a regular file,
* directory, or symlink.
*
* @param flags: a set of FileQueryInfoFlags passed to query_info().
* @result The FileType of the file, or FILE_TYPE_UNKNOWN if the file does not exist.
*
* @newin{2,18}
*/
FileType query_file_type(FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE) const;
/** Asynchronously gets the requested information about specified file. The result is a FileInfo object that contains key-value attributes (such as type or size for the file).
*
* For more details, see query_info() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call query_info_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param attributes An attribute query string.
* @param flags A set of FileQueryInfoFlags.
* @param io_priority The I/O priority of the request.
*/
void query_info_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE, int io_priority = Glib::PRIORITY_DEFAULT) const;
/** Asynchronously gets the requested information about specified file. The result is a FileInfo object that contains key-value attributes (such as type or size for the file).
*
* For more details, see query_info() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call query_info_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param attributes An attribute query string.
* @param flags A set of FileQueryInfoFlags.
* @param io_priority The I/O priority of the request.
*/
void query_info_async(const SlotAsyncReady& slot, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE, int io_priority = Glib::PRIORITY_DEFAULT) const;
/** Finishes an asynchronous file info query.
* See g_file_query_info_async().
*
* @param res A AsyncResult.
* @return FileInfo for given @a file
* or <tt>nullptr</tt> on error. Free the returned object with
* Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileInfo> query_info_finish(const Glib::RefPtr<AsyncResult>& res);
/** Similar to query_info(), but obtains information
* about the filesystem the file is on, rather than the file itself.
* For instance the amount of space availible and the type of
* the filesystem.
*
* The @a attribute value is a string that specifies the file attributes that
* should be gathered. It is not an error if its not possible to read a particular
* requested attribute from a file, it just won't be set. @a attribute should
* be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
* means all attributes, and a wildcard like "fs:*" means all attributes in the fs
* namespace. The standard namespace for filesystem attributes is "fs".
* Common attributes of interest are FILE_ATTRIBUTE_FILESYSTEM_SIZE
* (the total size of the filesystem in bytes), FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
* bytes availible), and FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
* @param cancellable A Cancellable object.
* @param attributes An attribute query string.
* @return A FileInfo or an empty RefPtr if there was an error.
*/
Glib::RefPtr<FileInfo> query_filesystem_info(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*");
/** Similar to query_info(), but obtains information
* about the filesystem the file is on, rather than the file itself.
* For instance the amount of space availible and the type of
* the filesystem.
*
* The @a attribute value is a string that specifies the file attributes that
* should be gathered. It is not an error if its not possible to read a particular
* requested attribute from a file, it just won't be set. @a attribute should
* be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
* means all attributes, and a wildcard like "fs:*" means all attributes in the fs
* namespace. The standard namespace for filesystem attributes is "fs".
* Common attributes of interest are FILE_ATTRIBUTE_FILESYSTEM_SIZE
* (the total size of the filesystem in bytes), FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
* bytes availible), and FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
*
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* Other errors are possible too, and depend on what kind of filesystem the file is on.
* @param attributes An attribute query string.
* @return A FileInfo or an empty RefPtr if there was an error.
*/
Glib::RefPtr<FileInfo> query_filesystem_info(const std::string& attributes = "*");
/** Gets a Mount for the File.
*
* If the FileIface for @a file does not have a mount (e.g. possibly a
* remote share), a Gio::Error will be thrown with NOT_FOUND and <tt>nullptr</tt>
* will be returned.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param cancellable Cancellable object.
* @return A Mount where the @a file is located or <tt>nullptr</tt> on error.
*
* @throws Glib::Error
*/
Glib::RefPtr<Mount> find_enclosing_mount(const Glib::RefPtr<Cancellable>& cancellable);
/// A find_enclosing_mount() convenience overload.
Glib::RefPtr<Mount> find_enclosing_mount();
/** Asynchronously gets the requested information about the filesystem
* that the file is on. The result is a FileInfo object
* that contains key-value attributes (such as type or size for the
* file).
*
* For more details, see query_filesystem_info() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call query_filesystem_info_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param attributes An attribute query string.
* @param io_priority The I/O priority of the request.
*/
void query_filesystem_info_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT) const;
/** Asynchronously gets the requested information about the filesystem
* that the file is on. The result is a FileInfo object
* that contains key-value attributes (such as type or size for the
* file).
*
* For more details, see query_filesystem_info() which is the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call query_filesystem_info_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param attributes An attribute query string.
* @param io_priority The I/O priority of the request.
*/
void query_filesystem_info_async(const SlotAsyncReady& slot, const std::string& attributes = "*", int io_priority = Glib::PRIORITY_DEFAULT) const;
/** Finishes an asynchronous filesystem info query.
* See g_file_query_filesystem_info_async().
*
* @param res A AsyncResult.
* @return FileInfo for given @a file
* or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileInfo> query_filesystem_info_finish(const Glib::RefPtr<AsyncResult>& res);
/** Asynchronously gets the mount for the file.
*
* For more details, see find_enclosing_mount() which is
* the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call
* find_enclosing_mount_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object.
* @param io_priority The I/O priority of the request.
*/
void find_enclosing_mount_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously gets the mount for the file.
*
* For more details, see find_enclosing_mount() which is
* the synchronous version of this call.
*
* When the operation is finished, @a slot will be called. You can then call
* find_enclosing_mount_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param io_priority The I/O priority of the request.
*/
void find_enclosing_mount_async(const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous find mount request.
* See g_file_find_enclosing_mount_async().
*
* @param res A AsyncResult.
* @return Mount for given @a file or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<Mount> find_enclosing_mount_finish(const Glib::RefPtr<AsyncResult>& res);
/** Gets the requested information about the files in a directory. The result
* is a FileEnumerator object that will give out FileInfo objects for
* all the files in the directory.
*
* The @a attribute value is a string that specifies the file attributes that
* should be gathered. It is not an error if its not possible to read a particular
* requested attribute from a file, it just won't be set. @a attribute should
* be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
* means all attributes, and a wildcard like "standard::*" means all attributes in the standard
* namespace. An example attribute query be "standard::*,owner::user".
* The standard attributes are availible as defines, like FILE_ATTRIBUTE_STANDARD_NAME.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* If the file is not a directory, a Glib::FileError with NOTDIR will be thrown.
* Other errors are possible too.
*
* @param cancellable A Cancellable object.
* @param attributes An attribute query string.
* @param flags A set of FileQueryInfoFlags.
* @return A FileEnumerator if successful.
*/
Glib::RefPtr<FileEnumerator> enumerate_children(const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE);
/** Gets the requested information about the files in a directory. The result
* is a FileEnumerator object that will give out FileInfo objects for
* all the files in the directory.
*
* The @a attribute value is a string that specifies the file attributes that
* should be gathered. It is not an error if its not possible to read a particular
* requested attribute from a file, it just won't be set. @a attribute should
* be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
* means all attributes, and a wildcard like "standard::*" means all attributes in the standard
* namespace. An example attribute query be "standard::*,owner::user".
* The standard attributes are availible as defines, like FILE_ATTRIBUTE_STANDARD_NAME.
*
* If the file does not exist, a Gio::Error with NOT_FOUND will be thrown.
* If the file is not a directory, a Glib::FileError with NOTDIR will be thrown.
* Other errors are possible too.
*
* @param attributes An attribute query string.
* @param flags A set of FileQueryInfoFlags.
* @return A FileEnumerator if successful.
*/
Glib::RefPtr<FileEnumerator> enumerate_children(const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE);
/** Asynchronously gets the requested information about the files in a directory. The result is a GFileEnumerator object that will give out GFileInfo objects for all the files in the directory.
*
* For more details, see enumerate_children() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call enumerate_children_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param attributes An attribute query string.
* @param flags A set of FileQueryInfoFlags.
* @param io_priority The I/O priority of the request.
*/
void enumerate_children_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously gets the requested information about the files in a directory. The result is a GFileEnumerator object that will give out GFileInfo objects for all the files in the directory.
*
* For more details, see enumerate_children() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call enumerate_children_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param attributes An attribute query string.
* @param flags A set of FileQueryInfoFlags.
* @param io_priority The I/O priority of the request.
*/
void enumerate_children_async(const SlotAsyncReady& slot, const std::string& attributes = "*", FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an async enumerate children operation.
* See g_file_enumerate_children_async().
*
* @param res A AsyncResult.
* @return A FileEnumerator or <tt>nullptr</tt>
* if an error occurred.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileEnumerator> enumerate_children_finish(const Glib::RefPtr<AsyncResult>& res);
/** Renames @a file to the specified display name.
*
* The display name is converted from UTF8 to the correct encoding for the target
* filesystem if possible and the @a file is renamed to this.
*
* If you want to implement a rename operation in the user interface the edit name
* (G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
* widget, and then the result after editing should be passed to g_file_set_display_name().
*
* On success the resulting converted filename is returned.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param display_name A string.
* @param cancellable Cancellable object.
* @return A File specifying what @a file was renamed to, or <tt>nullptr</tt> if there was an error.
*
* @throws Glib::Error
*/
Glib::RefPtr<File> set_display_name(const Glib::ustring& display_name, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_display_name() convenience overload.
Glib::RefPtr<File> set_display_name(const Glib::ustring& display_name);
/** Asynchronously sets the display name for a given Gio::File. For the synchronous version of this function, see set_display_name().
* When the operation is finished, @a slot will be called. You can then call set_display_name_finish() to get the result of the operation.
*
* @param display_name A string.
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param io_priority The I/O priority of the request.
*/
void set_display_name_async(const Glib::ustring& display_name, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously sets the display name for a given Gio::File. For the synchronous version of this function, see set_display_name().
* When the operation is finished, @a slot will be called. You can then call set_display_name_finish() to get the result of the operation.
*
* @param display_name A string.
* @param slot A callback slot which will be called when the request is satisfied.
* @param io_priority The I/O priority of the request.
*/
void set_display_name_async(const Glib::ustring& display_name, const SlotAsyncReady& slot, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes setting a display name started with
* g_file_set_display_name_async().
*
* @param res A AsyncResult.
* @return A File or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<File> set_display_name_finish(const Glib::RefPtr<AsyncResult>& res);
//TODO: Remove the bool results from this and other methods that throw an exception.
/** Deletes a file.
* If the file is a directory, it will only be deleted if it is empty.
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Glib::FileError with ERROR_CANCELLED will be thrown.
*
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @return <tt>true</tt> if the file was deleted. <tt>false</tt> otherwise.
*/
bool remove(const Glib::RefPtr<Cancellable>& cancellable);
/// A remove() convenience overload.
bool remove();
/** Asynchronously delete a file.
* If the file is a directory, it will
* only be deleted if it is empty. This has the same semantics as
* g_unlink().
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param io_priority The I/O priority of the request
* @newin{2,34}
*/
void remove_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously delete a file.
* If the file is a directory, it will
* only be deleted if it is empty. This has the same semantics as
* g_unlink().
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param io_priority The I/O priority of the request
* @newin{2,34}
*/
void remove_async(const SlotAsyncReady& slot_ready, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes deleting a file started with g_file_delete_async().
*
* Virtual: delete_file_finish
* @newin{2,34}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the file was deleted. <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool remove_finish(const Glib::RefPtr<AsyncResult>& result);
/** Sends @a file to the "Trashcan", if possible. This is similar to
* deleting it, but the user can recover it before emptying the trashcan.
* Not all file systems support trashing, so this call can throw a Gio::Error with
* NOT_SUPPORTED.
*
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param cancellable Cancellable object.
* @return <tt>true</tt> on successful trash, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool trash(const Glib::RefPtr<Cancellable>& cancellable);
/// A trash() convenience overload.
bool trash();
/** Asynchronously sends the file to the Trash location, if possible.
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param io_priority The I/O priority of the request
* @newin{2,38}
*/
void trash_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously sends the file to the Trash location, if possible.
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param io_priority The I/O priority of the request
* @newin{2,38}
*/
void trash_async(const SlotAsyncReady& slot_ready, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous file trashing operation, started with
* g_file_trash_async().
*
* Virtual: trash_finish
* @newin{2,38}
*
* @param result A AsyncResult.
* @return <tt>true</tt> on successful trash, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool trash_finish(const Glib::RefPtr<AsyncResult>& result);
/** A signal handler would be, for instance:
* void on_file_progress(goffset current_num_bytes, goffset total_num_bytes);
*/
using SlotFileProgress = sigc::slot<void, goffset, goffset>;
/** Copies the file source to the location specified by destination. Can not handle recursive copies of directories.
* If the flag FILE_COPY_OVERWRITE is specified an already existing destination file is overwritten.
* If the flag FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the source symlink will be copied.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* The operation can be monitored via the @a slot callback.
*
* If the source file does not exist then a Gio::Error with NOT_FOUND will be thrown, independent on the status of the destination.
*
* If FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown.
*
* If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown.
* If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown.
*
* If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file,
* then a Gio::Error with WOULD_RECURSE will be thrown.
*
* If you are interested in copying the Gio::File object itself (not the on-disk file), see File::dup().
*/
bool copy(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE);
/** Copies the file source to the location specified by destination. Can not handle recursive copies of directories.
* If the flag FILE_COPY_OVERWRITE is specified an already existing destination file is overwritten.
* If the flag FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the source symlink will be copied.
*
* The operation can be monitored via the @a slot callback.
*
* If the source file does not exist then a Gio::Error with NOT_FOUND will be thrown, independent on the status of the destination.
*
* If FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown.
*
* If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown.
* If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown.
*
* If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file,
* then a Gio::Error with WOULD_RECURSE will be thrown.
*
* If you are interested in copying the Gio::File object itself (not the on-disk file), see File::dup().
*/
bool copy(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot, FileCopyFlags flags = FILE_COPY_NONE);
/** Copies the file source to the location specified by destination. Can not handle recursive copies of directories.
* If the flag FILE_COPY_OVERWRITE is specified an already existing destination file is overwritten.
* If the flag FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the source symlink will be copied.
*
* If the source file does not exist then a Gio::Error with NOT_FOUND will be thrown, independent on the status of the destination.
*
* If FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown.
*
* If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown.
* If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown.
*
* If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file,
* then a Gio::Error with WOULD_RECURSE will be thrown.
*
* If you are interested in copying the Gio::File object itself (not the on-disk file), see File::dup().
*/
bool copy(const Glib::RefPtr<File>& destination, FileCopyFlags flags = FILE_COPY_NONE);
/** Copies the file to the location specified by @a destination asynchronously.
* For details of the behaviour, see copy().
*
* When the operation is finished, @a slot_ready will be called.
* You can then call copy_finish() to get the result of the operation.
*
* The function specified by @a slot_progress will be called just like
* in copy(), however the callback will run in the main loop, not in
* the thread that is doing the I/O operation.
*
* @param destination Destination File
* @param slot_progress The callback slot to be called with progress information
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param flags Set of FileCopyFlags
* @param io_priority The I/O priority of the request
*/
void copy_async(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot_progress, const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Copies the file to the location specified by @a destination asynchronously.
* For details of the behaviour, see copy().
*
* When the operation is finished, @a slot_ready will be called.
* You can then call copy_finish() to get the result of the operation.
*
* @param destination Destination File
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param flags Set of FileCopyFlags
* @param io_priority The I/O priority of the request
*/
void copy_async(const Glib::RefPtr<File>& destination, const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Copies the file to the location specified by @a destination asynchronously.
* For details of the behaviour, see copy().
*
* When the operation is finished, @a slot_ready will be called.
* You can then call copy_finish() to get the result of the operation.
*
* The function specified by @a slot_progress will be called just like
* in copy(), however the callback will run in the main loop, not in
* the thread that is doing the I/O operation.
*
* @param destination Destination File
* @param slot_progress The callback slot to be called with progress information
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param flags Set of FileCopyFlags
* @param io_priority The I/O priority of the request
*/
void copy_async(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot_progress, const SlotAsyncReady& slot_ready, FileCopyFlags flags = FILE_COPY_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Copies the file to the location specified by @a destination asynchronously.
* For details of the behaviour, see copy().
*
* When the operation is finished, @a slot_ready will be called.
* You can then call copy_finish() to get the result of the operation.
*
* @param destination Destination File
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param flags Set of FileCopyFlags
* @param io_priority The I/O priority of the request
*/
void copy_async(const Glib::RefPtr<File>& destination, const SlotAsyncReady& slot_ready, FileCopyFlags flags = FILE_COPY_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes copying the file started with g_file_copy_async().
*
* @param res A AsyncResult.
* @return A <tt>true</tt> on success, <tt>false</tt> on error.
*
* @throws Glib::Error
*/
bool copy_finish(const Glib::RefPtr<AsyncResult>& res);
/** Tries to move the file or directory source to the location specified by destination. If native move operations are supported then this is
* used, otherwise a copy and delete fallback is used. The native implementation may support moving directories (for instance on moves inside
* the same filesystem), but the fallback code does not.
*
* If the flag FILE_COPY_OVERWRITE is specified an already existing destination file is overwritten.
*
* If the flag FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks will be copied as symlinks, otherwise the target of the source symlink will be copied.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* The operation can be monitored via the @a slot callback.
* If the source file does not exist then a Gio::Error with NOT_FOUND will be thrown, independent on the status of the destination.
*
* If G_FILE_COPY_OVERWRITE is not specified and the target exists, then a Gio::Error with EXISTS will be thrown.
*
* If trying to overwrite a file over a directory a Gio::Error with IS_DIRECTORY will be thrown.
* If trying to overwrite a directory with a directory a Gio::Error with WOULD_MERGE will be thrown.
*
* If the source is a directory and the target does not exist, or FILE_COPY_OVERWRITE is specified and the target is a file, then a Gio::Error with WOULD_RECURSE may be thrown (if the native move operation isn't available).
*/
bool move(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE);
bool move(const Glib::RefPtr<File>& destination, const SlotFileProgress& slot, FileCopyFlags flags = FILE_COPY_NONE);
bool move(const Glib::RefPtr<File>& destination, FileCopyFlags flags = FILE_COPY_NONE);
/** Creates a directory.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param cancellable Cancellable object.
* @return <tt>true</tt> on successful creation, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool make_directory(const Glib::RefPtr<Cancellable>& cancellable);
/// A make_directory() convenience overload.
bool make_directory();
/** Asynchronously creates a directory.
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param io_priority The I/O priority of the request
* @newin{2,38}
*/
void make_directory_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously creates a directory.
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param io_priority The I/O priority of the request
* @newin{2,38}
*/
void make_directory_async(const SlotAsyncReady& slot_ready, int io_priority = Glib::PRIORITY_DEFAULT);
/** Finishes an asynchronous directory creation, started with
* g_file_make_directory_async().
*
* Virtual: make_directory_finish
* @newin{2,38}
*
* @param result A AsyncResult.
* @return <tt>true</tt> on successful directory creation, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool make_directory_finish(const Glib::RefPtr<AsyncResult>& result);
/** Creates a directory and any parent directories that may not
* exist similar to 'mkdir -p'. If the file system does not support
* creating directories, this function will fail, setting @a error to
* IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
* this function will fail setting @a error to IO_ERROR_EXISTS, unlike
* the similar Glib::mkdir_with_parents().
*
* For a local File the newly created directories will have the default
* (current) ownership and permissions of the current process.
*
* If @a cancellable is not <tt>nullptr</tt>, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error IO_ERROR_CANCELLED will be returned.
*
* @newin{2,18}
*
* @param cancellable Optional Cancellable object,
* <tt>nullptr</tt> to ignore.
* @return <tt>true</tt> if all directories have been successfully created, <tt>false</tt>
* otherwise.
*
* @throws Glib::Error
*/
bool make_directory_with_parents(const Glib::RefPtr<Cancellable>& cancellable);
/// A make_directory_with_parents() convenience overload.
bool make_directory_with_parents();
/** Creates a symbolic link.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param symlink_value A string with the value of the new symlink.
* @param cancellable Cancellable object.
* @return <tt>true</tt> on the creation of a new symlink, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool make_symbolic_link(const std::string& symlink_value, const Glib::RefPtr<Cancellable>& cancellable);
/// A make_symbolic_link() convenience overload.
bool make_symbolic_link(const std::string& symlink_value);
/** Obtain the list of settable attributes for the file.
*
* @param cancellable Optional Cancellable object,
* <tt>nullptr</tt> to ignore.
* @return A FileAttributeInfoList describing the settable attributes.
* When you are done with it, release it with
* g_file_attribute_info_list_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileAttributeInfoList> query_settable_attributes(const Glib::RefPtr<Cancellable>& cancellable);
/// A query_settable_attributes() convenience overload.
Glib::RefPtr<FileAttributeInfoList> query_settable_attributes();
/** Obtain the list of attribute namespaces where new attributes
* can be created by a user. An example of this is extended
* attributes (in the "xattr" namespace).
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param cancellable Cancellable object.
* @return A FileAttributeInfoList describing the writable namespaces.
* When you are done with it, release it with g_file_attribute_info_list_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<FileAttributeInfoList> query_writable_namespaces(const Glib::RefPtr<Cancellable>& cancellable);
/// A query_writable_namespaces() convenience overload.
Glib::RefPtr<FileAttributeInfoList> query_writable_namespaces();
/* This seems to be very generic (see the gpointer parameter),
in a C kind of way. Hopefully we don't need it. murrayc
gboolean g_file_set_attribute (GFile *file,
const char *attribute,
GFileAttributeType type,
gpointer value_p,
GFileQueryInfoFlags flags,
GCancellable *cancellable,
GError **error);
*/
/** Tries to set all attributes in the FileInfo on the target values,
* not stopping on the first error.
*
* If there is any error during this operation then a Gio::Error will be thrown.
* Error on particular fields are flagged by setting
* the "status" field in the attribute value to
* FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
* further errors.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* @param info A FileInfo.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags A set of FileQueryInfoFlags.
* @return <tt>true</tt> if there was any error, <tt>false</tt> otherwise.
*/
bool set_attributes_from_info(const Glib::RefPtr<FileInfo>& info, const Glib::RefPtr<Cancellable>& cancellable, FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE);
/** Tries to set all attributes in the FileInfo on the target values,
* not stopping on the first error.
*
* If there is any error during this operation then a Gio::Error will be thrown.
* Error on particular fields are flagged by setting
* the "status" field in the attribute value to
* FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
* further errors.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* @param info A FileInfo.
* @param flags A set of FileQueryInfoFlags.
* @return <tt>true</tt> if there was any error, <tt>false</tt> otherwise.
*/
bool set_attributes_from_info(const Glib::RefPtr<FileInfo>& info, FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE);
/** Asynchronously sets the attributes of file with info.
*
* For more details, see set_attributes_from_info() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call set_attributes_finish() to get the result of the operation.
*
* @param info A FileInfo.
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags A set of FileQueryInfoFlags.
* @param io_priority The I/O priority of the request.
*/
void set_attributes_async(const Glib::RefPtr<FileInfo>& info, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Asynchronously sets the attributes of file with info.
*
* For more details, see set_attributes_from_info() which is the synchronous version of this call.
* When the operation is finished, @a slot will be called. You can then call set_attributes_finish() to get the result of the operation.
*
* @param info A FileInfo.
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags A set of FileQueryInfoFlags.
* @param io_priority The I/O priority of the request.
*/
void set_attributes_async(const Glib::RefPtr<FileInfo>& info, const SlotAsyncReady& slot, FileQueryInfoFlags flags = FILE_QUERY_INFO_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
// takes GFileInfo**
bool set_attributes_finish(const Glib::RefPtr<AsyncResult>& result, const Glib::RefPtr<FileInfo>& info);
/** Sets @a attribute of type G_FILE_ATTRIBUTE_TYPE_STRING to @a value.
* If @a attribute is of a different type, this operation will fail.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param attribute A string containing the attribute's name.
* @param value A string containing the attribute's value.
* @param flags FileQueryInfoFlags.
* @param cancellable Cancellable object.
* @return <tt>true</tt> if the @a attribute was successfully set, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool set_attribute_string(const std::string& attribute, const std::string& value, FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_attribute_string() convenience overload.
bool set_attribute_string(const std::string& attribute, const std::string& value, FileQueryInfoFlags flags);
/** Sets @a attribute of type G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @a value.
* If @a attribute is of a different type, this operation will fail,
* returning <tt>false</tt>.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param attribute A string containing the attribute's name.
* @param value A string containing the attribute's new value.
* @param flags A FileQueryInfoFlags.
* @param cancellable Cancellable object.
* @return <tt>true</tt> if the @a attribute was successfully set to @a value
* in the @a file, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool set_attribute_byte_string(const std::string& attribute, const std::string& value, FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_attribute_byte_string() convenience overload.
bool set_attribute_byte_string(const std::string& attribute, const std::string& value, FileQueryInfoFlags flags);
/** Sets @a attribute of type G_FILE_ATTRIBUTE_TYPE_UINT32 to @a value.
* If @a attribute is of a different type, this operation will fail.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param attribute A string containing the attribute's name.
* @param value A #guint32 containing the attribute's new value.
* @param flags A FileQueryInfoFlags.
* @param cancellable Cancellable object.
* @return <tt>true</tt> if the @a attribute was successfully set to @a value
* in the @a file, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool set_attribute_uint32(const std::string& attribute, guint32 value, FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_attribute_uint32() convenience overload.
bool set_attribute_uint32(const std::string& attribute, guint32 value, FileQueryInfoFlags flags);
/** Sets @a attribute of type G_FILE_ATTRIBUTE_TYPE_INT32 to @a value.
* If @a attribute is of a different type, this operation will fail.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param attribute A string containing the attribute's name.
* @param value A #gint32 containing the attribute's new value.
* @param flags A FileQueryInfoFlags.
* @param cancellable Cancellable object.
* @return <tt>true</tt> if the @a attribute was successfully set to @a value
* in the @a file, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool set_attribute_int32(const std::string& attribute, gint32 value, FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_attribute_int32() convenience overload.
bool set_attribute_int32(const std::string& attribute, gint32 value, FileQueryInfoFlags flags);
/** Sets @a attribute of type G_FILE_ATTRIBUTE_TYPE_UINT64 to @a value.
* If @a attribute is of a different type, this operation will fail.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param attribute A string containing the attribute's name.
* @param value A #guint64 containing the attribute's new value.
* @param flags A FileQueryInfoFlags.
* @param cancellable Cancellable object.
* @return <tt>true</tt> if the @a attribute was successfully set to @a value
* in the @a file, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool set_attribute_uint64(const std::string& attribute, guint64 value, FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_attribute_uint64() convenience overload.
bool set_attribute_uint64(const std::string& attribute, guint64 value, FileQueryInfoFlags flags);
/** Sets @a attribute of type G_FILE_ATTRIBUTE_TYPE_INT64 to @a value.
* If @a attribute is of a different type, this operation will fail.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error will be thrown with CANCELLED.
*
* @param attribute A string containing the attribute's name.
* @param value A #guint64 containing the attribute's new value.
* @param flags A FileQueryInfoFlags.
* @param cancellable Cancellable object.
* @return <tt>true</tt> if the @a attribute was successfully set, <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool set_attribute_int64(const std::string& attribute, gint64 value, FileQueryInfoFlags flags, const Glib::RefPtr<Cancellable>& cancellable);
/// A set_attribute_int64() convenience overload.
bool set_attribute_int64(const std::string& attribute, gint64 value, FileQueryInfoFlags flags);
/** Starts a @a mount_operation, mounting the volume that contains the file.
*
* When this operation has completed, @a slot will be called with,
* and the operation can be finalized with mount_enclosing_volume_finish().
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* @param mount_operation A MountOperation.
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object.
* @param flags Flags affecting the operation.
*/
void mount_enclosing_volume(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Starts a @a mount_operation, mounting the volume that contains the file.
*
* When this operation has completed, @a slot will be called with,
* and the operation can be finalized with mount_enclosing_volume_finish().
*
* @param mount_operation A MountOperation.
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void mount_enclosing_volume(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Starts a @a mount_operation, mounting the volume that contains the file.
*
* When this operation has completed, @a slot will be called with,
* and the operation can be finalized with mount_enclosing_volume_finish().
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void mount_enclosing_volume(const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Starts a @a mount_operation, mounting the volume that contains the file.
*
* @param flags Flags affecting the operation.
*/
void mount_enclosing_volume(MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Finishes a mount operation started by g_file_mount_enclosing_volume().
*
* @param result A AsyncResult.
* @return <tt>true</tt> if successful. If an error has occurred,
* this function will return <tt>false</tt> and set @a error
* appropriately if present.
*
* @throws Glib::Error
*/
bool mount_enclosing_volume_finish(const Glib::RefPtr<AsyncResult>& result);
/** Mounts a file of type FILE_TYPE_MOUNTABLE. Using @a mount_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call mount_mountable_finish() to get the result of the operation.
*
* @param mount_operation A MountOperation.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void mount_mountable(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Mounts a file of type FILE_TYPE_MOUNTABLE. Using @a mount_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When the operation is finished, @a slot will be called. You can then call mount_mountable_finish() to get the result of the operation.
*
* @param mount_operation A MountOperation.
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void mount_mountable(const Glib::RefPtr<MountOperation>& mount_operation, const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Mounts a file of type FILE_TYPE_MOUNTABLE without user interaction.
*
* When the operation is finished, @a slot will be called. You can then call mount_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void mount_mountable(const SlotAsyncReady& slot, MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Mounts a file of type FILE_TYPE_MOUNTABLE without user interaction.
*
* @param flags Flags affecting the operation.
*/
void mount_mountable(MountMountFlags flags = MOUNT_MOUNT_NONE);
/** Finishes a mount operation. See g_file_mount_mountable() for details.
*
* Finish an asynchronous mount operation that was started
* with g_file_mount_mountable().
*
* @param result A AsyncResult.
* @return A File or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<File> mount_mountable_finish(const Glib::RefPtr<AsyncResult>& result);
/** Unmounts a file of type FILE_TYPE_MOUNTABLE.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call unmount_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags Flags affecting the operation.
*/
void unmount_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Unmounts a file of type FILE_TYPE_MOUNTABLE.
*
* When the operation is finished, @a slot will be called. You can then call unmount_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void unmount_mountable(const SlotAsyncReady& slot, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Unmounts a file of type FILE_TYPE_MOUNTABLE.
*
* @param flags Flags affecting the operation.
*/
void unmount_mountable(MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Unmounts a file of type FILE_TYPE_MOUNTABLE.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call unmount_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param mount_operation A MountOperation
* @param flags Flags affecting the operation.
*
* @newin{2,24}
*/
void unmount_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Unmounts a file of type FILE_TYPE_MOUNTABLE.
*
* When the operation is finished, @a slot will be called. You can then call unmount_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param mount_operation A MountOperation
* @param flags Flags affecting the operation.
*
* @newin{2,24}
*/
void unmount_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Unmounts a file of type FILE_TYPE_MOUNTABLE.
*
* @param mount_operation A MountOperation
* @param flags Flags affecting the operation.
*
* @newin{2,24}
*/
void unmount_mountable(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Finishes an unmount operation,
* see g_file_unmount_mountable_with_operation() for details.
*
* Finish an asynchronous unmount operation that was started
* with g_file_unmount_mountable_with_operation().
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the operation finished successfully.
* <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool unmount_mountable_finish(const Glib::RefPtr<AsyncResult>& result);
/** Starts an asynchronous eject on a mountable.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call eject_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param flags Flags affecting the operation.
*/
void eject_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Starts an asynchronous eject on a mountable.
*
* When the operation is finished, @a slot will be called. You can then call eject_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param flags Flags affecting the operation.
*/
void eject_mountable(const SlotAsyncReady& slot, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Starts an asynchronous eject on a mountable.
*
* @param flags Flags affecting the operation.
*/
void eject_mountable(MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Starts an asynchronous eject on a mountable.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call eject_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
* @param mount_operation A MountOperation
* @param flags Flags affecting the operation.
*
* @newin{2,24}
*/
void eject_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Starts an asynchronous eject on a mountable.
*
* When the operation is finished, @a slot will be called. You can then call eject_mountable_finish() to get the result of the operation.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param mount_operation A MountOperation
* @param flags Flags affecting the operation.
*
* @newin{2,24}
*/
void eject_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Starts an asynchronous eject on a mountable.
*
* @param mount_operation A MountOperation
* @param flags Flags affecting the operation.
*
* @newin{2,24}
*/
void eject_mountable(const Glib::RefPtr<MountOperation>& mount_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Finishes an asynchronous eject operation started by
* g_file_eject_mountable_with_operation().
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the @a file was ejected successfully.
* <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool eject_mountable_finish(const Glib::RefPtr<AsyncResult>& result);
/** Copies the file attributes from @a source to @a destination.
*
* Normally only a subset of the file attributes are copied,
* those that are copies in a normal file copy operation
* (which for instance does not include e.g. mtime). However
* if FILE_COPY_ALL_METADATA is specified in @a flags, then
* all the metadata that is possible to copy is copied.
*
* @param destination A File to copy attributes to.
* @param cancellable A Cancellable object.
* @param flags A set of FileMonitorFlags.
* @result true if the attributes were copied successfully, false otherwise.
*/
bool copy_attributes(const Glib::RefPtr<File>& destination, const Glib::RefPtr<Cancellable>& cancellable, FileCopyFlags flags = FILE_COPY_NONE);
/** Copies the file attributes from @a source to @a destination.
*
* Normally only a subset of the file attributes are copied,
* those that are copies in a normal file copy operation
* (which for instance does not include e.g. mtime). However
* if FILE_COPY_ALL_METADATA is specified in @a flags, then
* all the metadata that is possible to copy is copied.
*
* @param destination A File to copy attributes to.
* @param flags A set of FileMonitorFlags.
* @result true if the attributes were copied successfully, false otherwise.
*/
bool copy_attributes(const Glib::RefPtr<File>& destination, FileCopyFlags flags = FILE_COPY_NONE);
/** Obtains a directory monitor for the given file.
* This may fail if directory monitoring is not supported.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param cancellable A Cancellable object.
* @param flags A set of FileMonitorFlags.
* @return A FileMonitor for the file.
*/
Glib::RefPtr<FileMonitor> monitor_directory(const Glib::RefPtr<Cancellable>& cancellable, FileMonitorFlags flags = FILE_MONITOR_NONE);
/** Obtains a directory monitor for the given file.
* This may fail if directory monitoring is not supported.
*
* @param flags A set of FileMonitorFlags.
* @return A FileMonitor for the file.
*/
Glib::RefPtr<FileMonitor> monitor_directory(FileMonitorFlags flags = FILE_MONITOR_NONE);
/** Obtains a file monitor for the given file. If no file notification
* mechanism exists, then regular polling of the file is used.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param cancellable A Cancellable object.
* @param flags A set of FileMonitorFlags.
* @return A FileMonitor for the file.
*/
Glib::RefPtr<FileMonitor> monitor_file(const Glib::RefPtr<Cancellable>& cancellable, FileMonitorFlags flags = FILE_MONITOR_NONE);
/** Obtains a file monitor for the given file. If no file notification
* mechanism exists, then regular polling of the file is used.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param flags A set of FileMonitorFlags.
* @return A FileMonitor for the file.
*/
Glib::RefPtr<FileMonitor> monitor_file(FileMonitorFlags flags = FILE_MONITOR_NONE);
/** Obtains a file monitor for the given file. If no file notification
* mechanism exists, then regular polling of the file is used.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param cancellable A Cancellable object.
* @param flags A set of FileMonitorFlags.
* @return A FileMonitor for the file.
*
* @newin{2,18}
*/
Glib::RefPtr<FileMonitor> monitor(const Glib::RefPtr<Cancellable>& cancellable, FileMonitorFlags flags = FILE_MONITOR_NONE);
/** Obtains a file monitor for the given file. If no file notification
* mechanism exists, then regular polling of the file is used.
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param flags A set of FileMonitorFlags.
* @return A FileMonitor for the file.
*
* @newin{2,18}
*/
Glib::RefPtr<FileMonitor> monitor(FileMonitorFlags flags = FILE_MONITOR_NONE);
/** This slot type is used by measure_disk_usage() to make
* periodic progress reports when measuring the amount of disk spaced
* used by a directory.
*
* These calls are made on a best-effort basis and not all types of
* GFile will support them. At the minimum, however, one call will
* always be made immediately.
*
* In the case that there is no support, @a reporting will be set to
* false (and the other values undefined) and no further calls will be
* made. Otherwise, the @a reporting will be true and the other values
* all-zeros during the first (immediate) call. In this way, you can
* know which type of progress UI to show without a delay.
*
* For measure_disk_usage() the callback is made directly. For
* measure_disk_usage_async() the callback is made via the
* default main context of the calling thread (ie: the same way that the
* final async result would be reported).
*
* @a current_size is in the same units as requested by the operation (see
* FILE_DISK_USAGE_APPARENT_SIZE).
*
* The frequency of the updates is implementation defined, but is
* ideally about once every 200ms.
*
* The last progress callback may or may not be equal to the final
* result. Always check the async result to get the final value.
*
* For instance,
* void on_file_measure_progress(bool reporting, guint64 current_size, guint64 num_dirs, guint64 num_files);
*
* @param reporting true if more reports will come.
* @param current_size The current cumulative size measurement.
* @param num_dirs The number of directories visited so far.
* @param num_files The number of non-directory files encountered.
*
* @newin{2,38}
*/
using SlotFileMeasureProgress = sigc::slot<void, bool, guint64, guint64, guint64>;
//We do not use the {callback} syntax with _WRAP_METHOD here, because it expects to use user_data rather than progress_data.
//We ignore the gboolean result, because we throw an exception if it is false.
/** Recursively measures the disk usage of the file.
*
* This is essentially an analog of the '<tt>du</tt>' command,
* but it also reports the number of directories and non-directory files
* encountered (including things like symbolic links).
*
* By default, errors are only reported against the toplevel file
* itself. Errors found while recursing are silently ignored, unless
* FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @a flags.
*
* The returned size, @a disk_usage, is in bytes and should be formatted
* with g_format_size() in order to get something reasonable for showing
* in a user interface.
*
* @a slot_progress can be given to request periodic progress updates while scanning.
* See the documentation for SlotFileMeasureProgress for information about when and how the
* callback will be invoked.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param slot_progress A SlotFileMeasureProgress to call periodically while scanning.
* @param disk_usage The number of bytes of disk space used.
* @param num_dirs The number of directories encountered.
* @param num_files The number of non-directories encountered.
* @param flags Set of FileMeasureFlags.
*/
void measure_disk_usage(const Glib::RefPtr<Cancellable>& cancellable, const SlotFileMeasureProgress& slot_progress, guint64& disk_usage, guint64& num_dirs, guint64& num_files, FileMeasureFlags flags = FILE_MEASURE_NONE);
/** Recursively measures the disk usage of the file.
*
* This is the asynchronous version of measure_disk_usage(). See
* there for more information.
*
* When the operation is finished, @a slot_ready will be called.
* You can then call measure_disk_usage_finish() to get the result of the operation.
*
* @param slot_ready A SlotAsyncReady to call when the request is satisfied
* @param cancellable A Cancellable object which can be used to cancel the operation
* @param slot_progress The callback slot to be called with progress information
* @param flags Set of FileMeasureFlags
* @param io_priority The I/O priority of the request
*/
void measure_disk_usage_async(const SlotAsyncReady& slot_ready, const Glib::RefPtr<Cancellable>& cancellable, const SlotFileMeasureProgress& slot_progress, FileMeasureFlags flags = FILE_MEASURE_NONE, int io_priority = Glib::PRIORITY_DEFAULT);
/** Collects the results from an earlier call to
* g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
* more information.
*
* @newin{2,38}
*
* @param result The AsyncResult passed to your SlotAsyncReady.
* @param disk_usage The number of bytes of disk space used.
* @param num_dirs The number of directories encountered.
* @param num_files The number of non-directories encountered.
* @return <tt>true</tt> if successful, with the out parameters set.
* <tt>false</tt> otherwise, with @a error set.
*
* @throws Glib::Error
*/
bool measure_disk_usage_finish(const Glib::RefPtr<AsyncResult>& result, guint64& disk_usage, guint64& num_dirs, guint64& num_files);
//TODO: The documentation for these start/stop/poll_mountable functions needs to be improved once we've figured out what they do and what the C documentation means. murrayc.
/** Starts a file of type Mountable.
* Using @a start_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with start_mountable_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot A callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param start_operation A MountOperation, or <tt>nullptr</tt> to avoid user interaction.
* @param flags Flags affecting the operation
*
* @newin{2,24}
*/
void start_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const Glib::RefPtr<MountOperation>& start_operation, DriveStartFlags flags = DRIVE_START_NONE);
/** Starts a file of type Mountable.
* Using @a start_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with start_mountable_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot A callback to call when the request is satisfied.
* @param start_operation A MountOperation, or <tt>nullptr</tt> to avoid user interaction.
* @param flags Flags affecting the operation
*
* @newin{2,24}
*/
void start_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<MountOperation>& start_operation, DriveStartFlags flags = DRIVE_START_NONE);
/** Finishes a start operation. See g_file_start_mountable() for details.
*
* Finish an asynchronous start operation that was started
* with g_file_start_mountable().
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the operation finished successfully. <tt>false</tt>
* otherwise.
*
* @throws Glib::Error
*/
bool start_mountable_finish(const Glib::RefPtr<AsyncResult>& result);
/** Stops a file of type Mountable.
* Using @a start_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with stop_mountable_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot A callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param start_operation A MountOperation, or <tt>nullptr</tt> to avoid user interaction.
* @param flags Flags affecting the operation
*
* @newin{2,24}
*/
void stop_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const Glib::RefPtr<MountOperation>& start_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Stops a file of type Mountable.
* Using @a start_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with stop_mountable_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot A callback to call when the request is satisfied.
* @param start_operation A MountOperation, or <tt>nullptr</tt> to avoid user interaction.
* @param flags Flags affecting the operation
*
* @newin{2,24}
*/
void stop_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<MountOperation>& start_operation, MountUnmountFlags flags = MOUNT_UNMOUNT_NONE);
/** Finishes an stop operation, see g_file_stop_mountable() for details.
*
* Finish an asynchronous stop operation that was started
* with g_file_stop_mountable().
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the operation finished successfully.
* <tt>false</tt> otherwise.
*
* @throws Glib::Error
*/
bool stop_mountable_finish(const Glib::RefPtr<AsyncResult>& result);
/** Polls a file of type Mountable.
* Using @a start_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with stop_mountable_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot: A callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
*
* @newin{2,24}
*/
void poll_mountable(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
/** Polls a file of type Mountable.
* Using @a start_operation, you can request callbacks when, for instance,
* passwords are needed during authentication.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with stop_mountable_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot: A callback to call when the request is satisfied.
*
* @newin{2,24}
*/
void poll_mountable(const SlotAsyncReady& slot);
/** Finishes a poll operation. See g_file_poll_mountable() for details.
*
* Finish an asynchronous poll operation that was polled
* with g_file_poll_mountable().
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the operation finished successfully. <tt>false</tt>
* otherwise.
*
* @throws Glib::Error
*/
bool poll_mountable_finish(const Glib::RefPtr<AsyncResult>& result);
/** Returns the AppInfo that is registered as the default
* application to handle the file specified by @a file.
*
* If @a cancellable is not <tt>nullptr</tt>, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error IO_ERROR_CANCELLED will be returned.
*
* @param cancellable Optional Cancellable object, <tt>nullptr</tt> to ignore.
* @return A AppInfo if the handle was found,
* <tt>nullptr</tt> if there were errors.
* When you are done with it, release it with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<AppInfo> query_default_handler(const Glib::RefPtr<Cancellable>& cancellable);
/// A query_default_handler() convenience overload.
Glib::RefPtr<AppInfo> query_default_handler();
//TODO: Something better than char*& for contents?
/** Loads the content of the file into memory, returning the size of the data.
* The data is always zero terminated, but this is not included in the resultant @a length.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error exception with CANCELLED will be returned.
*
* @param cancellable A cancellable object.
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @param etag_out A location to place the current entity tag for the file.
*/
bool load_contents(const Glib::RefPtr<Cancellable>& cancellable, char*& contents, gsize& length, std::string& etag_out);
/** Loads the content of the file into memory, returning the size of the data.
* The data is always zero terminated, but this is not included in the resultant @a length.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error exception with CANCELLED will be returned.
*
* @param cancellable A cancellable object.
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @newin{2,22}
*/
bool load_contents(const Glib::RefPtr<Cancellable>& cancellable, char*& contents, gsize& length);
//TODO: Something better than char*& for contents?
/** Loads the content of the file into memory, returning the size of the data.
* The data is always zero terminated, but this is not included in the resultant @a length.
*
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @param etag_out A location to place the current entity tag for the file.
*/
bool load_contents(char*& contents, gsize& length, std::string& etag_out);
/** Loads the content of the file into memory, returning the size of the data.
* The data is always zero terminated, but this is not included in the resultant @a length.
*
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @newin{2,22}
*/
bool load_contents(char*& contents, gsize& length);
/** Starts an asynchronous load of the file's contents.
* For more details, see load_contents() which is the synchronous version of this call.
*
* When the load operation has completed, the @a slot will be called. To finish the operation,
* call load_contents_finish() with the AsyncResult provided to the @a slot.
*
* The operation can be cancelled by triggering the cancellable object from another thread.
* If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* @param slot A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object.
*/
void load_contents_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable);
/** Starts an asynchronous load of the file's contents.
* For more details, see load_contents() which is the synchronous version of this call.
*
* When the load operation has completed, the @a slot will be called. To finish the operation,
* call load_contents_finish() with the AsyncResult provided to the @a slot.
*
* @param slot A callback slot which will be called when the request is satisfied.
*/
void load_contents_async(const SlotAsyncReady& slot);
/** Finishes an asynchronous load of the @a file's contents.
* The contents are placed in @a contents, and @a length is set to the
* size of the @a contents string. If @a etag_out is present, it will be
* set to the new entity tag for the @a file.
* @param result A AsyncResult.
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @param etag_out A location to place the current entity tag for the file.
* @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is
* present, it will be set appropriately.
*/
bool load_contents_finish(const Glib::RefPtr<AsyncResult>& result, char*& contents, gsize& length, std::string& etag_out);
/** Finishes an asynchronous load of the @a file's contents.
* The contents are placed in @a contents, and @a length is set to the
* size of the @a contents string. If @a etag_out is present, it will be
* set to the new entity tag for the @a file.
* @param result A AsyncResult.
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is
* present, it will be set appropriately.
* @newin{2,22}
*/
bool load_contents_finish(const Glib::RefPtr<AsyncResult>& result, char*& contents, gsize& length);
/** A signal handler would be, for instance:
* bool on_read_more(const char* file_contents, goffset file_size);
*/
using SlotReadMore = sigc::slot<bool, const char*, goffset>;
//Note that slot_read_more can be nullptr but that would not be a useful method overload, because the documentation says that it would
//then be equivalent to load_contents_async.
/** Reads the partial contents of a file.
* The @a slot_read_more callback slot should be used to stop reading from the file when appropriate. This operation can be finished by load_partial_contents_finish().
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call load_partial_contents_finish() to get the result of the operation.
*
* @param slot_read_more A callback to receive partial data and to specify whether further data should be read.
* @param slot_async_ready A callback slot which will be called when the request is satisfied.
* @param cancellable A Cancellable object which can be used to cancel the operation.
*/
void load_partial_contents_async(const SlotReadMore& slot_read_more, const SlotAsyncReady& slot_async_ready, const Glib::RefPtr<Cancellable>& cancellable);
/** Reads the partial contents of a file.
* The @a slot_read_more callback slot should be used to stop reading from the file when appropriate. This operation can be finished by load_partial_contents_finish().
*
* The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled,
* a Gio::Error with CANCELLED will be thrown.
*
* When the operation is finished, @a slot will be called. You can then call load_partial_contents_finish() to get the result of the operation.
*
* @param slot_read_more A callback to receive partial data and to specify whether further data should be read.
* @param slot_async_ready A callback slot which will be called when the request is satisfied.
*/
void load_partial_contents_async(const SlotReadMore& slot_read_more, const SlotAsyncReady& slot_async_ready);
/** Finishes an asynchronous partial load operation that was started
* with load_partial_contents_async().
* @param result A AsyncResult.
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @param etag_out A location to place the current entity tag for the file.
* @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is
* present, it will be set appropriately.
*/
bool load_partial_contents_finish(const Glib::RefPtr<AsyncResult>& result, char*& contents, gsize& length, std::string& etag_out);
/** Finishes an asynchronous partial load operation that was started
* with load_partial_contents_async().
* @param result A AsyncResult.
* @param contents A location to place the contents of the file.
* @param length A location to place the length of the contents of the file.
* @return <tt>true</tt> if the load was successful. If <tt>false</tt> and @a error is
* present, it will be set appropriately.
* @newin{2,22}
*/
bool load_partial_contents_finish(const Glib::RefPtr<AsyncResult>& result, char*& contents, gsize& length);
/** Replaces the contents of the file with @a contents of @a length bytes.
*
* If @a etag is specified (not an empty string) any existing file must have that etag, or
* a Gio::Error with WRONG_ETAG will be thrown.
*
* If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* The returned @a new_etag can be used to verify that the file hasn't changed the
* next time it is saved over.
* @param contents A string containing the new contents for the file.
* @param length The length of @a contents in bytes.
* @param etag The old entity tag
* for the document.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @param new_etag A location to a new entity tag
* for the document.
* @param cancellable A Cancellable object.
*/
void replace_contents(const char* contents, gsize length, const std::string& etag, std::string& new_etag, const Glib::RefPtr<Cancellable>& cancellable, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Replaces the contents of the file with @a contents of @a length bytes.
*
* If @a etag is specified (not an empty string) any existing file must have that etag, or
* a Gio::Error with WRONG_ETAG will be thrown.
*
* If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file.
*
* The returned @a new_etag can be used to verify that the file hasn't changed the
* next time it is saved over.
* @param contents A string containing the new contents for the file.
* @param length The length of @a contents in bytes.
* @param etag The old entity tag
* for the document.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @param new_etag A location to a new entity tag
* for the document.
*/
void replace_contents(const char* contents, gsize length, const std::string& etag, std::string& new_etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Replaces the contents of the file with @a contents.
*
* If @a etag is specified (not an empty string) any existing file must have that etag, or
* a Gio::Error with WRONG_ETAG will be thrown.
*
* If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file.
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* The returned @a new_etag can be used to verify that the file hasn't changed the
* next time it is saved over.
* @param contents A string containing the new contents for the file.
* @param etag The old entity tag
* for the document.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @param new_etag A location to a new entity tag
* for the document.
* @param cancellable A Cancellable object.
*/
void replace_contents(const std::string& contents, const std::string& etag, std::string& new_etag, const Glib::RefPtr<Cancellable>& cancellable, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Replaces the contents of the file with @a contents.
*
* If @a etag is specified (not an empty string) any existing file must have that etag, or
* a Gio::Error with WRONG_ETAG will be thrown.
*
* If @a make_backup is <tt>true</tt>, this function will attempt to make a backup of the file.
*
* The returned @a new_etag can be used to verify that the file hasn't changed the
* next time it is saved over.
* @param contents A string containing the new contents for the file.
* @param etag The old entity tag
* for the document.
* @param make_backup <tt>true</tt> if a backup should be created.
* @param flags A set of FileCreateFlags.
* @param new_etag A location to a new entity tag
* for the document.
*/
void replace_contents(const std::string& contents, const std::string& etag, std::string& new_etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
//TODO: Add replace_contents() without the etags?
/** Starts an asynchronous replacement of the file with the given
* @a contents of @a length bytes. @a etag will replace the document's
* current entity tag.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with replace_contents_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If @a make_backup is true, this function will attempt to
* make a backup of the file.
*
* @param slot: A callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param contents String of contents to replace the file with.
* @param length The length of @a contents in bytes.
* @param etag a new entity tag for the file.
* @param make_backup true if a backup should be created.
* @param flags A set of FileCreateFlags.
*/
void replace_contents_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const char* contents, gsize length, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Starts an asynchronous replacement of the file with the given
* @a contents of @a length bytes. @a etag will replace the document's
* current entity tag.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with replace_contents_finish().
*
* If @a make_backup is true, this function will attempt to
* make a backup of the file.
*
* @param slot: A callback to call when the request is satisfied.
* @param contents String of contents to replace the file with.
* @param length The length of @a contents in bytes.
* @param etag a new entity tag for the file.
* @param make_backup true if a backup should be created.
* @param flags A set of FileCreateFlags.
*/
void replace_contents_async(const SlotAsyncReady& slot, const char* contents, gsize length, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Starts an asynchronous replacement of the file with the given
* @a contents of @a length bytes. @a etag will replace the document's
* current entity tag.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with replace_contents_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If @a make_backup is true, this function will attempt to
* make a backup of the file.
*
* @param slot: A callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param contents String of contents to replace the file with.
* @param etag a new entity tag for the file.
* @param make_backup true if a backup should be created.
* @param flags A set of FileCreateFlags.
*/
void replace_contents_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const std::string& contents, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Starts an asynchronous replacement of the file with the given
* @a contents. @a etag will replace the document's
* current entity tag.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with replace_contents_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If @a make_backup is true, this function will attempt to
* make a backup of the file.
*
* @param slot: A callback to call when the request is satisfied.
* @param contents String of contents to replace the file with.
* @param etag a new entity tag for the file.
* @param make_backup true if a backup should be created.
* @param flags A set of FileCreateFlags.
*/
void replace_contents_async(const SlotAsyncReady& slot, const std::string& contents, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Finishes an asynchronous replace of the given file . See
* replace_contents_async(). Sets @a new_etag to the new entity
* tag for the document.
* @param result A AsyncResult.
* @param new_etag A location of a new entity tag
* for the document.
*/
void replace_contents_finish(const Glib::RefPtr<AsyncResult>& result, std::string& new_etag);
/** Finishes an asynchronous replace of the given file . See
* replace_contents_async(). Sets @a new_etag to the new entity
* tag for the document.
* @param result A AsyncResult.
* for the document.
*/
void replace_contents_finish(const Glib::RefPtr<AsyncResult>& result);
/** Same as replace_contents_async() but takes a Gio::Bytes input instead.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with replace_contents_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If @a make_backup is true, this function will attempt to
* make a backup of the file.
*
* @param slot: A callback to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @param contents Bytes of contents to replace the file with.
* @param etag a new entity tag for the file.
* @param make_backup true if a backup should be created.
* @param flags A set of FileCreateFlags.
*/
void replace_contents_bytes_async(const SlotAsyncReady& slot, const Glib::RefPtr<Cancellable>& cancellable, const Glib::RefPtr<const Glib::Bytes>& contents, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Same as replace_contents_async() but takes a Gio::Bytes input instead.
*
* When this operation has completed, @a slot will be called
* and the operation can be finalized with replace_contents_finish().
*
* The operation can be cancelled by
* triggering the cancellable object from another thread. If the operation
* was cancelled, a Gio::Error with CANCELLED will be thrown.
*
* If @a make_backup is true, this function will attempt to
* make a backup of the file.
*
* @param slot: A callback to call when the request is satisfied.
* @param contents Bytes of contents to replace the file with.
* @param etag a new entity tag for the file.
* @param make_backup true if a backup should be created.
* @param flags A set of FileCreateFlags.
*/
void replace_contents_bytes_async(const SlotAsyncReady& slot, const Glib::RefPtr<const Glib::Bytes>& contents, const std::string& etag, bool make_backup = false, FileCreateFlags flags = FILE_CREATE_NONE);
/** Checks if @a file supports
* [thread-default contexts][g-main-context-push-thread-default-context].
* If this returns <tt>false</tt>, you cannot perform asynchronous operations on
* @a file in a thread that has a thread-default context.
*
* @newin{2,22}
*
* @return Whether or not @a file supports thread-default contexts.
*/
bool supports_thread_contexts() const;
// *** vfuncs ***
//_WRAP_VFUNC(Glib::RefPtr<File> dup() const, "dup")
//_WRAP_VFUNC(guint hash() const, "hash")
//TODO: equal() vfunc
//_WRAP_VFUNC(std::string get_basename() const, "get_basename")
//_WRAP_VFUNC(std::string get_path() const, "get_path")
//_WRAP_VFUNC(std::string get_uri() const, "get_uri")
//_WRAP_VFUNC(std::string get_parse_name() const, "get_parse_name")
//Careful of refcounting: //_WRAP_VFUNC(Glib::RefPtr<File> get_parent() const, "get_parent")
// GFileIface does not define get_child(). Perhaps it's not intentional.
// //_WRAP_VFUNC(Glib::RefPtr<File> get_child(const std::string& name) const, "get_child")
// howto wrap a vfunc that takes a GError**
// //_WRAP_VFUNC(Glib::RefPtr<File> get_child_for_display_name(const Glib::ustring& display_name) const,
// "get_child_for_display_name",
// errthrow)
//_WRAP_VFUNC(bool has_prefix(const Glib::RefPtr<const File>& prefix) const, "has_prefix")
//_WRAP_VFUNC(std::string get_relative_path(const Glib::RefPtr<const File>& descendant) const, "get_relative_path")
//Careful of refcounting: //_WRAP_VFUNC(Glib::RefPtr<const File> resolve_relative_path(const std::string& relative_path) const, "resolve_relative_path")
//_WRAP_VFUNC(bool is_native() const, "is_native")
//_WRAP_VFUNC(bool has_uri_scheme(const std::string& uri_scheme) const, "has_uri_scheme")
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gio
namespace Glib
{
//Pre-declare this so we can use it in TypeTrait:
Glib::RefPtr<Gio::File> wrap(GFile* object, bool take_copy);
namespace Container_Helpers
{
/** This specialization of TypeTraits exists
* because the default use of Glib::wrap(GObject*),
* instead of a specific Glib::wrap(GSomeInterface*),
* would not return a wrapper for an interface.
*/
template <>
struct TypeTraits< Glib::RefPtr<Gio::File> >
{
using CppType = Glib::RefPtr<Gio::File>;
using CType = GFile*;
using CTypeNonConst = GFile*;
static CType to_c_type (const CppType& item)
{ return Glib::unwrap (item); }
static CppType to_cpp_type (const CType& item)
{
//Use a specific Glib::wrap() function,
//because CType has the specific type (not just GObject):
return Glib::wrap(item, true /* take_copy */);
}
static void release_c_type (CType item)
{
GLIBMM_DEBUG_UNREFERENCE(nullptr, item);
g_object_unref(item);
}
};
} // Container_Helpers
} // Glib
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::File
*/
Glib::RefPtr<Gio::File> wrap(GFile* object, bool take_copy = false);
} // namespace Glib
#endif /* _GIOMM_FILE_H */
|