GI.Gtk.Structs.RecentInfo

GtkRecentInfo contains the metadata associated with an item in the recently used files list.

Exported types

newtype RecentInfo

Memory-managed wrapper type.

Constructors

RecentInfo (ManagedPtr RecentInfo)

Instances

Eq RecentInfo

Defined in GI.Gtk.Structs.RecentInfo

Methods

(==) :: RecentInfo -> RecentInfo -> Bool

(/=) :: RecentInfo -> RecentInfo -> Bool

GBoxed RecentInfo

Defined in GI.Gtk.Structs.RecentInfo

ManagedPtrNewtype RecentInfo

Defined in GI.Gtk.Structs.RecentInfo

Methods

toManagedPtr :: RecentInfo -> ManagedPtr RecentInfo

TypedObject RecentInfo

Defined in GI.Gtk.Structs.RecentInfo

Methods

glibType :: IO GType

HasParentTypes RecentInfo

Defined in GI.Gtk.Structs.RecentInfo

IsGValue (Maybe RecentInfo)

Convert RecentInfo to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Structs.RecentInfo

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe RecentInfo -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe RecentInfo)

type ParentTypes RecentInfo

Defined in GI.Gtk.Structs.RecentInfo

type ParentTypes RecentInfo = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

createAppInfo, exists, hasApplication, hasGroup, isLocal, lastApplication, match, ref, unref.

Getters

getAdded, getAge, getApplicationInfo, getApplications, getDescription, getDisplayName, getGicon, getGroups, getMimeType, getModified, getPrivateHint, getShortName, getUri, getUriDisplay, getVisited.

Setters

None.

createAppInfo

recentInfoCreateAppInfo

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> Maybe Text

appName: the name of the application that should be mapped to a GAppInfo; if Nothing is used then the default application for the MIME type is used

-> m (Maybe AppInfo)

Returns: the newly created GAppInfo (Can throw GError)

Creates a GAppInfo for the specified GtkRecentInfo

In case of error, error will be set either with a GTK_RECENT_MANAGER_ERROR or a G_IO_ERROR

exists

recentInfoExists

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getAdded

recentInfoGetAdded

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m DateTime

Returns: a GDateTime for the time when the resource was added

Gets the time when the resource was added to the recently used resources list.

getAge

recentInfoGetAge

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getApplicationInfo

recentInfoGetApplicationInfo

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> Text

appName: the name of the application that has registered this item

-> m (Bool, Text, Word32, DateTime)

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 GtkRecentInfo 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.

getApplications

recentInfoGetApplications

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m ([Text], CSize)

Returns: a newly allocated Nothing-terminated array of strings. Use strfreev to free it.

Retrieves the list of applications that have registered this resource.

getDescription

recentInfoGetDescription

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getDisplayName

recentInfoGetDisplayName

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getGicon

recentInfoGetGicon

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m (Maybe Icon)

Returns: a GIcon containing the icon

Retrieves the icon associated to the resource MIME type.

getGroups

recentInfoGetGroups

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m ([Text], CSize)

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.

getMimeType

recentInfoGetMimeType

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getModified

recentInfoGetModified

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m DateTime

Returns: a GDateTime for the time when the resource was last modified

Gets the time when the meta-data for the resource was last modified.

getPrivateHint

recentInfoGetPrivateHint

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getShortName

recentInfoGetShortName

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: an GtkRecentInfo

-> 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”.

getUri

recentInfoGetUri

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a tkRecentInfo

-> 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.

getUriDisplay

recentInfoGetUriDisplay

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

getVisited

recentInfoGetVisited

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m DateTime

Returns: a GDateTime for the time when the resource was last visited

Gets the time when the meta-data for the resource was last visited.

hasApplication

recentInfoHasApplication

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

hasGroup

recentInfoHasGroup

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

isLocal

recentInfoIsLocal

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

lastApplication

recentInfoLastApplication

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> 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.

match

recentInfoMatch

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

infoA: a GtkRecentInfo

-> RecentInfo

infoB: a GtkRecentInfo

-> m Bool

Returns: True if both GtkRecentInfo point to the same resource, False otherwise

Checks whether two GtkRecentInfo point to the same resource.

ref

recentInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m RecentInfo

Returns: the recent info object with its reference count increased by one

Increases the reference count of recentInfo by one.

unref

recentInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> RecentInfo

info: a GtkRecentInfo

-> m ()

Decreases the reference count of info by one.

If the reference count reaches zero, info is deallocated, and the memory freed.