gi-gtk-3.0.41: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.ShortcutLabel

Description

ShortcutLabel is a widget that represents a single keyboard shortcut or gesture in the user interface.

Synopsis

Exported types

newtype ShortcutLabel Source #

Memory-managed wrapper type.

Constructors

ShortcutLabel (ManagedPtr ShortcutLabel) 

Instances

Instances details
Eq ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

GObject ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

ManagedPtrNewtype ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

Methods

toManagedPtr :: ShortcutLabel -> ManagedPtr ShortcutLabel

TypedObject ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

Methods

glibType :: IO GType

HasParentTypes ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

IsGValue (Maybe ShortcutLabel) Source #

Convert ShortcutLabel to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ShortcutLabel -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ShortcutLabel)

type ParentTypes ShortcutLabel Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

type ParentTypes ShortcutLabel = '[Box, Container, Widget, Object, ImplementorIface, Buildable, Orientable]

class (GObject o, IsDescendantOf ShortcutLabel o) => IsShortcutLabel o Source #

Type class for types which can be safely cast to ShortcutLabel, for instance with toShortcutLabel.

Instances

Instances details
(GObject o, IsDescendantOf ShortcutLabel o) => IsShortcutLabel o Source # 
Instance details

Defined in GI.Gtk.Objects.ShortcutLabel

toShortcutLabel :: (MonadIO m, IsShortcutLabel o) => o -> m ShortcutLabel Source #

Cast to ShortcutLabel, 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

getAccelerator, getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBaselinePosition, getBorderWidth, getCanDefault, getCanFocus, getCenterWidget, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisabledText, 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, setAccelerator, setAllocation, setAppPaintable, setBaselinePosition, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCenterWidget, setChildPacking, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDisabledText, 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.

getAccelerator

shortcutLabelGetAccelerator Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutLabel a) 
=> a

self: a ShortcutLabel

-> m (Maybe Text)

Returns: the current accelerator.

Retrieves the current accelerator of self.

Since: 3.22

getDisabledText

shortcutLabelGetDisabledText Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutLabel a) 
=> a

self: a ShortcutLabel

-> m (Maybe Text)

Returns: the current text displayed when no accelerator is set.

Retrieves the text that is displayed when no accelerator is set.

Since: 3.22

new

shortcutLabelNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

accelerator: the initial accelerator

-> m ShortcutLabel

Returns: a newly-allocated ShortcutLabel

Creates a new ShortcutLabel with accelerator set.

Since: 3.22

setAccelerator

shortcutLabelSetAccelerator Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutLabel a) 
=> a

self: a ShortcutLabel

-> Text

accelerator: the new accelerator

-> m () 

Sets the accelerator to be displayed by self.

Since: 3.22

setDisabledText

shortcutLabelSetDisabledText Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcutLabel a) 
=> a

self: a ShortcutLabel

-> Text

disabledText: the text to be displayed when no accelerator is set

-> m () 

Sets the text to be displayed by self when no accelerator is set.

Since: 3.22

Properties

accelerator

The accelerator that self displays. See ShortcutsShortcut:accelerator for the accepted syntax.

Since: 3.22

constructShortcutLabelAccelerator :: (IsShortcutLabel o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutLabelAccelerator :: (MonadIO m, IsShortcutLabel o) => o -> m (Maybe Text) Source #

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

get shortcutLabel #accelerator

setShortcutLabelAccelerator :: (MonadIO m, IsShortcutLabel o) => o -> Text -> m () Source #

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

set shortcutLabel [ #accelerator := value ]

disabledText

The text that is displayed when no accelerator is set.

Since: 3.22

constructShortcutLabelDisabledText :: (IsShortcutLabel o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getShortcutLabelDisabledText :: (MonadIO m, IsShortcutLabel o) => o -> m (Maybe Text) Source #

Get the value of the “disabled-text” property. When overloading is enabled, this is equivalent to

get shortcutLabel #disabledText

setShortcutLabelDisabledText :: (MonadIO m, IsShortcutLabel o) => o -> Text -> m () Source #

Set the value of the “disabled-text” property. When overloading is enabled, this is equivalent to

set shortcutLabel [ #disabledText := value ]