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

Contents

- Exported types
- Methods
  - getShowNumbers
  - new
  - newForManager
  - setShowNumbers
- Properties
  - showNumbers

Description

`RecentChooserMenu` is a widget suitable for displaying recently used files inside a menu. It can be used to set a sub-menu of a `MenuItem` using `menuItemSetSubmenu`, or as the menu of a `MenuToolButton`.

Note that `RecentChooserMenu` does not have any methods of its own. Instead, you should use the functions that work on a `RecentChooser`.

Note also that `RecentChooserMenu` does not support multiple filters, as it has no way to let the user choose between them as the `RecentChooserWidget` and `RecentChooserDialog` widgets do. Thus using `recentChooserAddFilter` on a `RecentChooserMenu` widget will yield the same effects as using `recentChooserSetFilter`, replacing any currently set filter with the supplied filter; `recentChooserRemoveFilter` will remove any currently set `RecentFilter` object and will unset the current filter; `recentChooserListFilters` will return a list containing a single `RecentFilter` object.

Recently used files are supported since GTK+ 2.10.

Synopsis

- newtype RecentChooserMenu = RecentChooserMenu (ManagedPtr RecentChooserMenu)
- class (GObject o, IsDescendantOf RecentChooserMenu o) => IsRecentChooserMenu o
- toRecentChooserMenu :: (MonadIO m, IsRecentChooserMenu o) => o -> m RecentChooserMenu
- recentChooserMenuGetShowNumbers :: (HasCallStack, MonadIO m, IsRecentChooserMenu a) => a -> m Bool
- recentChooserMenuNew :: (HasCallStack, MonadIO m) => m RecentChooserMenu
- recentChooserMenuNewForManager :: (HasCallStack, MonadIO m, IsRecentManager a) => a -> m RecentChooserMenu
- recentChooserMenuSetShowNumbers :: (HasCallStack, MonadIO m, IsRecentChooserMenu a) => a -> Bool -> m ()
- constructRecentChooserMenuShowNumbers :: (IsRecentChooserMenu o, MonadIO m) => Bool -> m (GValueConstruct o)
- getRecentChooserMenuShowNumbers :: (MonadIO m, IsRecentChooserMenu o) => o -> m Bool
- setRecentChooserMenuShowNumbers :: (MonadIO m, IsRecentChooserMenu o) => o -> Bool -> m ()

# Exported types

newtype RecentChooserMenu Source #

Memory-managed wrapper type.

Constructors

RecentChooserMenu (ManagedPtr RecentChooserMenu) |

#### Instances

Instances details

Eq RecentChooserMenu Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu Methods (==) :: RecentChooserMenu -> RecentChooserMenu -> Bool Source # (/=) :: RecentChooserMenu -> RecentChooserMenu -> Bool Source #
GObject RecentChooserMenu Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu
ManagedPtrNewtype RecentChooserMenu Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu Methods toManagedPtr :: RecentChooserMenu -> ManagedPtr RecentChooserMenu Source #
TypedObject RecentChooserMenu Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu Methods glibType :: IO GType Source #
HasParentTypes RecentChooserMenu Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu
IsGValue (Maybe RecentChooserMenu) Source # | Convert `RecentChooserMenu` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe RecentChooserMenu -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe RecentChooserMenu) Source #
type ParentTypes RecentChooserMenu Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu type ParentTypes RecentChooserMenu = '[Menu, MenuShell, Container, Widget, Object, ImplementorIface, Activatable, Buildable, RecentChooser]

class (GObject o, IsDescendantOf RecentChooserMenu o) => IsRecentChooserMenu o Source #

Type class for types which can be safely cast to `RecentChooserMenu`, for instance with `toRecentChooserMenu`.

#### Instances

Instances details

(GObject o, IsDescendantOf RecentChooserMenu o) => IsRecentChooserMenu o Source # |
Instance details Defined in GI.Gtk.Objects.RecentChooserMenu

toRecentChooserMenu :: (MonadIO m, IsRecentChooserMenu o) => o -> m RecentChooserMenu Source #

Cast to `RecentChooserMenu`, for types for which this is known to be safe. For general casts, use `castTo`.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

activate, activateItem, add, addAccelerator, addChild, addDeviceEvents, addEvents, addFilter, addMnemonicLabel, addTickCallback, append, attach, attachToWidget, bindModel, bindProperty, bindPropertyFull, canActivateAccel, cancel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, deactivate, deselect, destroy, destroyed, detach, deviceIsShadowed, doSetRelatedAction, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insert, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listFilters, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, placeOnMonitor, popdown, popup, popupAtPointer, popupAtRect, popupAtWidget, popupForDevice, prepend, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeFilter, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reorderChild, reparent, reposition, resetRcStyles, resetStyle, resizeChildren, runDispose, selectAll, selectFirst, selectItem, selectUri, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, syncActionProperties, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unselectAll, unselectUri, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccelGroup, getAccelPath, getAccessible, getActionGroup, getActive, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getAttachWidget, getBorderWidth, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getCurrentItem, getCurrentUri, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFilter, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getItems, getLimit, getLocalOnly, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getMonitor, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentShell, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRelatedAction, getRequestMode, getRequisition, getReserveToggleSize, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSelectMultiple, getSelectedItem, getSensitive, getSettings, getShowIcons, getShowNotFound, getShowNumbers, getShowPrivate, getShowTips, getSizeRequest, getSortType, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTakeFocus, getTearoffState, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUris, getUseActionAppearance, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelGroup, setAccelPath, setActive, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setCurrentUri, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFilter, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setLimit, setLocalOnly, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMonitor, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setRelatedAction, setReserveToggleSize, setResizeMode, setScreen, setSelectMultiple, setSensitive, setShowIcons, setShowNotFound, setShowNumbers, setShowPrivate, setShowTips, setSizeRequest, setSortFunc, setSortType, setState, setStateFlags, setStyle, setSupportMultidevice, setTakeFocus, setTearoffState, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseActionAppearance, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

## getShowNumbers

recentChooserMenuGetShowNumbers Source #

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooserMenu a) |
=> a | `menu`: a `RecentChooserMenu`
-> m Bool | Returns: `True` if numbers should be shown.

Returns the value set by `recentChooserMenuSetShowNumbers`.

Since: 2.10

## new

recentChooserMenuNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m RecentChooserMenu | Returns: a new `RecentChooserMenu`

Creates a new `RecentChooserMenu` widget.

This kind of widget shows the list of recently used resources as a menu, each item as a menu item. Each item inside the menu might have an icon, representing its MIME type, and a number, for mnemonic access.

This widget implements the `RecentChooser` interface.

This widget creates its own `RecentManager` object. See the `recentChooserMenuNewForManager` function to know how to create a `RecentChooserMenu` widget bound to another `RecentManager` object.

Since: 2.10

## newForManager

recentChooserMenuNewForManager Source #

Arguments

:: (HasCallStack, MonadIO m, IsRecentManager a) |
=> a | `manager`: a `RecentManager`
-> m RecentChooserMenu | Returns: a new `RecentChooserMenu`, bound to `manager`.

Creates a new `RecentChooserMenu` widget using `manager` as the underlying recently used resources manager.

This is useful if you have implemented your own recent manager, or if you have a customized instance of a `RecentManager` object or if you wish to share a common `RecentManager` object among multiple `RecentChooser` widgets.

Since: 2.10

## setShowNumbers

recentChooserMenuSetShowNumbers Source #

Arguments

:: (HasCallStack, MonadIO m, IsRecentChooserMenu a) |
=> a | `menu`: a `RecentChooserMenu`
-> Bool | `showNumbers`: whether to show numbers
-> m () |

Sets whether a number should be added to the items of `menu`. The numbers are shown to provide a unique character for a mnemonic to be used inside ten menu item’s label. Only the first the items get a number to avoid clashes.

Since: 2.10

# Properties

## showNumbers

Whether the first ten items in the menu should be prepended by a number acting as a unique mnemonic.

Since: 2.10

constructRecentChooserMenuShowNumbers :: (IsRecentChooserMenu o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a `GValueConstruct` with valid value for the “`show-numbers`” property. This is rarely needed directly, but it is used by `new`.

getRecentChooserMenuShowNumbers :: (MonadIO m, IsRecentChooserMenu o) => o -> m Bool Source #

Get the value of the “`show-numbers`” property. When overloading is enabled, this is equivalent to

    get recentChooserMenu #showNumbers

setRecentChooserMenuShowNumbers :: (MonadIO m, IsRecentChooserMenu o) => o -> Bool -> m () Source #

Set the value of the “`show-numbers`” property. When overloading is enabled, this is equivalent to

    set recentChooserMenu [ #showNumbers := value ]