/usr/include/d/gtkd-3/glib/BookmarkFile.d is in libgtkd-3-dev 3.7.5-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 | /*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module glib.BookmarkFile;
private import glib.ConstructionException;
private import glib.ErrorG;
private import glib.GException;
private import glib.Str;
private import glib.c.functions;
public import glib.c.types;
public import gtkc.glibtypes;
private import gtkd.Loader;
/**
* The `GBookmarkFile` structure contains only
* private data and should not be directly accessed.
*/
public class BookmarkFile
{
/** the main Gtk struct */
protected GBookmarkFile* gBookmarkFile;
protected bool ownedRef;
/** Get the main Gtk struct */
public GBookmarkFile* getBookmarkFileStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gBookmarkFile;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gBookmarkFile;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GBookmarkFile* gBookmarkFile, bool ownedRef = false)
{
this.gBookmarkFile = gBookmarkFile;
this.ownedRef = ownedRef;
}
~this ()
{
if ( Linker.isLoaded(LIBRARY_GLIB) && ownedRef )
g_bookmark_file_free(gBookmarkFile);
}
/**
* Adds the application with @name and @exec to the list of
* applications that have registered a bookmark for @uri into
* @bookmark.
*
* Every bookmark inside a #GBookmarkFile must have at least an
* application registered. Each application must provide a name, a
* command line useful for launching the bookmark, the number of times
* the bookmark has been registered by the application and the last
* time the application registered this bookmark.
*
* If @name is %NULL, the name of the application will be the
* same returned by g_get_application_name(); if @exec is %NULL, the
* command line will be a composition of the program name as
* returned by g_get_prgname() and the "\%u" modifier, which will be
* expanded to the bookmark's URI.
*
* This function will automatically take care of updating the
* registrations count and timestamping in case an application
* with the same @name had already registered a bookmark for
* @uri inside @bookmark.
*
* If no bookmark for @uri is found, one is created.
*
* Params:
* uri = a valid URI
* name = the name of the application registering the bookmark
* or %NULL
* exec = command line to be used to launch the bookmark or %NULL
*
* Since: 2.12
*/
public void addApplication(string uri, string name, string exec)
{
g_bookmark_file_add_application(gBookmarkFile, Str.toStringz(uri), Str.toStringz(name), Str.toStringz(exec));
}
/**
* Adds @group to the list of groups to which the bookmark for @uri
* belongs to.
*
* If no bookmark for @uri is found then it is created.
*
* Params:
* uri = a valid URI
* group = the group name to be added
*
* Since: 2.12
*/
public void addGroup(string uri, string group)
{
g_bookmark_file_add_group(gBookmarkFile, Str.toStringz(uri), Str.toStringz(group));
}
/**
* Frees a #GBookmarkFile.
*
* Since: 2.12
*/
public void free()
{
g_bookmark_file_free(gBookmarkFile);
ownedRef = false;
}
/**
* Gets the time the bookmark for @uri was added to @bookmark
*
* In the event the URI cannot be found, -1 is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
*
* Returns: a timestamp
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public uint getAdded(string uri)
{
GError* err = null;
auto p = g_bookmark_file_get_added(gBookmarkFile, Str.toStringz(uri), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Gets the registration informations of @app_name for the bookmark for
* @uri. See g_bookmark_file_set_app_info() for more informations about
* the returned data.
*
* The string returned in @app_exec must be freed.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
* event that no application with name @app_name has registered a bookmark
* for @uri, %FALSE is returned and error is set to
* #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
* the command line fails, an error of the #G_SHELL_ERROR domain is
* set and %FALSE is returned.
*
* Params:
* uri = a valid URI
* name = an application's name
* exec = return location for the command line of the application, or %NULL
* count = return location for the registration count, or %NULL
* stamp = return location for the last registration time, or %NULL
*
* Returns: %TRUE on success.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool getAppInfo(string uri, string name, out string exec, out uint count, out uint stamp)
{
char* outexec = null;
GError* err = null;
auto p = g_bookmark_file_get_app_info(gBookmarkFile, Str.toStringz(uri), Str.toStringz(name), &outexec, &count, &stamp, &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
exec = Str.toString(outexec);
return p;
}
/**
* Retrieves the names of the applications that have registered the
* bookmark for @uri.
*
* In the event the URI cannot be found, %NULL is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
*
* Returns: a newly allocated %NULL-terminated array of strings.
* Use g_strfreev() to free it.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public string[] getApplications(string uri)
{
size_t length;
GError* err = null;
auto retStr = g_bookmark_file_get_applications(gBookmarkFile, Str.toStringz(uri), &length, &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeStringArray(retStr);
return Str.toStringArray(retStr, length);
}
/**
* Retrieves the description of the bookmark for @uri.
*
* In the event the URI cannot be found, %NULL is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
*
* Returns: a newly allocated string or %NULL if the specified
* URI cannot be found.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public string getDescription(string uri)
{
GError* err = null;
auto retStr = g_bookmark_file_get_description(gBookmarkFile, Str.toStringz(uri), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Retrieves the list of group names of the bookmark for @uri.
*
* In the event the URI cannot be found, %NULL is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* The returned array is %NULL terminated, so @length may optionally
* be %NULL.
*
* Params:
* uri = a valid URI
*
* Returns: a newly allocated %NULL-terminated array of group names.
* Use g_strfreev() to free it.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public string[] getGroups(string uri)
{
size_t length;
GError* err = null;
auto retStr = g_bookmark_file_get_groups(gBookmarkFile, Str.toStringz(uri), &length, &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeStringArray(retStr);
return Str.toStringArray(retStr, length);
}
/**
* Gets the icon of the bookmark for @uri.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
* href = return location for the icon's location or %NULL
* mimeType = return location for the icon's MIME type or %NULL
*
* Returns: %TRUE if the icon for the bookmark for the URI was found.
* You should free the returned strings.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool getIcon(string uri, out string href, out string mimeType)
{
char* outhref = null;
char* outmimeType = null;
GError* err = null;
auto p = g_bookmark_file_get_icon(gBookmarkFile, Str.toStringz(uri), &outhref, &outmimeType, &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
href = Str.toString(outhref);
mimeType = Str.toString(outmimeType);
return p;
}
/**
* Gets whether the private flag of the bookmark for @uri is set.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
* event that the private flag cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
*
* Params:
* uri = a valid URI
*
* Returns: %TRUE if the private flag is set, %FALSE otherwise.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool getIsPrivate(string uri)
{
GError* err = null;
auto p = g_bookmark_file_get_is_private(gBookmarkFile, Str.toStringz(uri), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Retrieves the MIME type of the resource pointed by @uri.
*
* In the event the URI cannot be found, %NULL is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the
* event that the MIME type cannot be found, %NULL is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
*
* Params:
* uri = a valid URI
*
* Returns: a newly allocated string or %NULL if the specified
* URI cannot be found.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public string getMimeType(string uri)
{
GError* err = null;
auto retStr = g_bookmark_file_get_mime_type(gBookmarkFile, Str.toStringz(uri), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Gets the time when the bookmark for @uri was last modified.
*
* In the event the URI cannot be found, -1 is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
*
* Returns: a timestamp
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public uint getModified(string uri)
{
GError* err = null;
auto p = g_bookmark_file_get_modified(gBookmarkFile, Str.toStringz(uri), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Gets the number of bookmarks inside @bookmark.
*
* Returns: the number of bookmarks
*
* Since: 2.12
*/
public int getSize()
{
return g_bookmark_file_get_size(gBookmarkFile);
}
/**
* Returns the title of the bookmark for @uri.
*
* If @uri is %NULL, the title of @bookmark is returned.
*
* In the event the URI cannot be found, %NULL is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI or %NULL
*
* Returns: a newly allocated string or %NULL if the specified
* URI cannot be found.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public string getTitle(string uri)
{
GError* err = null;
auto retStr = g_bookmark_file_get_title(gBookmarkFile, Str.toStringz(uri), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Returns all URIs of the bookmarks in the bookmark file @bookmark.
* The array of returned URIs will be %NULL-terminated, so @length may
* optionally be %NULL.
*
* Returns: a newly allocated %NULL-terminated array of strings.
* Use g_strfreev() to free it.
*
* Since: 2.12
*/
public string[] getUris()
{
size_t length;
auto retStr = g_bookmark_file_get_uris(gBookmarkFile, &length);
scope(exit) Str.freeStringArray(retStr);
return Str.toStringArray(retStr, length);
}
/**
* Gets the time the bookmark for @uri was last visited.
*
* In the event the URI cannot be found, -1 is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
*
* Returns: a timestamp.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public uint getVisited(string uri)
{
GError* err = null;
auto p = g_bookmark_file_get_visited(gBookmarkFile, Str.toStringz(uri), &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Checks whether the bookmark for @uri inside @bookmark has been
* registered by application @name.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
* name = the name of the application
*
* Returns: %TRUE if the application @name was found
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool hasApplication(string uri, string name)
{
GError* err = null;
auto p = g_bookmark_file_has_application(gBookmarkFile, Str.toStringz(uri), Str.toStringz(name), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Checks whether @group appears in the list of groups to which
* the bookmark for @uri belongs to.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* uri = a valid URI
* group = the group name to be searched
*
* Returns: %TRUE if @group was found.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool hasGroup(string uri, string group)
{
GError* err = null;
auto p = g_bookmark_file_has_group(gBookmarkFile, Str.toStringz(uri), Str.toStringz(group), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Looks whether the desktop bookmark has an item with its URI set to @uri.
*
* Params:
* uri = a valid URI
*
* Returns: %TRUE if @uri is inside @bookmark, %FALSE otherwise
*
* Since: 2.12
*/
public bool hasItem(string uri)
{
return g_bookmark_file_has_item(gBookmarkFile, Str.toStringz(uri)) != 0;
}
/**
* Loads a bookmark file from memory into an empty #GBookmarkFile
* structure. If the object cannot be created then @error is set to a
* #GBookmarkFileError.
*
* Params:
* data = desktop bookmarks loaded in memory
* length = the length of @data in bytes
*
* Returns: %TRUE if a desktop bookmark could be loaded.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool loadFromData(string data, size_t length)
{
GError* err = null;
auto p = g_bookmark_file_load_from_data(gBookmarkFile, Str.toStringz(data), length, &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* This function looks for a desktop bookmark file named @file in the
* paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
* loads the file into @bookmark and returns the file's full path in
* @full_path. If the file could not be loaded then an %error is
* set to either a #GFileError or #GBookmarkFileError.
*
* Params:
* file = a relative path to a filename to open and parse
* fullPath = return location for a string
* containing the full path of the file, or %NULL
*
* Returns: %TRUE if a key file could be loaded, %FALSE otherwise
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool loadFromDataDirs(string file, out string fullPath)
{
char* outfullPath = null;
GError* err = null;
auto p = g_bookmark_file_load_from_data_dirs(gBookmarkFile, Str.toStringz(file), &outfullPath, &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
fullPath = Str.toString(outfullPath);
return p;
}
/**
* Loads a desktop bookmark file into an empty #GBookmarkFile structure.
* If the file could not be loaded then @error is set to either a #GFileError
* or #GBookmarkFileError.
*
* Params:
* filename = the path of a filename to load, in the
* GLib file name encoding
*
* Returns: %TRUE if a desktop bookmark file could be loaded
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool loadFromFile(string filename)
{
GError* err = null;
auto p = g_bookmark_file_load_from_file(gBookmarkFile, Str.toStringz(filename), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Changes the URI of a bookmark item from @old_uri to @new_uri. Any
* existing bookmark for @new_uri will be overwritten. If @new_uri is
* %NULL, then the bookmark is removed.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
*
* Params:
* oldUri = a valid URI
* newUri = a valid URI, or %NULL
*
* Returns: %TRUE if the URI was successfully changed
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool moveItem(string oldUri, string newUri)
{
GError* err = null;
auto p = g_bookmark_file_move_item(gBookmarkFile, Str.toStringz(oldUri), Str.toStringz(newUri), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Removes application registered with @name from the list of applications
* that have registered a bookmark for @uri inside @bookmark.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
* In the event that no application with name @app_name has registered
* a bookmark for @uri, %FALSE is returned and error is set to
* #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
*
* Params:
* uri = a valid URI
* name = the name of the application
*
* Returns: %TRUE if the application was successfully removed.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool removeApplication(string uri, string name)
{
GError* err = null;
auto p = g_bookmark_file_remove_application(gBookmarkFile, Str.toStringz(uri), Str.toStringz(name), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Removes @group from the list of groups to which the bookmark
* for @uri belongs to.
*
* In the event the URI cannot be found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
* In the event no group was defined, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
*
* Params:
* uri = a valid URI
* group = the group name to be removed
*
* Returns: %TRUE if @group was successfully removed.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool removeGroup(string uri, string group)
{
GError* err = null;
auto p = g_bookmark_file_remove_group(gBookmarkFile, Str.toStringz(uri), Str.toStringz(group), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Removes the bookmark for @uri from the bookmark file @bookmark.
*
* Params:
* uri = a valid URI
*
* Returns: %TRUE if the bookmark was removed successfully.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool removeItem(string uri)
{
GError* err = null;
auto p = g_bookmark_file_remove_item(gBookmarkFile, Str.toStringz(uri), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Sets the time the bookmark for @uri was added into @bookmark.
*
* If no bookmark for @uri is found then it is created.
*
* Params:
* uri = a valid URI
* added = a timestamp or -1 to use the current time
*
* Since: 2.12
*/
public void setAdded(string uri, uint added)
{
g_bookmark_file_set_added(gBookmarkFile, Str.toStringz(uri), added);
}
/**
* Sets the meta-data of application @name inside the list of
* applications that have registered a bookmark for @uri inside
* @bookmark.
*
* You should rarely use this function; use g_bookmark_file_add_application()
* and g_bookmark_file_remove_application() instead.
*
* @name can be any UTF-8 encoded string used to identify an
* application.
* @exec can have one of these two modifiers: "\%f", which will
* be expanded as the local file name retrieved from the bookmark's
* URI; "\%u", which will be expanded as the bookmark's URI.
* The expansion is done automatically when retrieving the stored
* command line using the g_bookmark_file_get_app_info() function.
* @count is the number of times the application has registered the
* bookmark; if is < 0, the current registration count will be increased
* by one, if is 0, the application with @name will be removed from
* the list of registered applications.
* @stamp is the Unix time of the last registration; if it is -1, the
* current time will be used.
*
* If you try to remove an application by setting its registration count to
* zero, and no bookmark for @uri is found, %FALSE is returned and
* @error is set to #G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
* in the event that no application @name has registered a bookmark
* for @uri, %FALSE is returned and error is set to
* #G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark
* for @uri is found, one is created.
*
* Params:
* uri = a valid URI
* name = an application's name
* exec = an application's command line
* count = the number of registrations done for this application
* stamp = the time of the last registration for this application
*
* Returns: %TRUE if the application's meta-data was successfully
* changed.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool setAppInfo(string uri, string name, string exec, int count, uint stamp)
{
GError* err = null;
auto p = g_bookmark_file_set_app_info(gBookmarkFile, Str.toStringz(uri), Str.toStringz(name), Str.toStringz(exec), count, stamp, &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/**
* Sets @description as the description of the bookmark for @uri.
*
* If @uri is %NULL, the description of @bookmark is set.
*
* If a bookmark for @uri cannot be found then it is created.
*
* Params:
* uri = a valid URI or %NULL
* description = a string
*
* Since: 2.12
*/
public void setDescription(string uri, string description)
{
g_bookmark_file_set_description(gBookmarkFile, Str.toStringz(uri), Str.toStringz(description));
}
/**
* Sets a list of group names for the item with URI @uri. Each previously
* set group name list is removed.
*
* If @uri cannot be found then an item for it is created.
*
* Params:
* uri = an item's URI
* groups = an array of group names, or %NULL to remove all groups
*
* Since: 2.12
*/
public void setGroups(string uri, string[] groups)
{
g_bookmark_file_set_groups(gBookmarkFile, Str.toStringz(uri), Str.toStringzArray(groups), cast(size_t)groups.length);
}
/**
* Sets the icon for the bookmark for @uri. If @href is %NULL, unsets
* the currently set icon. @href can either be a full URL for the icon
* file or the icon name following the Icon Naming specification.
*
* If no bookmark for @uri is found one is created.
*
* Params:
* uri = a valid URI
* href = the URI of the icon for the bookmark, or %NULL
* mimeType = the MIME type of the icon for the bookmark
*
* Since: 2.12
*/
public void setIcon(string uri, string href, string mimeType)
{
g_bookmark_file_set_icon(gBookmarkFile, Str.toStringz(uri), Str.toStringz(href), Str.toStringz(mimeType));
}
/**
* Sets the private flag of the bookmark for @uri.
*
* If a bookmark for @uri cannot be found then it is created.
*
* Params:
* uri = a valid URI
* isPrivate = %TRUE if the bookmark should be marked as private
*
* Since: 2.12
*/
public void setIsPrivate(string uri, bool isPrivate)
{
g_bookmark_file_set_is_private(gBookmarkFile, Str.toStringz(uri), isPrivate);
}
/**
* Sets @mime_type as the MIME type of the bookmark for @uri.
*
* If a bookmark for @uri cannot be found then it is created.
*
* Params:
* uri = a valid URI
* mimeType = a MIME type
*
* Since: 2.12
*/
public void setMimeType(string uri, string mimeType)
{
g_bookmark_file_set_mime_type(gBookmarkFile, Str.toStringz(uri), Str.toStringz(mimeType));
}
/**
* Sets the last time the bookmark for @uri was last modified.
*
* If no bookmark for @uri is found then it is created.
*
* The "modified" time should only be set when the bookmark's meta-data
* was actually changed. Every function of #GBookmarkFile that
* modifies a bookmark also changes the modification time, except for
* g_bookmark_file_set_visited().
*
* Params:
* uri = a valid URI
* modified = a timestamp or -1 to use the current time
*
* Since: 2.12
*/
public void setModified(string uri, uint modified)
{
g_bookmark_file_set_modified(gBookmarkFile, Str.toStringz(uri), modified);
}
/**
* Sets @title as the title of the bookmark for @uri inside the
* bookmark file @bookmark.
*
* If @uri is %NULL, the title of @bookmark is set.
*
* If a bookmark for @uri cannot be found then it is created.
*
* Params:
* uri = a valid URI or %NULL
* title = a UTF-8 encoded string
*
* Since: 2.12
*/
public void setTitle(string uri, string title)
{
g_bookmark_file_set_title(gBookmarkFile, Str.toStringz(uri), Str.toStringz(title));
}
/**
* Sets the time the bookmark for @uri was last visited.
*
* If no bookmark for @uri is found then it is created.
*
* The "visited" time should only be set if the bookmark was launched,
* either using the command line retrieved by g_bookmark_file_get_app_info()
* or by the default application for the bookmark's MIME type, retrieved
* using g_bookmark_file_get_mime_type(). Changing the "visited" time
* does not affect the "modified" time.
*
* Params:
* uri = a valid URI
* visited = a timestamp or -1 to use the current time
*
* Since: 2.12
*/
public void setVisited(string uri, uint visited)
{
g_bookmark_file_set_visited(gBookmarkFile, Str.toStringz(uri), visited);
}
/**
* This function outputs @bookmark as a string.
*
* Params:
* length = return location for the length of the returned string, or %NULL
*
* Returns: a newly allocated string holding
* the contents of the #GBookmarkFile
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public string toData(out size_t length)
{
GError* err = null;
auto retStr = g_bookmark_file_to_data(gBookmarkFile, &length, &err);
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* This function outputs @bookmark into a file. The write process is
* guaranteed to be atomic by using g_file_set_contents() internally.
*
* Params:
* filename = path of the output file
*
* Returns: %TRUE if the file was successfully written.
*
* Since: 2.12
*
* Throws: GException on failure.
*/
public bool toFile(string filename)
{
GError* err = null;
auto p = g_bookmark_file_to_file(gBookmarkFile, Str.toStringz(filename), &err) != 0;
if (err !is null)
{
throw new GException( new ErrorG(err) );
}
return p;
}
/** */
public static GQuark errorQuark()
{
return g_bookmark_file_error_quark();
}
/**
* Creates a new empty #GBookmarkFile object.
*
* Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
* or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
* file.
*
* Returns: an empty #GBookmarkFile
*
* Since: 2.12
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this()
{
auto p = g_bookmark_file_new();
if(p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GBookmarkFile*) p);
}
}
|