gi-gtk-3.0.27: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Structs.RecentData

Contents

Description

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

Synopsis

Exported types

newtype RecentData Source #

Memory-managed wrapper type.

Constructors

RecentData (ManagedPtr RecentData) 
Instances
WrappedPtr RecentData Source # 
Instance details

Defined in GI.Gtk.Structs.RecentData

Methods

wrappedPtrCalloc :: IO (Ptr RecentData) #

wrappedPtrCopy :: RecentData -> IO RecentData #

wrappedPtrFree :: Maybe (FunPtr (Ptr RecentData -> IO ())) #

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 #

newZeroRecentData :: MonadIO m => m RecentData Source #

Construct a RecentData struct initialized to zero.

noRecentData :: Maybe RecentData Source #

A convenience alias for Nothing :: Maybe RecentData.

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 ]