glib.bookmark_file
Module for [BookmarkFile] class
Types 2
[glib.bookmark_file.BookmarkFile] lets you parse, edit or create files containing bookmarks.
Bookmarks refer to a URI, along with some meta-data about the resource pointed by the URI like its MIME type, the application that is registering the bookmark and the icon that should be used to represent the bookmark. The data is stored using the
Desktop Bookmark Specification.The syntax of the bookmark files is described in detail inside the Desktop Bookmark Specification, here is a quick summary: bookmark files use a sub-class of the XML Bookmark Exchange Language specification, consisting of valid UTF-8 encoded XML, under the <xbel> root element; each bookmark is stored inside a <bookmark> element, using its URI: no relative paths can be used inside a bookmark file. The bookmark may have a user defined title and description, to be used instead of the URI. Under the <metadata> element, with its owner attribute set to http://freedesktop.org, is stored the meta-data about a resource pointed by its URI. The meta-data consists of the resource's MIME type; the applications that have registered a bookmark; the groups to which a bookmark belongs to; a visibility flag, used to set the bookmark as "private" to the applications and groups that has it registered; the URI and MIME type of an icon, to be used when displaying the bookmark inside a GUI.
Here is an example of a bookmark file:
bookmarks.xbelA bookmark file might contain more than one bookmark; each bookmark is accessed through its URI.
The important caveat of bookmark files is that when you add a new bookmark you must also add the application that is registering it, using [glib.bookmark_file.BookmarkFile.addApplication] or [glib.bookmark_file.BookmarkFile.setApplicationInfo]. If a bookmark has no applications then it won't be dumped when creating the on disk representation, using [glib.bookmark_file.BookmarkFile.toData] or [glib.bookmark_file.BookmarkFile.toFile].
BookmarkFile self()Returns `this`, for use in `with` statements.void addApplication(string uri, string name = null, string exec = null)Adds the application with name and exec to the list of applications that have registered a bookmark for uri into bookmark.void addGroup(string uri, string group)Adds group to the list of groups to which the bookmark for uri belongs to.glib.bookmark_file.BookmarkFile copy()Deeply copies a bookmark #GBookmarkFile object to a new one. Returns: the copy of bookmark. Use gbookmarkfree() when finished using it.long getAdded(string uri)Gets the time the bookmark for uri was added to bookmarkglib.date_time.DateTime getAddedDateTime(string uri)Gets the time the bookmark for uri was added to bookmarkbool getAppInfo(string uri, string name, out string exec, out uint count, out long stamp)Gets the registration information of appname for the bookmark for uri. See [glib.bookmarkfile.BookmarkFile.setApplicationInfo] for more information about the returned data.bool getApplicationInfo(string uri, string name, out string exec, out uint count, out glib.date_time.DateTime stamp)Gets the registration information of appname for the bookmark for uri. See [glib.bookmarkfile.BookmarkFile.setApplicationInfo] for more information about the returned data.string[] getApplications(string uri)Retrieves the names of the applications that have registered the bookmark for uri.string getDescription(string uri)Retrieves the description of the bookmark for uri.string[] getGroups(string uri)Retrieves the list of group names of the bookmark for uri.bool getIcon(string uri, out string href, out string mimeType)Gets the icon of the bookmark for uri.bool getIsPrivate(string uri)Gets whether the private flag of the bookmark for uri is set.string getMimeType(string uri)Retrieves the MIME type of the resource pointed by uri.long getModified(string uri)Gets the time when the bookmark for uri was last modified.glib.date_time.DateTime getModifiedDateTime(string uri)Gets the time when the bookmark for uri was last modified.int getSize()Gets the number of bookmarks inside bookmark. Returns: the number of bookmarksstring getTitle(string uri = null)Returns the title of the bookmark for uri.string[] getUris()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 arr...long getVisited(string uri)Gets the time the bookmark for uri was last visited.glib.date_time.DateTime getVisitedDateTime(string uri)Gets the time the bookmark for uri was last visited.bool hasApplication(string uri, string name)Checks whether the bookmark for uri inside bookmark has been registered by application name.bool hasGroup(string uri, string group)Checks whether group appears in the list of groups to which the bookmark for uri belongs to.bool hasItem(string uri)Looks whether the desktop bookmark has an item with its URI set to uri.bool loadFromData(ubyte[] data)Loads a bookmark file from memory into an empty #GBookmarkFile structure. If the object cannot be created then error is set to a #GBookmarkFileError.bool loadFromDataDirs(string file, out string fullPath)This function looks for a desktop bookmark file named file in the paths returned from [glib.global.getUserDataDir] and [glib.global.getSystemDataDirs], loads the file into bookmark and returns the ...bool loadFromFile(string filename)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.bool moveItem(string oldUri, string newUri = null)Changes the URI of a bookmark item from olduri to newuri. Any existing bookmark for newuri will be overwritten. If newuri is null, then the bookmark is removed.bool removeApplication(string uri, string name)Removes application registered with name from the list of applications that have registered a bookmark for uri inside bookmark.bool removeGroup(string uri, string group)Removes group from the list of groups to which the bookmark for uri belongs to.bool removeItem(string uri)Removes the bookmark for uri from the bookmark file bookmark.void setAdded(string uri, long added)Sets the time the bookmark for uri was added into bookmark.void setAddedDateTime(string uri, glib.date_time.DateTime added)Sets the time the bookmark for uri was added into bookmark.bool setAppInfo(string uri, string name, string exec, int count, long stamp)Sets the meta-data of application name inside the list of applications that have registered a bookmark for uri inside bookmark.bool setApplicationInfo(string uri, string name, string exec, int count, glib.date_time.DateTime stamp = null)Sets the meta-data of application name inside the list of applications that have registered a bookmark for uri inside bookmark.void setDescription(string uri, string description)Sets description as the description of the bookmark for uri.void setGroups(string uri, string[] groups = null)Sets a list of group names for the item with URI uri. Each previously set group name list is removed.void setIcon(string uri, string href, string mimeType)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.void setIsPrivate(string uri, bool isPrivate)Sets the private flag of the bookmark for uri.void setMimeType(string uri, string mimeType)Sets mime_type as the MIME type of the bookmark for uri.void setModified(string uri, long modified)Sets the last time the bookmark for uri was last modified.void setModifiedDateTime(string uri, glib.date_time.DateTime modified)Sets the last time the bookmark for uri was last modified.void setTitle(string uri, string title)Sets title as the title of the bookmark for uri inside the bookmark file bookmark.void setVisited(string uri, long visited)Sets the time the bookmark for uri was last visited.void setVisitedDateTime(string uri, glib.date_time.DateTime visited)Sets the time the bookmark for uri was last visited.ubyte[] toData()This function outputs bookmark as a string. Returns: a newly allocated string holding the contents of the #GBookmarkFile Throws: [BookmarkFileException]bool toFile(string filename)This function outputs bookmark into a file. The write process is guaranteed to be atomic by using [glib.global.fileSetContents] internally.