Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- 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
An opaque data structure representing a set of bookmarks.
Synopsis
- newtype BookmarkFile = BookmarkFile (ManagedPtr BookmarkFile)
- bookmarkFileAddApplication :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe Text -> Maybe Text -> m ()
- bookmarkFileAddGroup :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- bookmarkFileCopy :: (HasCallStack, MonadIO m) => BookmarkFile -> m BookmarkFile
- bookmarkFileErrorQuark :: (HasCallStack, MonadIO m) => m Word32
- bookmarkFileFree :: (HasCallStack, MonadIO m) => BookmarkFile -> m ()
- bookmarkFileGetAdded :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m CLong
- bookmarkFileGetAddedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m DateTime
- bookmarkFileGetAppInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m (Text, Word32, CLong)
- bookmarkFileGetApplicationInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m (Text, Word32, DateTime)
- bookmarkFileGetApplications :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m [Text]
- bookmarkFileGetDescription :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m Text
- bookmarkFileGetGroups :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m [Text]
- bookmarkFileGetIcon :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m (Text, Text)
- bookmarkFileGetIsPrivate :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m ()
- bookmarkFileGetMimeType :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m Text
- bookmarkFileGetModified :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m CLong
- bookmarkFileGetModifiedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m DateTime
- bookmarkFileGetSize :: (HasCallStack, MonadIO m) => BookmarkFile -> m Int32
- bookmarkFileGetTitle :: (HasCallStack, MonadIO m) => BookmarkFile -> Maybe Text -> m Text
- bookmarkFileGetUris :: (HasCallStack, MonadIO m) => BookmarkFile -> m [Text]
- bookmarkFileGetVisited :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m CLong
- bookmarkFileGetVisitedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m DateTime
- bookmarkFileHasApplication :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- bookmarkFileHasGroup :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- bookmarkFileHasItem :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m Bool
- bookmarkFileLoadFromData :: (HasCallStack, MonadIO m) => BookmarkFile -> ByteString -> m ()
- bookmarkFileLoadFromDataDirs :: (HasCallStack, MonadIO m) => BookmarkFile -> [Char] -> m (Maybe [Char])
- bookmarkFileLoadFromFile :: (HasCallStack, MonadIO m) => BookmarkFile -> [Char] -> m ()
- bookmarkFileMoveItem :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe Text -> m ()
- bookmarkFileNew :: (HasCallStack, MonadIO m) => m BookmarkFile
- bookmarkFileRemoveApplication :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- bookmarkFileRemoveGroup :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- bookmarkFileRemoveItem :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> m ()
- bookmarkFileSetAdded :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> CLong -> m ()
- bookmarkFileSetAddedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> DateTime -> m ()
- bookmarkFileSetAppInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> Text -> Int32 -> CLong -> m ()
- bookmarkFileSetApplicationInfo :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> Text -> Int32 -> Maybe DateTime -> m ()
- bookmarkFileSetDescription :: (HasCallStack, MonadIO m) => BookmarkFile -> Maybe Text -> Text -> m ()
- bookmarkFileSetGroups :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe [Text] -> m ()
- bookmarkFileSetIcon :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Maybe Text -> Text -> m ()
- bookmarkFileSetIsPrivate :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Bool -> m ()
- bookmarkFileSetMimeType :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> Text -> m ()
- bookmarkFileSetModified :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> CLong -> m ()
- bookmarkFileSetModifiedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> DateTime -> m ()
- bookmarkFileSetTitle :: (HasCallStack, MonadIO m) => BookmarkFile -> Maybe Text -> Text -> m ()
- bookmarkFileSetVisited :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> CLong -> m ()
- bookmarkFileSetVisitedDateTime :: (HasCallStack, MonadIO m) => BookmarkFile -> Text -> DateTime -> m ()
- bookmarkFileToData :: (HasCallStack, MonadIO m) => BookmarkFile -> m ByteString
- bookmarkFileToFile :: (HasCallStack, MonadIO m) => BookmarkFile -> [Char] -> m ()
Exported types
newtype BookmarkFile Source #
Memory-managed wrapper type.
BookmarkFile (ManagedPtr BookmarkFile) |
Instances
Eq BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile (==) :: BookmarkFile -> BookmarkFile -> Bool # (/=) :: BookmarkFile -> BookmarkFile -> Bool # | |
GBoxed BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile | |
ManagedPtrNewtype BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile toManagedPtr :: BookmarkFile -> ManagedPtr BookmarkFile | |
TypedObject BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile | |
HasParentTypes BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile | |
IsGValue (Maybe BookmarkFile) Source # | Convert |
Defined in GI.GLib.Structs.BookmarkFile gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe BookmarkFile -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe BookmarkFile) | |
type ParentTypes BookmarkFile Source # | |
Defined in GI.GLib.Structs.BookmarkFile |
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.
addApplication
bookmarkFileAddApplication Source #
:: (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
:: (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
:: (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
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> m () |
Frees a BookmarkFile
.
Since: 2.12
getAdded
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> m CLong | Returns: a timestamp (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetAddedDateTime
instead, as time_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
bookmarkFileGetAddedDateTime Source #
:: (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
bookmarkFileGetAppInfo Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> Text |
|
-> m (Text, Word32, CLong) | (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetApplicationInfo
instead, as time_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
bookmarkFileGetApplicationInfo Source #
:: (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
bookmarkFileGetApplications Source #
:: (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
bookmarkFileGetDescription Source #
:: (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
bookmarkFileGetGroups Source #
:: (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
:: (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
bookmarkFileGetIsPrivate Source #
:: (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
bookmarkFileGetMimeType Source #
:: (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
bookmarkFileGetModified Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> m CLong | Returns: a timestamp (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetModifiedDateTime
instead, as time_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
bookmarkFileGetModifiedDateTime Source #
:: (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
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> m Int32 | Returns: the number of bookmarks |
Gets the number of bookmarks inside bookmark
.
Since: 2.12
getTitle
:: (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
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> m [Text] | Returns: a newly allocated |
getVisited
bookmarkFileGetVisited Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> m CLong | Returns: a timestamp. (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileGetVisitedDateTime
instead, as time_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
bookmarkFileGetVisitedDateTime Source #
:: (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
bookmarkFileHasApplication Source #
:: (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
:: (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
:: (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
bookmarkFileLoadFromData Source #
:: (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
bookmarkFileLoadFromDataDirs Source #
:: (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
bookmarkFileLoadFromFile Source #
:: (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
:: (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
:: (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
bookmarkFileRemoveApplication Source #
:: (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
bookmarkFileRemoveGroup Source #
:: (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
bookmarkFileRemoveItem Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> m () | (Can throw |
Removes the bookmark for uri
from the bookmark file bookmark
.
Since: 2.12
setAdded
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> CLong |
|
-> m () |
Deprecated: (Since version 2.66)Use bookmarkFileSetAddedDateTime
instead, as time_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
bookmarkFileSetAddedDateTime Source #
:: (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
bookmarkFileSetAppInfo Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> Text |
|
-> Text |
|
-> Int32 |
|
-> CLong |
|
-> m () | (Can throw |
Deprecated: (Since version 2.66)Use bookmarkFileSetApplicationInfo
instead, as time_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
bookmarkFileSetApplicationInfo Source #
:: (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
bookmarkFileSetDescription Source #
:: (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
bookmarkFileSetGroups Source #
:: (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
:: (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
bookmarkFileSetIsPrivate Source #
:: (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
bookmarkFileSetMimeType Source #
:: (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
bookmarkFileSetModified Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> CLong |
|
-> m () |
Deprecated: (Since version 2.66)Use bookmarkFileSetModifiedDateTime
instead, as time_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
bookmarkFileSetModifiedDateTime Source #
:: (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
:: (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
bookmarkFileSetVisited Source #
:: (HasCallStack, MonadIO m) | |
=> BookmarkFile |
|
-> Text |
|
-> CLong |
|
-> m () |
Deprecated: (Since version 2.66)Use bookmarkFileSetVisitedDateTime
instead, as time_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
bookmarkFileSetVisitedDateTime Source #
:: (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
:: (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
:: (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