Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
RecentInfo
-struct contains private data only, and should
be accessed using the provided API.
RecentInfo
constains all the meta-data
associated with an entry in the recently used files list.
Since: 2.10
Synopsis
- newtype RecentInfo = RecentInfo (ManagedPtr RecentInfo)
- noRecentInfo :: Maybe RecentInfo
- recentInfoCreateAppInfo :: (HasCallStack, MonadIO m) => RecentInfo -> Maybe Text -> m (Maybe AppInfo)
- recentInfoExists :: (HasCallStack, MonadIO m) => RecentInfo -> m Bool
- recentInfoGetAdded :: (HasCallStack, MonadIO m) => RecentInfo -> m CLong
- recentInfoGetAge :: (HasCallStack, MonadIO m) => RecentInfo -> m Int32
- recentInfoGetApplicationInfo :: (HasCallStack, MonadIO m) => RecentInfo -> Text -> m (Bool, Text, Word32, CLong)
- recentInfoGetApplications :: (HasCallStack, MonadIO m) => RecentInfo -> m ([Text], Word64)
- recentInfoGetDescription :: (HasCallStack, MonadIO m) => RecentInfo -> m Text
- recentInfoGetDisplayName :: (HasCallStack, MonadIO m) => RecentInfo -> m Text
- recentInfoGetGicon :: (HasCallStack, MonadIO m) => RecentInfo -> m (Maybe Icon)
- recentInfoGetGroups :: (HasCallStack, MonadIO m) => RecentInfo -> m ([Text], Word64)
- recentInfoGetIcon :: (HasCallStack, MonadIO m) => RecentInfo -> Int32 -> m (Maybe Pixbuf)
- recentInfoGetMimeType :: (HasCallStack, MonadIO m) => RecentInfo -> m Text
- recentInfoGetModified :: (HasCallStack, MonadIO m) => RecentInfo -> m CLong
- recentInfoGetPrivateHint :: (HasCallStack, MonadIO m) => RecentInfo -> m Bool
- recentInfoGetShortName :: (HasCallStack, MonadIO m) => RecentInfo -> m Text
- recentInfoGetUri :: (HasCallStack, MonadIO m) => RecentInfo -> m Text
- recentInfoGetUriDisplay :: (HasCallStack, MonadIO m) => RecentInfo -> m (Maybe Text)
- recentInfoGetVisited :: (HasCallStack, MonadIO m) => RecentInfo -> m CLong
- recentInfoHasApplication :: (HasCallStack, MonadIO m) => RecentInfo -> Text -> m Bool
- recentInfoHasGroup :: (HasCallStack, MonadIO m) => RecentInfo -> Text -> m Bool
- recentInfoIsLocal :: (HasCallStack, MonadIO m) => RecentInfo -> m Bool
- recentInfoLastApplication :: (HasCallStack, MonadIO m) => RecentInfo -> m Text
- recentInfoMatch :: (HasCallStack, MonadIO m) => RecentInfo -> RecentInfo -> m Bool
- recentInfoRef :: (HasCallStack, MonadIO m) => RecentInfo -> m RecentInfo
- recentInfoUnref :: (HasCallStack, MonadIO m) => RecentInfo -> m ()
Exported types
newtype RecentInfo Source #
Memory-managed wrapper type.
Instances
BoxedObject RecentInfo Source # | |
Defined in GI.Gtk.Structs.RecentInfo boxedType :: RecentInfo -> IO GType # |
noRecentInfo :: Maybe RecentInfo Source #
A convenience alias for Nothing
:: Maybe
RecentInfo
.
Methods
createAppInfo
recentInfoCreateAppInfo Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> Maybe Text |
|
-> m (Maybe AppInfo) | Returns: the newly created |
Creates a AppInfo
for the specified RecentInfo
exists
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Bool | Returns: |
Checks whether the resource pointed by info
still exists.
At the moment this check is done only on resources pointing
to local files.
Since: 2.10
getAdded
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m CLong | Returns: the number of seconds elapsed from system’s Epoch when the resource was added to the list, or -1 on failure. |
Gets the timestamp (seconds from system’s Epoch) when the resource was added to the recently used resources list.
Since: 2.10
getAge
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Int32 | Returns: a positive integer containing the number of days elapsed since the time this resource was last modified |
Gets the number of days elapsed since the last update
of the resource pointed by info
.
Since: 2.10
getApplicationInfo
recentInfoGetApplicationInfo Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> Text |
|
-> m (Bool, Text, Word32, CLong) | Returns: |
Gets the data regarding the application that has registered the resource
pointed by info
.
If the command line contains any escape characters defined inside the storage specification, they will be expanded.
Since: 2.10
getApplications
recentInfoGetApplications Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m ([Text], Word64) | Returns:
a newly allocated |
Retrieves the list of applications that have registered this resource.
Since: 2.10
getDescription
recentInfoGetDescription Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Text | Returns: the description of the resource. The returned string is owned by the recent manager, and should not be freed. |
Gets the (short) description of the resource.
Since: 2.10
getDisplayName
recentInfoGetDisplayName Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Text | Returns: the display name of the resource. The returned string is owned by the recent manager, and should not be freed. |
Gets the name of the resource. If none has been defined, the basename of the resource is obtained.
Since: 2.10
getGicon
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m (Maybe Icon) | Returns: a |
Retrieves the icon associated to the resource MIME type.
Since: 2.22
getGroups
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m ([Text], Word64) | Returns:
a newly allocated |
getIcon
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> Int32 |
|
-> m (Maybe Pixbuf) | Returns: a |
Retrieves the icon of size size
associated to the resource MIME type.
Since: 2.10
getMimeType
recentInfoGetMimeType Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Text | Returns: the MIME type of the resource. The returned string is owned by the recent manager, and should not be freed. |
Gets the MIME type of the resource.
Since: 2.10
getModified
recentInfoGetModified Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m CLong | Returns: the number of seconds elapsed from system’s Epoch when the resource was last modified, or -1 on failure. |
Gets the timestamp (seconds from system’s Epoch) when the meta-data for the resource was last modified.
Since: 2.10
getPrivateHint
recentInfoGetPrivateHint Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Bool | Returns: |
Gets the value of the “private” flag. Resources in the recently used
list that have this flag set to True
should only be displayed by the
applications that have registered them.
Since: 2.10
getShortName
recentInfoGetShortName Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Text | Returns: A newly-allocated string in UTF-8 encoding
free it with |
Computes a valid UTF-8 string that can be used as the name of the item in a menu or list. For example, calling this function on an item that refers to “file:///foo/bar.txt” will yield “bar.txt”.
Since: 2.10
getUri
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Text | Returns: the URI of the resource. The returned string is owned by the recent manager, and should not be freed. |
Gets the URI of the resource.
Since: 2.10
getUriDisplay
recentInfoGetUriDisplay Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m (Maybe Text) | Returns: a newly allocated UTF-8 string containing the
resource’s URI or |
Gets a displayable version of the resource’s URI. If the resource
is local, it returns a local path; if the resource is not local,
it returns the UTF-8 encoded content of recentInfoGetUri
.
Since: 2.10
getVisited
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m CLong | Returns: the number of seconds elapsed from system’s Epoch when the resource was last visited, or -1 on failure. |
Gets the timestamp (seconds from system’s Epoch) when the meta-data for the resource was last visited.
Since: 2.10
hasApplication
recentInfoHasApplication Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> Text |
|
-> m Bool | Returns: |
Checks whether an application registered this resource using appName
.
Since: 2.10
hasGroup
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> Text |
|
-> m Bool | Returns: |
Checks whether groupName
appears inside the groups
registered for the recently used item info
.
Since: 2.10
isLocal
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Bool | Returns: |
Checks whether the resource is local or not by looking at the scheme of its URI.
Since: 2.10
lastApplication
recentInfoLastApplication Source #
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m Text | Returns: an application name. Use |
Gets the name of the last application that have registered the
recently used resource represented by info
.
Since: 2.10
match
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> RecentInfo |
|
-> m Bool | Returns: |
Checks whether two RecentInfo
-struct point to the same
resource.
Since: 2.10
ref
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m RecentInfo | Returns: the recent info object with its reference count increased by one |
Increases the reference count of recentInfo
by one.
Since: 2.10
unref
:: (HasCallStack, MonadIO m) | |
=> RecentInfo |
|
-> m () |
Decreases the reference count of info
by one. If the reference
count reaches zero, info
is deallocated, and the memory freed.
Since: 2.10