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.ShortcutsGroup

Contents

- Exported types
- Methods
- Properties
  - accelSizeGroup
  - height
  - title
  - titleSizeGroup
  - view

Description

A GtkShortcutsGroup represents a group of related keyboard shortcuts or gestures. The group has a title. It may optionally be associated with a view of the application, which can be used to show only relevant shortcuts depending on the application context.

This widget is only meant to be used with `ShortcutsWindow`.

Synopsis

- newtype ShortcutsGroup = ShortcutsGroup (ManagedPtr ShortcutsGroup)
- class (GObject o, IsDescendantOf ShortcutsGroup o) => IsShortcutsGroup o
- toShortcutsGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ShortcutsGroup
- clearShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
- constructShortcutsGroupAccelSizeGroup :: (IsShortcutsGroup o, MonadIO m, IsSizeGroup a) => a -> m (GValueConstruct o)
- setShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup o, IsSizeGroup a) => o -> a -> m ()
- getShortcutsGroupHeight :: (MonadIO m, IsShortcutsGroup o) => o -> m Word32
- clearShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
- constructShortcutsGroupTitle :: (IsShortcutsGroup o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text)
- setShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m ()
- clearShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
- constructShortcutsGroupTitleSizeGroup :: (IsShortcutsGroup o, MonadIO m, IsSizeGroup a) => a -> m (GValueConstruct o)
- setShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup o, IsSizeGroup a) => o -> a -> m ()
- clearShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
- constructShortcutsGroupView :: (IsShortcutsGroup o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text)
- setShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m ()

# Exported types

newtype ShortcutsGroup Source #

Memory-managed wrapper type.

Constructors

ShortcutsGroup (ManagedPtr ShortcutsGroup) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf ShortcutsGroup o) => IsShortcutsGroup o Source #

Type class for types which can be safely cast to `ShortcutsGroup`, for instance with `toShortcutsGroup`.

#### Instances

Instances details

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

toShortcutsGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ShortcutsGroup Source #

Cast to `ShortcutsGroup`, 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, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, 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, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, packEnd, packStart, parserFinished, path, propagateDraw, queryChildPacking, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reorderChild, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

#### Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBaselinePosition, getBorderWidth, getCanDefault, getCanFocus, getCenterWidget, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getSpacing, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

#### Setters

setAccelPath, setAllocation, setAppPaintable, setBaselinePosition, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCenterWidget, setChildPacking, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setOrientation, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setSpacing, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

# Properties

## accelSizeGroup

The size group for the accelerator portion of shortcuts in this group.

This is used internally by GTK+, and must not be modified by applications.

clearShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m () Source #

Set the value of the “`accel-size-group`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #accelSizeGroup

constructShortcutsGroupAccelSizeGroup :: (IsShortcutsGroup o, MonadIO m, IsSizeGroup a) => a -> m (GValueConstruct o) Source #

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

setShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup o, IsSizeGroup a) => o -> a -> m () Source #

Set the value of the “`accel-size-group`” property. When overloading is enabled, this is equivalent to

    set shortcutsGroup [ #accelSizeGroup := value ]

## height

A rough measure for the number of lines in this group.

This is used internally by GTK+, and is not useful for applications.

getShortcutsGroupHeight :: (MonadIO m, IsShortcutsGroup o) => o -> m Word32 Source #

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

    get shortcutsGroup #height

## title

The title for this group of shortcuts.

clearShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m () Source #

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

    clear #title

constructShortcutsGroupTitle :: (IsShortcutsGroup o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text) Source #

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

    get shortcutsGroup #title

setShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m () Source #

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

    set shortcutsGroup [ #title := value ]

## titleSizeGroup

The size group for the textual portion of shortcuts in this group.

This is used internally by GTK+, and must not be modified by applications.

clearShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m () Source #

Set the value of the “`title-size-group`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #titleSizeGroup

constructShortcutsGroupTitleSizeGroup :: (IsShortcutsGroup o, MonadIO m, IsSizeGroup a) => a -> m (GValueConstruct o) Source #

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

setShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup o, IsSizeGroup a) => o -> a -> m () Source #

Set the value of the “`title-size-group`” property. When overloading is enabled, this is equivalent to

    set shortcutsGroup [ #titleSizeGroup := value ]

## view

An optional view that the shortcuts in this group are relevant for. The group will be hidden if the ShortcutsWindow:viewName property does not match the view of this group.

Set this to `Nothing` to make the group always visible.

clearShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m () Source #

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

    clear #view

constructShortcutsGroupView :: (IsShortcutsGroup o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text) Source #

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

    get shortcutsGroup #view

setShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m () Source #

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

    set shortcutsGroup [ #view := value ]