GI.Gtk.Interfaces.RecentChooser

RecentChooser is an interface that can be implemented by widgets displaying the list of recently used files. In GTK+, the main objects that implement this interface are RecentChooserWidget, RecentChooserDialog and RecentChooserMenu.

Recently used files are supported since GTK+ 2.10.

Exported types

newtype RecentChooser

Constructors

RecentChooser (ManagedPtr RecentChooser)

Instances

GObject RecentChooser

Methods

gobjectType :: RecentChooser -> IO GType

IsObject RecentChooser

IsRecentChooser RecentChooser

noRecentChooser :: Maybe RecentChooser

class GObject o => IsRecentChooser o

Instances

(GObject a, UnknownAncestorError Constraint RecentChooser a) => IsRecentChooser a

IsRecentChooser RecentChooser

IsRecentChooser RecentAction

IsRecentChooser RecentChooserDialog

IsRecentChooser RecentChooserWidget

IsRecentChooser RecentChooserMenu

toRecentChooser :: (MonadIO m, IsRecentChooser o) => o -> m RecentChooser

Methods

addFilter

recentChooserAddFilter

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a, IsRecentFilter b)

=> a

chooser: a RecentChooser

-> b

filter: a RecentFilter

-> m ()

Adds filter to the list of RecentFilter objects held by chooser.

If no previous filter objects were defined, this function will call recentChooserSetFilter.

Since: 2.10

getCurrentItem

recentChooserGetCurrentItem

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m RecentInfo

Returns: a RecentInfo. Use recentInfoUnref when when you have finished using it.

Gets the RecentInfo currently selected by chooser.

Since: 2.10

getCurrentUri

recentChooserGetCurrentUri

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Text

Returns: a newly allocated string holding a URI.

Gets the URI currently selected by chooser.

Since: 2.10

getFilter

recentChooserGetFilter

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m RecentFilter

Returns: a RecentFilter object.

Gets the RecentFilter object currently used by chooser to affect the display of the recently used resources.

Since: 2.10

getItems

recentChooserGetItems

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m [RecentInfo]

Returns: A newly allocated list of RecentInfo objects. You should use recentInfoUnref on every item of the list, and then free the list itself using g_list_free().

Gets the list of recently used resources in form of RecentInfo objects.

The return value of this function is affected by the “sort-type” and “limit” properties of chooser.

Since: 2.10

getLimit

recentChooserGetLimit

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Int32

Returns: A positive integer, or -1 meaning that all items are returned.

Gets the number of items returned by recentChooserGetItems and recentChooserGetUris.

Since: 2.10

getLocalOnly

recentChooserGetLocalOnly

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Bool

Returns: True if only local resources should be shown.

Gets whether only local resources should be shown in the recently used resources selector. See recentChooserSetLocalOnly

Since: 2.10

getSelectMultiple

recentChooserGetSelectMultiple

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Bool

Returns: True if chooser can select more than one item.

Gets whether chooser can select multiple items.

Since: 2.10

getShowIcons

recentChooserGetShowIcons

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Bool

Returns: True if the icons should be displayed, False otherwise.

Retrieves whether chooser should show an icon near the resource.

Since: 2.10

getShowNotFound

recentChooserGetShowNotFound

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Bool

Returns: True if the resources not found should be displayed, and False otheriwse.

Retrieves whether chooser should show the recently used resources that were not found.

Since: 2.10

getShowPrivate

recentChooserGetShowPrivate

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Bool

Returns: True if the recent chooser should show private items, False otherwise.

Returns whether chooser should display recently used resources registered as private.

Since: 2.10

getShowTips

recentChooserGetShowTips

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m Bool

Returns: True if the recent chooser should show tooltips, False otherwise.

Gets whether chooser should display tooltips containing the full path of a recently user resource.

Since: 2.10

getSortType

recentChooserGetSortType

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m RecentSortType

Returns: the sorting order of the chooser.

Gets the value set by recentChooserSetSortType.

Since: 2.10

getUris

recentChooserGetUris

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m ([Text], Word64)

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

Gets the URI of the recently used resources.

The return value of this function is affected by the “sort-type” and “limit” properties of chooser.

Since the returned array is Nothing terminated, length may be Nothing.

Since: 2.10

listFilters

recentChooserListFilters

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m [RecentFilter]

Returns: A singly linked list of RecentFilter objects. You should just free the returned list using g_slist_free().

Gets the RecentFilter objects held by chooser.

Since: 2.10

removeFilter

recentChooserRemoveFilter

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a, IsRecentFilter b)

=> a

chooser: a RecentChooser

-> b

filter: a RecentFilter

-> m ()

Removes filter from the list of RecentFilter objects held by chooser.

Since: 2.10

selectAll

recentChooserSelectAll

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m ()

Selects all the items inside chooser, if the chooser supports multiple selection.

Since: 2.10

selectUri

recentChooserSelectUri

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Text

uri: a URI

-> m ()

(Can throw GError)

Selects uri inside chooser.

Since: 2.10

setCurrentUri

recentChooserSetCurrentUri

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Text

uri: a URI

-> m ()

(Can throw GError)

Sets uri as the current URI for chooser.

Since: 2.10

setFilter

recentChooserSetFilter

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a, IsRecentFilter b)

=> a

chooser: a RecentChooser

-> Maybe b

filter: a RecentFilter

-> m ()

Sets filter as the current RecentFilter object used by chooser to affect the displayed recently used resources.

Since: 2.10

setLimit

recentChooserSetLimit

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Int32

limit: a positive integer, or -1 for all items

-> m ()

Sets the number of items that should be returned by recentChooserGetItems and recentChooserGetUris.

Since: 2.10

setLocalOnly

recentChooserSetLocalOnly

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Bool

localOnly: True if only local files can be shown

-> m ()

Sets whether only local resources, that is resources using the file:// URI scheme, should be shown in the recently used resources selector. If localOnly is True (the default) then the shown resources are guaranteed to be accessible through the operating system native file system.

Since: 2.10

setSelectMultiple

recentChooserSetSelectMultiple

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Bool

selectMultiple: True if chooser can select more than one item

-> m ()

Sets whether chooser can select multiple items.

Since: 2.10

setShowIcons

recentChooserSetShowIcons

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Bool

showIcons: whether to show an icon near the resource

-> m ()

Sets whether chooser should show an icon near the resource when displaying it.

Since: 2.10

setShowNotFound

recentChooserSetShowNotFound

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Bool

showNotFound: whether to show the local items we didn’t find

-> m ()

Sets whether chooser should display the recently used resources that it didn’t find. This only applies to local resources.

Since: 2.10

setShowPrivate

recentChooserSetShowPrivate

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Bool

showPrivate: True to show private items, False otherwise

-> m ()

Whether to show recently used resources marked registered as private.

Since: 2.10

setShowTips

recentChooserSetShowTips

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Bool

showTips: True if tooltips should be shown

-> m ()

Sets whether to show a tooltips containing the full path of each recently used resource in a RecentChooser widget.

Since: 2.10

setSortFunc

recentChooserSetSortFunc

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> RecentSortFunc

sortFunc: the comparison function

-> m ()

Sets the comparison function used when sorting to be sortFunc. If the chooser has the sort type set to GTK_RECENT_SORT_CUSTOM then the chooser will sort using this function.

To the comparison function will be passed two RecentInfo structs and sortData; sortFunc should return a positive integer if the first item comes before the second, zero if the two items are equal and a negative integer if the first item comes after the second.

Since: 2.10

setSortType

recentChooserSetSortType

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> RecentSortType

sortType: sort order that the chooser should use

-> m ()

Changes the sorting order of the recently used resources list displayed by chooser.

Since: 2.10

unselectAll

recentChooserUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> m ()

Unselects all the items inside chooser.

Since: 2.10

unselectUri

recentChooserUnselectUri

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooser a)

=> a

chooser: a RecentChooser

-> Text

uri: a URI

-> m ()

Unselects uri inside chooser.

Since: 2.10

Properties

filter

clearRecentChooserFilter :: (MonadIO m, IsRecentChooser o) => o -> m ()

constructRecentChooserFilter :: (IsRecentChooser o, IsRecentFilter a) => a -> IO (GValueConstruct o)

getRecentChooserFilter :: (MonadIO m, IsRecentChooser o) => o -> m RecentFilter

setRecentChooserFilter :: (MonadIO m, IsRecentChooser o, IsRecentFilter a) => o -> a -> m ()

limit

constructRecentChooserLimit :: IsRecentChooser o => Int32 -> IO (GValueConstruct o)

getRecentChooserLimit :: (MonadIO m, IsRecentChooser o) => o -> m Int32

setRecentChooserLimit :: (MonadIO m, IsRecentChooser o) => o -> Int32 -> m ()

localOnly

constructRecentChooserLocalOnly :: IsRecentChooser o => Bool -> IO (GValueConstruct o)

getRecentChooserLocalOnly :: (MonadIO m, IsRecentChooser o) => o -> m Bool

setRecentChooserLocalOnly :: (MonadIO m, IsRecentChooser o) => o -> Bool -> m ()

recentManager

constructRecentChooserRecentManager :: (IsRecentChooser o, IsRecentManager a) => a -> IO (GValueConstruct o)

selectMultiple

constructRecentChooserSelectMultiple :: IsRecentChooser o => Bool -> IO (GValueConstruct o)

getRecentChooserSelectMultiple :: (MonadIO m, IsRecentChooser o) => o -> m Bool

setRecentChooserSelectMultiple :: (MonadIO m, IsRecentChooser o) => o -> Bool -> m ()

showIcons

constructRecentChooserShowIcons :: IsRecentChooser o => Bool -> IO (GValueConstruct o)

getRecentChooserShowIcons :: (MonadIO m, IsRecentChooser o) => o -> m Bool

setRecentChooserShowIcons :: (MonadIO m, IsRecentChooser o) => o -> Bool -> m ()

showNotFound

constructRecentChooserShowNotFound :: IsRecentChooser o => Bool -> IO (GValueConstruct o)

getRecentChooserShowNotFound :: (MonadIO m, IsRecentChooser o) => o -> m Bool

setRecentChooserShowNotFound :: (MonadIO m, IsRecentChooser o) => o -> Bool -> m ()

showPrivate

constructRecentChooserShowPrivate :: IsRecentChooser o => Bool -> IO (GValueConstruct o)

getRecentChooserShowPrivate :: (MonadIO m, IsRecentChooser o) => o -> m Bool

setRecentChooserShowPrivate :: (MonadIO m, IsRecentChooser o) => o -> Bool -> m ()

showTips

constructRecentChooserShowTips :: IsRecentChooser o => Bool -> IO (GValueConstruct o)

getRecentChooserShowTips :: (MonadIO m, IsRecentChooser o) => o -> m Bool

setRecentChooserShowTips :: (MonadIO m, IsRecentChooser o) => o -> Bool -> m ()

sortType

constructRecentChooserSortType :: IsRecentChooser o => RecentSortType -> IO (GValueConstruct o)

getRecentChooserSortType :: (MonadIO m, IsRecentChooser o) => o -> m RecentSortType

setRecentChooserSortType :: (MonadIO m, IsRecentChooser o) => o -> RecentSortType -> m ()

Signals

itemActivated

type C_RecentChooserItemActivatedCallback = Ptr () -> Ptr () -> IO ()

type RecentChooserItemActivatedCallback = IO ()

afterRecentChooserItemActivated :: (IsRecentChooser a, MonadIO m) => a -> RecentChooserItemActivatedCallback -> m SignalHandlerId

genClosure_RecentChooserItemActivated :: RecentChooserItemActivatedCallback -> IO Closure

mk_RecentChooserItemActivatedCallback :: C_RecentChooserItemActivatedCallback -> IO (FunPtr C_RecentChooserItemActivatedCallback)

noRecentChooserItemActivatedCallback :: Maybe RecentChooserItemActivatedCallback

onRecentChooserItemActivated :: (IsRecentChooser a, MonadIO m) => a -> RecentChooserItemActivatedCallback -> m SignalHandlerId

wrap_RecentChooserItemActivatedCallback :: RecentChooserItemActivatedCallback -> Ptr () -> Ptr () -> IO ()

selectionChanged

type C_RecentChooserSelectionChangedCallback = Ptr () -> Ptr () -> IO ()

type RecentChooserSelectionChangedCallback = IO ()

afterRecentChooserSelectionChanged :: (IsRecentChooser a, MonadIO m) => a -> RecentChooserSelectionChangedCallback -> m SignalHandlerId

genClosure_RecentChooserSelectionChanged :: RecentChooserSelectionChangedCallback -> IO Closure

mk_RecentChooserSelectionChangedCallback :: C_RecentChooserSelectionChangedCallback -> IO (FunPtr C_RecentChooserSelectionChangedCallback)

noRecentChooserSelectionChangedCallback :: Maybe RecentChooserSelectionChangedCallback

onRecentChooserSelectionChanged :: (IsRecentChooser a, MonadIO m) => a -> RecentChooserSelectionChangedCallback -> m SignalHandlerId

wrap_RecentChooserSelectionChangedCallback :: RecentChooserSelectionChangedCallback -> Ptr () -> Ptr () -> IO ()