| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GLib.Structs.BookmarkFile
Contents
- Exported types
- Methods
- addApplication
- addGroup
- copy
- errorQuark
- free
- getAdded
- getAddedDateTime
- getAppInfo
- getApplicationInfo
- getApplications
- getDescription
- getGroups
- getIcon
- getIsPrivate
- getMimeType
- getModified
- getModifiedDateTime
- getSize
- getTitle
- getUris
- getVisited
- getVisitedDateTime
- hasApplication
- hasGroup
- hasItem
- loadFromData
- loadFromDataDirs
- loadFromFile
- moveItem
- new
- removeApplication
- removeGroup
- removeItem
- setAdded
- setAddedDateTime
- setAppInfo
- setApplicationInfo
- setDescription
- setGroups
- setIcon
- setIsPrivate
- setMimeType
- setModified
- setModifiedDateTime
- setTitle
- setVisited
- setVisitedDateTime
- toData
- toFile
Description
GBookmarkFile 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.xbel
A 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
bookmarkFileAddApplication or bookmarkFileSetApplicationInfo.
If a bookmark has no applications then it won't be dumped when creating
the on disk representation, using bookmarkFileToData or
bookmarkFileToFile.
Since: 2.12
Synopsis
- newtype BookmarkFile = BookmarkFile (ManagedPtr BookmarkFile)
- type family ResolveBookmarkFileMethod (t :: Symbol) o where ...
- data BookmarkFileAddApplicationMethodInfo
- bookmarkFileAddApplication :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe Text -> Maybe Text -> m ()
- data BookmarkFileAddGroupMethodInfo
- bookmarkFileAddGroup :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- data BookmarkFileCopyMethodInfo
- bookmarkFileCopy :: (HasCallStack, MonadIO m) => BookmarkFile -> m BookmarkFile
- bookmarkFileErrorQuark :: (HasCallStack, MonadIO m) => m Word32
- data BookmarkFileFreeMethodInfo
- bookmarkFileFree :: (HasCallStack, MonadIO m) => BookmarkFile -> m ()
- data BookmarkFileGetAddedMethodInfo
- bookmarkFileGetAdded :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m CTime
- data BookmarkFileGetAddedDateTimeMethodInfo
- bookmarkFileGetAddedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m DateTime
- data BookmarkFileGetAppInfoMethodInfo
- bookmarkFileGetAppInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m (Text, Word32, CTime)
- data BookmarkFileGetApplicationInfoMethodInfo
- bookmarkFileGetApplicationInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m (Text, Word32, DateTime)
- data BookmarkFileGetApplicationsMethodInfo
- bookmarkFileGetApplications :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m [Text]
- data BookmarkFileGetDescriptionMethodInfo
- bookmarkFileGetDescription :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m Text
- data BookmarkFileGetGroupsMethodInfo
- bookmarkFileGetGroups :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m [Text]
- data BookmarkFileGetIconMethodInfo
- bookmarkFileGetIcon :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m (Text, Text)
- data BookmarkFileGetIsPrivateMethodInfo
- bookmarkFileGetIsPrivate :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m ()
- data BookmarkFileGetMimeTypeMethodInfo
- bookmarkFileGetMimeType :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m Text
- data BookmarkFileGetModifiedMethodInfo
- bookmarkFileGetModified :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m CTime
- data BookmarkFileGetModifiedDateTimeMethodInfo
- bookmarkFileGetModifiedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m DateTime
- data BookmarkFileGetSizeMethodInfo
- bookmarkFileGetSize :: (HasCallStack, MonadIO m) => BookmarkFile -> m Int32
- data BookmarkFileGetTitleMethodInfo
- bookmarkFileGetTitle :: (HasCallStack, MonadIO m) => BookmarkFile -> Maybe Text -> m Text
- data BookmarkFileGetUrisMethodInfo
- bookmarkFileGetUris :: (HasCallStack, MonadIO m) => BookmarkFile -> m [Text]
- data BookmarkFileGetVisitedMethodInfo
- bookmarkFileGetVisited :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m CTime
- data BookmarkFileGetVisitedDateTimeMethodInfo
- bookmarkFileGetVisitedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m DateTime
- data BookmarkFileHasApplicationMethodInfo
- bookmarkFileHasApplication :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- data BookmarkFileHasGroupMethodInfo
- bookmarkFileHasGroup :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- data BookmarkFileHasItemMethodInfo
- bookmarkFileHasItem :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m Bool
- data BookmarkFileLoadFromDataMethodInfo
- bookmarkFileLoadFromData :: (HasCallStack, MonadIO m) => BookmarkFile -> ByteString -> m ()
- data BookmarkFileLoadFromDataDirsMethodInfo
- bookmarkFileLoadFromDataDirs :: (HasCallStack, MonadIO m) => BookmarkFile -> [Char] -> m (Maybe [Char])
- data BookmarkFileLoadFromFileMethodInfo
- bookmarkFileLoadFromFile :: (HasCallStack, MonadIO m) => BookmarkFile -> [Char] -> m ()
- data BookmarkFileMoveItemMethodInfo
- bookmarkFileMoveItem :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe Text -> m ()
- bookmarkFileNew :: (HasCallStack, MonadIO m) => m BookmarkFile
- data BookmarkFileRemoveApplicationMethodInfo
- bookmarkFileRemoveApplication :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- data BookmarkFileRemoveGroupMethodInfo
- bookmarkFileRemoveGroup :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- data BookmarkFileRemoveItemMethodInfo
- bookmarkFileRemoveItem :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m ()
- data BookmarkFileSetAddedMethodInfo
- bookmarkFileSetAdded :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> CTime -> m ()
- data BookmarkFileSetAddedDateTimeMethodInfo
- bookmarkFileSetAddedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> DateTime -> m ()
- data BookmarkFileSetAppInfoMethodInfo
- bookmarkFileSetAppInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> Text -> Int32 -> CTime -> m ()
- data BookmarkFileSetApplicationInfoMethodInfo
- bookmarkFileSetApplicationInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> Text -> Int32 -> Maybe DateTime -> m ()
- data BookmarkFileSetDescriptionMethodInfo
- bookmarkFileSetDescription :: (HasCallStack, MonadIO m) => BookmarkFile -> Maybe Text -> Text -> m ()
- data BookmarkFileSetGroupsMethodInfo
- bookmarkFileSetGroups :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe [Text] -> m ()
- data BookmarkFileSetIconMethodInfo
- bookmarkFileSetIcon :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe Text -> Text -> m ()
- data BookmarkFileSetIsPrivateMethodInfo
- bookmarkFileSetIsPrivate :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Bool -> m ()
- data BookmarkFileSetMimeTypeMethodInfo
- bookmarkFileSetMimeType :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- data BookmarkFileSetModifiedMethodInfo
- bookmarkFileSetModified :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> CTime -> m ()
- data BookmarkFileSetModifiedDateTimeMethodInfo
- bookmarkFileSetModifiedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> DateTime -> m ()
- data BookmarkFileSetTitleMethodInfo
- bookmarkFileSetTitle :: (HasCallStack, MonadIO m) => BookmarkFile -> Maybe Text -> Text -> m ()
- data BookmarkFileSetVisitedMethodInfo
- bookmarkFileSetVisited :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> CTime -> m ()
- data BookmarkFileSetVisitedDateTimeMethodInfo
- bookmarkFileSetVisitedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> DateTime -> m ()
- data BookmarkFileToDataMethodInfo
- bookmarkFileToData :: (HasCallStack, MonadIO m) => BookmarkFile -> m ByteString
- data BookmarkFileToFileMethodInfo
- bookmarkFileToFile :: (HasCallStack, MonadIO m) => BookmarkFile -> [Char] -> m ()
Exported types
newtype BookmarkFile Source #
Memory-managed wrapper type.
Constructors
| BookmarkFile (ManagedPtr BookmarkFile) |
Instances
Methods
Click to display all available methods, including inherited ones
Methods
addApplication, addGroup, copy, free, hasApplication, hasGroup, hasItem, loadFromData, loadFromDataDirs, loadFromFile, moveItem, removeApplication, removeGroup, removeItem, toData, toFile.
Getters
getAdded, getAddedDateTime, getAppInfo, getApplicationInfo, getApplications, getDescription, getGroups, getIcon, getIsPrivate, getMimeType, getModified, getModifiedDateTime, getSize, getTitle, getUris, getVisited, getVisitedDateTime.
Setters
setAdded, setAddedDateTime, setAppInfo, setApplicationInfo, setDescription, setGroups, setIcon, setIsPrivate, setMimeType, setModified, setModifiedDateTime, setTitle, setVisited, setVisitedDateTime.
type family ResolveBookmarkFileMethod (t :: Symbol) o where ... Source #
Equations
addApplication
data BookmarkFileAddApplicationMethodInfo Source #
Instances
| (signature ~ (Text -> Maybe Text -> Maybe Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileAddApplicationMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileAddApplicationMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileAddApplication Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Maybe Text |
|
| -> Maybe Text |
|
| -> m () |
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 BookmarkFile 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 Nothing, the name of the application will be the
same returned by getApplicationName; if exec is Nothing, the
command line will be a composition of the program name as
returned by getPrgname 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.
Since: 2.12
addGroup
data BookmarkFileAddGroupMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileAddGroupMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileAddGroupMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m () |
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.
Since: 2.12
copy
data BookmarkFileCopyMethodInfo Source #
Instances
| (signature ~ m BookmarkFile, MonadIO m) => OverloadedMethod BookmarkFileCopyMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileCopyMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> m BookmarkFile | Returns: the copy of |
Deeply copies a bookmark BookmarkFile object to a new one.
Since: 2.76
errorQuark
bookmarkFileErrorQuark :: (HasCallStack, MonadIO m) => m Word32 Source #
No description available in the introspection data.
free
data BookmarkFileFreeMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod BookmarkFileFreeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileFreeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> m () |
Frees a BookmarkFile.
Since: 2.12
getAdded
data BookmarkFileGetAddedMethodInfo Source #
Instances
| (signature ~ (Text -> m CTime), MonadIO m) => OverloadedMethod BookmarkFileGetAddedMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetAddedMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m CTime | Returns: a timestamp (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetAddedDateTime instead, astime_t is deprecated due to the year 2038 problem.
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 BookmarkFileErrorUriNotFound.
Since: 2.12
getAddedDateTime
data BookmarkFileGetAddedDateTimeMethodInfo Source #
Instances
| (signature ~ (Text -> m DateTime), MonadIO m) => OverloadedMethod BookmarkFileGetAddedDateTimeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetAddedDateTimeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetAddedDateTime Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m DateTime |
Gets the time the bookmark for uri was added to bookmark
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.66
getAppInfo
data BookmarkFileGetAppInfoMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m (Text, Word32, CTime)), MonadIO m) => OverloadedMethod BookmarkFileGetAppInfoMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetAppInfoMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetAppInfo Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m (Text, Word32, CTime) | (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetApplicationInfo instead, astime_t is deprecated due to the year 2038 problem.
Gets the registration information of appName for the bookmark for
uri. See bookmarkFileSetApplicationInfo for more information about
the returned data.
The string returned in appExec must be freed.
In the event the URI cannot be found, False is returned and
error is set to BookmarkFileErrorUriNotFound. In the
event that no application with name appName has registered a bookmark
for uri, False is returned and error is set to
BookmarkFileErrorAppNotRegistered. In the event that unquoting
the command line fails, an error of the G_SHELL_ERROR domain is
set and False is returned.
Since: 2.12
getApplicationInfo
data BookmarkFileGetApplicationInfoMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m (Text, Word32, DateTime)), MonadIO m) => OverloadedMethod BookmarkFileGetApplicationInfoMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetApplicationInfoMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetApplicationInfo Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m (Text, Word32, DateTime) | (Can throw |
Gets the registration information of appName for the bookmark for
uri. See bookmarkFileSetApplicationInfo for more information about
the returned data.
The string returned in appExec must be freed.
In the event the URI cannot be found, False is returned and
error is set to BookmarkFileErrorUriNotFound. In the
event that no application with name appName has registered a bookmark
for uri, False is returned and error is set to
BookmarkFileErrorAppNotRegistered. In the event that unquoting
the command line fails, an error of the G_SHELL_ERROR domain is
set and False is returned.
Since: 2.66
getApplications
data BookmarkFileGetApplicationsMethodInfo Source #
Instances
| (signature ~ (Text -> m [Text]), MonadIO m) => OverloadedMethod BookmarkFileGetApplicationsMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetApplicationsMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetApplications Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m [Text] | Returns: a newly allocated |
Retrieves the names of the applications that have registered the
bookmark for uri.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.12
getDescription
data BookmarkFileGetDescriptionMethodInfo Source #
Instances
| (signature ~ (Text -> m Text), MonadIO m) => OverloadedMethod BookmarkFileGetDescriptionMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetDescriptionMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetDescription Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m Text | Returns: a newly allocated string or |
Retrieves the description of the bookmark for uri.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.12
getGroups
data BookmarkFileGetGroupsMethodInfo Source #
Instances
| (signature ~ (Text -> m [Text]), MonadIO m) => OverloadedMethod BookmarkFileGetGroupsMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetGroupsMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetGroups Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m [Text] | Returns: a newly allocated |
Retrieves the list of group names of the bookmark for uri.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
The returned array is Nothing terminated, so length may optionally
be Nothing.
Since: 2.12
getIcon
data BookmarkFileGetIconMethodInfo Source #
Instances
| (signature ~ (Text -> m (Text, Text)), MonadIO m) => OverloadedMethod BookmarkFileGetIconMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetIconMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m (Text, Text) | (Can throw |
Gets the icon of the bookmark for uri.
In the event the URI cannot be found, False is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.12
getIsPrivate
data BookmarkFileGetIsPrivateMethodInfo Source #
Instances
| (signature ~ (Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileGetIsPrivateMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetIsPrivateMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetIsPrivate Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m () | (Can throw |
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 BookmarkFileErrorUriNotFound. In the
event that the private flag cannot be found, False is returned and
error is set to BookmarkFileErrorInvalidValue.
Since: 2.12
getMimeType
data BookmarkFileGetMimeTypeMethodInfo Source #
Instances
| (signature ~ (Text -> m Text), MonadIO m) => OverloadedMethod BookmarkFileGetMimeTypeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetMimeTypeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetMimeType Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m Text | Returns: a newly allocated string or |
Retrieves the MIME type of the resource pointed by uri.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound. In the
event that the MIME type cannot be found, Nothing is returned and
error is set to BookmarkFileErrorInvalidValue.
Since: 2.12
getModified
data BookmarkFileGetModifiedMethodInfo Source #
Instances
| (signature ~ (Text -> m CTime), MonadIO m) => OverloadedMethod BookmarkFileGetModifiedMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetModifiedMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetModified Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m CTime | Returns: a timestamp (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetModifiedDateTime instead, astime_t is deprecated due to the year 2038 problem.
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 BookmarkFileErrorUriNotFound.
Since: 2.12
getModifiedDateTime
data BookmarkFileGetModifiedDateTimeMethodInfo Source #
Instances
| (signature ~ (Text -> m DateTime), MonadIO m) => OverloadedMethod BookmarkFileGetModifiedDateTimeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetModifiedDateTimeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetModifiedDateTime Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m DateTime |
Gets the time when the bookmark for uri was last modified.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.66
getSize
data BookmarkFileGetSizeMethodInfo Source #
Instances
| (signature ~ m Int32, MonadIO m) => OverloadedMethod BookmarkFileGetSizeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetSizeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> m Int32 | Returns: the number of bookmarks |
Gets the number of bookmarks inside bookmark.
Since: 2.12
getTitle
data BookmarkFileGetTitleMethodInfo Source #
Instances
| (signature ~ (Maybe Text -> m Text), MonadIO m) => OverloadedMethod BookmarkFileGetTitleMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetTitleMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Maybe Text |
|
| -> m Text | Returns: a newly allocated string or |
Returns the title of the bookmark for uri.
If uri is Nothing, the title of bookmark is returned.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.12
getUris
data BookmarkFileGetUrisMethodInfo Source #
Instances
| (signature ~ m [Text], MonadIO m) => OverloadedMethod BookmarkFileGetUrisMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetUrisMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> m [Text] | Returns: a newly allocated |
getVisited
data BookmarkFileGetVisitedMethodInfo Source #
Instances
| (signature ~ (Text -> m CTime), MonadIO m) => OverloadedMethod BookmarkFileGetVisitedMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetVisitedMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetVisited Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m CTime | Returns: a timestamp. (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetVisitedDateTime instead, astime_t is deprecated due to the year 2038 problem.
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 BookmarkFileErrorUriNotFound.
Since: 2.12
getVisitedDateTime
data BookmarkFileGetVisitedDateTimeMethodInfo Source #
Instances
| (signature ~ (Text -> m DateTime), MonadIO m) => OverloadedMethod BookmarkFileGetVisitedDateTimeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileGetVisitedDateTimeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileGetVisitedDateTime Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m DateTime |
Gets the time the bookmark for uri was last visited.
In the event the URI cannot be found, Nothing is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.66
hasApplication
data BookmarkFileHasApplicationMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileHasApplicationMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileHasApplicationMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileHasApplication Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m () | (Can throw |
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 BookmarkFileErrorUriNotFound.
Since: 2.12
hasGroup
data BookmarkFileHasGroupMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileHasGroupMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileHasGroupMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m () | (Can throw |
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 BookmarkFileErrorUriNotFound.
Since: 2.12
hasItem
data BookmarkFileHasItemMethodInfo Source #
Instances
| (signature ~ (Text -> m Bool), MonadIO m) => OverloadedMethod BookmarkFileHasItemMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileHasItemMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m Bool |
Looks whether the desktop bookmark has an item with its URI set to uri.
Since: 2.12
loadFromData
data BookmarkFileLoadFromDataMethodInfo Source #
Instances
| (signature ~ (ByteString -> m ()), MonadIO m) => OverloadedMethod BookmarkFileLoadFromDataMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileLoadFromDataMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileLoadFromData Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> ByteString |
|
| -> m () | (Can throw |
Loads a bookmark file from memory into an empty BookmarkFile
structure. If the object cannot be created then error is set to a
BookmarkFileError.
Since: 2.12
loadFromDataDirs
data BookmarkFileLoadFromDataDirsMethodInfo Source #
Instances
| (signature ~ ([Char] -> m (Maybe [Char])), MonadIO m) => OverloadedMethod BookmarkFileLoadFromDataDirsMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileLoadFromDataDirsMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileLoadFromDataDirs Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> [Char] |
|
| -> m (Maybe [Char]) | (Can throw |
This function looks for a desktop bookmark file named file in the
paths returned from getUserDataDir and getSystemDataDirs,
loads the file into bookmark and returns the file's full path in
fullPath. If the file could not be loaded then error is
set to either a FileError or BookmarkFileError.
Since: 2.12
loadFromFile
data BookmarkFileLoadFromFileMethodInfo Source #
Instances
| (signature ~ ([Char] -> m ()), MonadIO m) => OverloadedMethod BookmarkFileLoadFromFileMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileLoadFromFileMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileLoadFromFile Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> [Char] |
|
| -> m () | (Can throw |
Loads a desktop bookmark file into an empty BookmarkFile structure.
If the file could not be loaded then error is set to either a FileError
or BookmarkFileError.
Since: 2.12
moveItem
data BookmarkFileMoveItemMethodInfo Source #
Instances
| (signature ~ (Text -> Maybe Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileMoveItemMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileMoveItemMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Maybe Text |
|
| -> m () | (Can throw |
Changes the URI of a bookmark item from oldUri to newUri. Any
existing bookmark for newUri will be overwritten. If newUri is
Nothing, then the bookmark is removed.
In the event the URI cannot be found, False is returned and
error is set to BookmarkFileErrorUriNotFound.
Since: 2.12
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m BookmarkFile | Returns: an empty |
Creates a new empty BookmarkFile object.
Use bookmarkFileLoadFromFile, bookmarkFileLoadFromData
or bookmarkFileLoadFromDataDirs to read an existing bookmark
file.
Since: 2.12
removeApplication
data BookmarkFileRemoveApplicationMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileRemoveApplicationMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileRemoveApplicationMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileRemoveApplication Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m () | (Can throw |
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 BookmarkFileErrorUriNotFound.
In the event that no application with name appName has registered
a bookmark for uri, False is returned and error is set to
BookmarkFileErrorAppNotRegistered.
Since: 2.12
removeGroup
data BookmarkFileRemoveGroupMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileRemoveGroupMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileRemoveGroupMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileRemoveGroup Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m () | (Can throw |
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 BookmarkFileErrorUriNotFound.
In the event no group was defined, False is returned and
error is set to BookmarkFileErrorInvalidValue.
Since: 2.12
removeItem
data BookmarkFileRemoveItemMethodInfo Source #
Instances
| (signature ~ (Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileRemoveItemMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileRemoveItemMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileRemoveItem Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> m () | (Can throw |
Removes the bookmark for uri from the bookmark file bookmark.
Since: 2.12
setAdded
data BookmarkFileSetAddedMethodInfo Source #
Instances
| (signature ~ (Text -> CTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetAddedMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetAddedMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> CTime |
|
| -> m () |
Deprecated: (Since version 2.66)Use bookmarkFileSetAddedDateTime instead, astime_t is deprecated due to the year 2038 problem.
Sets the time the bookmark for uri was added into bookmark.
If no bookmark for uri is found then it is created.
Since: 2.12
setAddedDateTime
data BookmarkFileSetAddedDateTimeMethodInfo Source #
Instances
| (signature ~ (Text -> DateTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetAddedDateTimeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetAddedDateTimeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetAddedDateTime Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> DateTime |
|
| -> m () |
Sets the time the bookmark for uri was added into bookmark.
If no bookmark for uri is found then it is created.
Since: 2.66
setAppInfo
data BookmarkFileSetAppInfoMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> Text -> Int32 -> CTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetAppInfoMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetAppInfoMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetAppInfo Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> Text |
|
| -> Int32 |
|
| -> CTime |
|
| -> m () | (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileSetApplicationInfo instead, astime_t is deprecated due to the year 2038 problem.
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 bookmarkFileAddApplication
and bookmarkFileRemoveApplication 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 bookmarkFileGetApplicationInfo 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 BookmarkFileErrorUriNotFound; similarly,
in the event that no application name has registered a bookmark
for uri, False is returned and error is set to
BookmarkFileErrorAppNotRegistered. Otherwise, if no bookmark
for uri is found, one is created.
Since: 2.12
setApplicationInfo
data BookmarkFileSetApplicationInfoMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> Text -> Int32 -> Maybe DateTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetApplicationInfoMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetApplicationInfoMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetApplicationInfo Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> Text |
|
| -> Int32 |
|
| -> Maybe DateTime |
|
| -> m () | (Can throw |
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 bookmarkFileAddApplication
and bookmarkFileRemoveApplication 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 bookmarkFileGetApplicationInfo 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 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 BookmarkFileErrorUriNotFound; similarly,
in the event that no application name has registered a bookmark
for uri, False is returned and error is set to
BookmarkFileErrorAppNotRegistered. Otherwise, if no bookmark
for uri is found, one is created.
Since: 2.66
setDescription
data BookmarkFileSetDescriptionMethodInfo Source #
Instances
| (signature ~ (Maybe Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetDescriptionMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetDescriptionMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetDescription Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Maybe Text |
|
| -> Text |
|
| -> m () |
Sets description as the description of the bookmark for uri.
If uri is Nothing, the description of bookmark is set.
If a bookmark for uri cannot be found then it is created.
Since: 2.12
setGroups
data BookmarkFileSetGroupsMethodInfo Source #
Instances
| (signature ~ (Text -> Maybe [Text] -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetGroupsMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetGroupsMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetGroups Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Maybe [Text] |
|
| -> m () |
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.
Since: 2.12
setIcon
data BookmarkFileSetIconMethodInfo Source #
Instances
| (signature ~ (Text -> Maybe Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetIconMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetIconMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Maybe Text |
|
| -> Text |
|
| -> m () |
Sets the icon for the bookmark for uri. If href is Nothing, 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.
Since: 2.12
setIsPrivate
data BookmarkFileSetIsPrivateMethodInfo Source #
Instances
| (signature ~ (Text -> Bool -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetIsPrivateMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetIsPrivateMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetIsPrivate Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Bool |
|
| -> m () |
Sets the private flag of the bookmark for uri.
If a bookmark for uri cannot be found then it is created.
Since: 2.12
setMimeType
data BookmarkFileSetMimeTypeMethodInfo Source #
Instances
| (signature ~ (Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetMimeTypeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetMimeTypeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetMimeType Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> Text |
|
| -> m () |
Sets mimeType as the MIME type of the bookmark for uri.
If a bookmark for uri cannot be found then it is created.
Since: 2.12
setModified
data BookmarkFileSetModifiedMethodInfo Source #
Instances
| (signature ~ (Text -> CTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetModifiedMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetModifiedMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetModified Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> CTime |
|
| -> m () |
Deprecated: (Since version 2.66)Use bookmarkFileSetModifiedDateTime instead, astime_t is deprecated due to the year 2038 problem.
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 BookmarkFile that
modifies a bookmark also changes the modification time, except for
bookmarkFileSetVisitedDateTime.
Since: 2.12
setModifiedDateTime
data BookmarkFileSetModifiedDateTimeMethodInfo Source #
Instances
| (signature ~ (Text -> DateTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetModifiedDateTimeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetModifiedDateTimeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetModifiedDateTime Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> DateTime |
|
| -> m () |
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 BookmarkFile that
modifies a bookmark also changes the modification time, except for
bookmarkFileSetVisitedDateTime.
Since: 2.66
setTitle
data BookmarkFileSetTitleMethodInfo Source #
Instances
| (signature ~ (Maybe Text -> Text -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetTitleMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetTitleMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Maybe Text |
|
| -> Text |
|
| -> m () |
Sets title as the title of the bookmark for uri inside the
bookmark file bookmark.
If uri is Nothing, the title of bookmark is set.
If a bookmark for uri cannot be found then it is created.
Since: 2.12
setVisited
data BookmarkFileSetVisitedMethodInfo Source #
Instances
| (signature ~ (Text -> CTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetVisitedMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetVisitedMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetVisited Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> CTime |
|
| -> m () |
Deprecated: (Since version 2.66)Use bookmarkFileSetVisitedDateTime instead, astime_t is deprecated due to the year 2038 problem.
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 bookmarkFileGetApplicationInfo
or by the default application for the bookmark's MIME type, retrieved
using bookmarkFileGetMimeType. Changing the "visited" time
does not affect the "modified" time.
Since: 2.12
setVisitedDateTime
data BookmarkFileSetVisitedDateTimeMethodInfo Source #
Instances
| (signature ~ (Text -> DateTime -> m ()), MonadIO m) => OverloadedMethod BookmarkFileSetVisitedDateTimeMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileSetVisitedDateTimeMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
bookmarkFileSetVisitedDateTime Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> Text |
|
| -> DateTime |
|
| -> m () |
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 bookmarkFileGetApplicationInfo
or by the default application for the bookmark's MIME type, retrieved
using bookmarkFileGetMimeType. Changing the "visited" time
does not affect the "modified" time.
Since: 2.66
toData
data BookmarkFileToDataMethodInfo Source #
Instances
| (signature ~ m ByteString, MonadIO m) => OverloadedMethod BookmarkFileToDataMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileToDataMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> m ByteString | Returns:
a newly allocated string holding the contents of the |
This function outputs bookmark as a string.
Since: 2.12
toFile
data BookmarkFileToFileMethodInfo Source #
Instances
| (signature ~ ([Char] -> m ()), MonadIO m) => OverloadedMethod BookmarkFileToFileMethodInfo BookmarkFile signature Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods overloadedMethod :: BookmarkFile -> signature # | |
| OverloadedMethodInfo BookmarkFileToFileMethodInfo BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => BookmarkFile |
|
| -> [Char] |
|
| -> m () | (Can throw |
This function outputs bookmark into a file. The write process is
guaranteed to be atomic by using fileSetContents internally.
Since: 2.12