gi-gtk3-3.0.44: Gtk 3.x bindings

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.Gtk.Structs.RecentData

Contents

- Exported types
- Methods
- Properties
  - appExec
  - appName
  - description
  - displayName
  - groups
  - isPrivate
  - mimeType

Description

Meta-data to be passed to `recentManagerAddFull` when registering a recently used resource.

Synopsis

- newtype RecentData = RecentData (ManagedPtr RecentData)
- newZeroRecentData :: MonadIO m => m RecentData
- clearRecentDataAppExec :: MonadIO m => RecentData -> m ()
- getRecentDataAppExec :: MonadIO m => RecentData -> m (Maybe Text)
- setRecentDataAppExec :: MonadIO m => RecentData -> CString -> m ()
- clearRecentDataAppName :: MonadIO m => RecentData -> m ()
- getRecentDataAppName :: MonadIO m => RecentData -> m (Maybe Text)
- setRecentDataAppName :: MonadIO m => RecentData -> CString -> m ()
- clearRecentDataDescription :: MonadIO m => RecentData -> m ()
- getRecentDataDescription :: MonadIO m => RecentData -> m (Maybe Text)
- setRecentDataDescription :: MonadIO m => RecentData -> CString -> m ()
- clearRecentDataDisplayName :: MonadIO m => RecentData -> m ()
- getRecentDataDisplayName :: MonadIO m => RecentData -> m (Maybe Text)
- setRecentDataDisplayName :: MonadIO m => RecentData -> CString -> m ()
- clearRecentDataGroups :: MonadIO m => RecentData -> m ()
- getRecentDataGroups :: MonadIO m => RecentData -> m (Maybe [Text])
- setRecentDataGroups :: MonadIO m => RecentData -> Ptr CString -> m ()
- getRecentDataIsPrivate :: MonadIO m => RecentData -> m Bool
- setRecentDataIsPrivate :: MonadIO m => RecentData -> Bool -> m ()
- clearRecentDataMimeType :: MonadIO m => RecentData -> m ()
- getRecentDataMimeType :: MonadIO m => RecentData -> m (Maybe Text)
- setRecentDataMimeType :: MonadIO m => RecentData -> CString -> m ()

# Exported types

newtype RecentData Source #

Memory-managed wrapper type.

Constructors

RecentData (ManagedPtr RecentData) |

#### Instances

Instances details

Eq RecentData Source # |
Instance details Defined in GI.Gtk.Structs.RecentData Methods (==) :: RecentData -> RecentData -> Bool Source # (/=) :: RecentData -> RecentData -> Bool Source #
BoxedPtr RecentData Source # |
Instance details Defined in GI.Gtk.Structs.RecentData Methods boxedPtrCopy :: RecentData -> IO RecentData Source # boxedPtrFree :: RecentData -> IO () Source #
CallocPtr RecentData Source # |
Instance details Defined in GI.Gtk.Structs.RecentData Methods boxedPtrCalloc :: IO (Ptr RecentData) Source #
ManagedPtrNewtype RecentData Source # |
Instance details Defined in GI.Gtk.Structs.RecentData Methods toManagedPtr :: RecentData -> ManagedPtr RecentData Source #
tag ~ 'AttrSet => Constructible RecentData tag Source # |
Instance details Defined in GI.Gtk.Structs.RecentData Methods new :: MonadIO m => (ManagedPtr RecentData -> RecentData) -> [AttrOp RecentData tag] -> m RecentData Source #

newZeroRecentData :: MonadIO m => m RecentData Source #

Construct a `RecentData` struct initialized to zero.

# Methods

# Properties

## appExec

command line used to launch this resource; may contain the “%f” and “%u” escape characters which will be expanded to the resource file path and URI respectively when the command line is retrieved;

clearRecentDataAppExec :: MonadIO m => RecentData -> m () Source #

Set the value of the “`app_exec`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #appExec

getRecentDataAppExec :: MonadIO m => RecentData -> m (Maybe Text) Source #

Get the value of the “`app_exec`” field. When overloading is enabled, this is equivalent to

    get recentData #appExec

setRecentDataAppExec :: MonadIO m => RecentData -> CString -> m () Source #

Set the value of the “`app_exec`” field. When overloading is enabled, this is equivalent to

    set recentData [ #appExec := value ]

## appName

the name of the application that is registering this recently used resource;

clearRecentDataAppName :: MonadIO m => RecentData -> m () Source #

Set the value of the “`app_name`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #appName

getRecentDataAppName :: MonadIO m => RecentData -> m (Maybe Text) Source #

Get the value of the “`app_name`” field. When overloading is enabled, this is equivalent to

    get recentData #appName

setRecentDataAppName :: MonadIO m => RecentData -> CString -> m () Source #

Set the value of the “`app_name`” field. When overloading is enabled, this is equivalent to

    set recentData [ #appName := value ]

## description

a UTF-8 encoded string, containing a short description of the resource, or `Nothing`;

clearRecentDataDescription :: MonadIO m => RecentData -> m () Source #

Set the value of the “`description`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #description

getRecentDataDescription :: MonadIO m => RecentData -> m (Maybe Text) Source #

Get the value of the “`description`” field. When overloading is enabled, this is equivalent to

    get recentData #description

setRecentDataDescription :: MonadIO m => RecentData -> CString -> m () Source #

Set the value of the “`description`” field. When overloading is enabled, this is equivalent to

    set recentData [ #description := value ]

## displayName

a UTF-8 encoded string, containing the name of the recently used resource to be displayed, or `Nothing`;

clearRecentDataDisplayName :: MonadIO m => RecentData -> m () Source #

Set the value of the “`display_name`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #displayName

getRecentDataDisplayName :: MonadIO m => RecentData -> m (Maybe Text) Source #

Get the value of the “`display_name`” field. When overloading is enabled, this is equivalent to

    get recentData #displayName

setRecentDataDisplayName :: MonadIO m => RecentData -> CString -> m () Source #

Set the value of the “`display_name`” field. When overloading is enabled, this is equivalent to

    set recentData [ #displayName := value ]

## groups

a vector of strings containing groups names;

clearRecentDataGroups :: MonadIO m => RecentData -> m () Source #

Set the value of the “`groups`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #groups

getRecentDataGroups :: MonadIO m => RecentData -> m (Maybe [Text]) Source #

Get the value of the “`groups`” field. When overloading is enabled, this is equivalent to

    get recentData #groups

setRecentDataGroups :: MonadIO m => RecentData -> Ptr CString -> m () Source #

Set the value of the “`groups`” field. When overloading is enabled, this is equivalent to

    set recentData [ #groups := value ]

## isPrivate

whether this resource should be displayed only by the applications that have registered it or not.

getRecentDataIsPrivate :: MonadIO m => RecentData -> m Bool Source #

Get the value of the “`is_private`” field. When overloading is enabled, this is equivalent to

    get recentData #isPrivate

setRecentDataIsPrivate :: MonadIO m => RecentData -> Bool -> m () Source #

Set the value of the “`is_private`” field. When overloading is enabled, this is equivalent to

    set recentData [ #isPrivate := value ]

## mimeType

the MIME type of the resource;

clearRecentDataMimeType :: MonadIO m => RecentData -> m () Source #

Set the value of the “`mime_type`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #mimeType

getRecentDataMimeType :: MonadIO m => RecentData -> m (Maybe Text) Source #

Get the value of the “`mime_type`” field. When overloading is enabled, this is equivalent to

    get recentData #mimeType

setRecentDataMimeType :: MonadIO m => RecentData -> CString -> m () Source #

Set the value of the “`mime_type`” field. When overloading is enabled, this is equivalent to

    set recentData [ #mimeType := value ]