Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Structs.RecentInfo

Contents

Exported types
Methods

Description

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.

Constructors

RecentInfo (ManagedPtr RecentInfo)

Instances

BoxedObject RecentInfo Source #
Instance details Defined in GI.Gtk.Structs.RecentInfo Methods boxedType :: RecentInfo -> IO GType #

noRecentInfo :: Maybe RecentInfo Source #

A convenience alias for Nothing :: Maybe RecentInfo.

Methods

createAppInfo

recentInfoCreateAppInfo Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> Maybe Text	`appName`: the name of the application that should be mapped to a `AppInfo`; if `Nothing` is used then the default application for the MIME type is used
-> m (Maybe AppInfo)	Returns: the newly created `AppInfo`, or `Nothing`. In case of error, `error` will be set either with a `GTK_RECENT_MANAGER_ERROR` or a `G_IO_ERROR` (Can throw `GError`)

Creates a AppInfo for the specified RecentInfo

exists

recentInfoExists Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m Bool	Returns: `True` if the resource exists

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

recentInfoGetAdded Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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

recentInfoGetAge Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> Text	`appName`: the name of the application that has registered this item
-> m (Bool, Text, Word32, CLong)	Returns: `True` if an application with `appName` has registered this resource inside the recently used list, or `False` otherwise. The `appExec` string is owned by the `RecentInfo` and should not be modified or freed

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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m ([Text], Word64)	Returns: a newly allocated `Nothing`-terminated array of strings. Use `strfreev` to free it.

Retrieves the list of applications that have registered this resource.

Since: 2.10

getDescription

recentInfoGetDescription Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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

recentInfoGetGicon Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m (Maybe Icon)	Returns: a `Icon` containing the icon, or `Nothing`. Use `objectUnref` when finished using the icon

Retrieves the icon associated to the resource MIME type.

Since: 2.22

getGroups

recentInfoGetGroups Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m ([Text], Word64)	Returns: a newly allocated `Nothing` terminated array of strings. Use `strfreev` to free it.

Returns all groups registered for the recently used item info. The array of returned group names will be Nothing terminated, so length might optionally be Nothing.

Since: 2.10

getIcon

recentInfoGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> Int32	`size`: the size of the icon in pixels
-> m (Maybe Pixbuf)	Returns: a `Pixbuf` containing the icon, or `Nothing`. Use `objectUnref` when finished using the icon.

Retrieves the icon of size size associated to the resource MIME type.

Since: 2.10

getMimeType

recentInfoGetMimeType Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m Bool	Returns: `True` if the private flag was found, `False` otherwise

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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: an `RecentInfo`
-> m Text	Returns: A newly-allocated string in UTF-8 encoding free it with `free`

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

recentInfoGetUri Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m (Maybe Text)	Returns: a newly allocated UTF-8 string containing the resource’s URI or `Nothing`. Use `free` when done using it.

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

recentInfoGetVisited Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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 #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> Text	`appName`: a string containing an application name
-> m Bool	Returns: `True` if an application with name `appName` was found, `False` otherwise

Checks whether an application registered this resource using appName.

Since: 2.10

hasGroup

recentInfoHasGroup Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> Text	`groupName`: name of a group
-> m Bool	Returns: `True` if the group was found

Checks whether groupName appears inside the groups registered for the recently used item info.

Since: 2.10

isLocal

recentInfoIsLocal Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m Bool	Returns: `True` if the resource is local

Checks whether the resource is local or not by looking at the scheme of its URI.

Since: 2.10

lastApplication

recentInfoLastApplication Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `RecentInfo`
-> m Text	Returns: an application name. Use `free` to free it.

Gets the name of the last application that have registered the recently used resource represented by info.

Since: 2.10

match

recentInfoMatch Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`infoA`: a `RecentInfo`
-> RecentInfo	`infoB`: a `RecentInfo`
-> m Bool	Returns: `True` if both `RecentInfo`-struct point to the same resource, `False` otherwise

Checks whether two RecentInfo-struct point to the same resource.

Since: 2.10

ref

recentInfoRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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

recentInfoUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> RecentInfo	`info`: a `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