Portability	portable (depends on GHC)
Stability	provisional
Maintainer	gtk2hs-users@lists.sourceforge.net
Safe Haskell	None

Graphics.UI.Gtk.Recent.RecentChooser

Contents

Detail
Class Hierarchy
Types
Enums
Methods
Attributes
Signals

Description

Interface implemented by widgets displaying recently used files

Module available since Gtk+ version 2.10

Synopsis

Detail

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.

Class Hierarchy

 | GInterface
 | +----RecentChooser

Types

data RecentChooser Source

Instances

Eq RecentChooser
Ord RecentChooser
GObjectClass RecentChooser
RecentChooserClass RecentChooser

class GObjectClass o => RecentChooserClass o Source

Instances

RecentChooserClass RecentChooser

castToRecentChooser :: GObjectClass obj => obj -> RecentChooser Source

toRecentChooser :: RecentChooserClass o => o -> RecentChooser Source

Enums

data RecentChooserError Source

These identify the various errors that can occur while calling RecentChooser functions.

Constructors

RecentChooserErrorNotFound
RecentChooserErrorInvalidUri

Instances

Bounded RecentChooserError
Enum RecentChooserError
Eq RecentChooserError
Show RecentChooserError

data RecentSortType Source

Used to specify the sorting method to be applyed to the recently used resource list.

Constructors

RecentSortNone
RecentSortMru
RecentSortLru
RecentSortCustom

Instances

Bounded RecentSortType
Enum RecentSortType	Sets the comparison function used when sorting to be `sortFunc`. If the `chooser` has the sort type set to `RecentSortCustom` 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. Available since Gtk+ version 2.10
Eq RecentSortType
Show RecentSortType

Methods

recentChooserSetSortFunc :: RecentChooserClass self => self -> Maybe (RecentInfo -> IO Int) -> IO ()Source

recentChooserSetCurrentURI Source

Arguments

:: RecentChooserClass self
=> self
-> String	`uri` - a URI
-> IO Bool	returns `True` if the URI was found.

Sets uri as the current URI for chooser.

Available since Gtk+ version 2.10

recentChooserGetCurrentURI Source

Arguments

:: RecentChooserClass self
=> self
-> IO String	returns a newly string holding a URI.

Gets the URI currently selected by chooser.

Available since Gtk+ version 2.10

recentChooserGetCurrentItem Source

Arguments

:: RecentChooserClass self
=> self
-> IO RecentInfo	returns a `RecentInfo`. Use `recentInfoUnref` when when you have finished using it.

Gets the RecentInfo currently selected by chooser.

Available since Gtk+ version 2.10

recentChooserSelectURI Source

Arguments

:: RecentChooserClass self
=> self
-> String	`uri` - a URI
-> IO Bool	returns `True` if `uri` was found.

Selects uri inside chooser.

Available since Gtk+ version 2.10

recentChooserUnselectURI Source

Arguments

:: RecentChooserClass self
=> self
-> String	`uri` - a URI
-> IO ()

Unselects uri inside chooser.

Available since Gtk+ version 2.10

recentChooserSelectAll :: RecentChooserClass self => self -> IO ()Source

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

Available since Gtk+ version 2.10

recentChooserUnselectAll :: RecentChooserClass self => self -> IO ()Source

Unselects all the items inside chooser.

Available since Gtk+ version 2.10

recentChooserGetItems Source

Arguments

:: RecentChooserClass self
=> self
-> IO [RecentInfo]	returns A list of `RecentInfo` objects.

Gets the list of recently used resources in form of RecentInfo

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

recentChooserGetURIs :: RecentChooserClass self => self -> IO [String]Source

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.

Available since Gtk+ version 2.10

recentChooserAddFilter Source

Arguments

:: (RecentChooserClass self, RecentFilterClass filter)
=> self
-> filter	`filter` - a `RecentFilter`
-> IO ()

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

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

Available since Gtk+ version 2.10

recentChooserRemoveFilter Source

Arguments

:: (RecentChooserClass self, RecentFilterClass filter)
=> self
-> filter	`filter` - a `RecentFilter`
-> IO ()

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

recentChooserListFilters Source

Arguments

:: RecentChooserClass self
=> self
-> IO [RecentFilter]	returns A singly linked list of `RecentFilter`.

Gets the RecentFilter objects held by chooser.

Available since Gtk+ version 2.10

Attributes

recentChooserShowPrivate :: RecentChooserClass self => Attr self Bool Source

Whether the private items should be displayed.

Default value: False

Available since Gtk+ version 2.10

recentChooserShowTips :: RecentChooserClass self => Attr self Bool Source

Whether this RecentChooser should display a tooltip containing the full path of the recently used resources.

Default value: False

Available since Gtk+ version 2.10

recentChooserShowIcons :: RecentChooserClass self => Attr self Bool Source

Whether this RecentChooser should display an icon near the item.

Default value: True

Available since Gtk+ version 2.10

recentChooserShowNotFound :: RecentChooserClass self => Attr self Bool Source

Whether this RecentChooser should display the recently used resources even if not present anymore. Setting this to False will perform a potentially expensive check on every local resource (every remote resource will always be displayed).

Default value: True

Available since Gtk+ version 2.10

recentChooserSelectMultiple :: RecentChooserClass self => Attr self Bool Source

Allow the user to select multiple resources.

Default value: False

Available since Gtk+ version 2.10

recentChooserLocalOnly :: RecentChooserClass self => Attr self Bool Source

Whether this RecentChooser should display only local (file:) resources.

Default value: True

Available since Gtk+ version 2.10

recentChooserLimit :: RecentChooserClass self => Attr self Int Source

The maximum number of recently used resources to be displayed, or -1 to display all items. By default, the Setting:gtk-recent-files-limit setting is respected: you can override that limit on a particular instance of RecentChooser by setting this property.

Allowed values: >= GMaxulong

Default value: -1

Available since Gtk+ version 2.10

recentChooserSortType :: RecentChooserClass self => Attr self RecentSortType Source

Sorting order to be used when displaying the recently used resources.

Default value: ''RecentSortNone''

Available since Gtk+ version 2.10

recentChooserFilter :: (RecentChooserClass self, RecentFilterClass recentFilter) => ReadWriteAttr self RecentFilter recentFilterSource

The RecentFilter object to be used when displaying the recently used resources.

Available since Gtk+ version 2.10

Signals

recentChooserSelectionChanged :: RecentChooserClass self => Signal self (IO ())Source

This signal is emitted when there is a change in the set of selected recently used resources. This can happen when a user modifies the selection with the mouse or the keyboard, or when explicitely calling functions to change the selection.

Available since Gtk+ version 2.10

recentChooserItemActivated :: RecentChooserClass self => Signal self (IO ())Source

This signal is emitted when the user "activates" a recent item in the recent chooser. This can happen by double-clicking on an item in the recently used resources list, or by pressing Enter.

Available since Gtk+ version 2.10