Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GtkShortcutLabel
displays a single keyboard shortcut or gesture.
The main use case for GtkShortcutLabel
is inside a ShortcutsWindow
.
Synopsis
- newtype ShortcutLabel = ShortcutLabel (ManagedPtr ShortcutLabel)
- class (GObject o, IsDescendantOf ShortcutLabel o) => IsShortcutLabel o
- toShortcutLabel :: (MonadIO m, IsShortcutLabel o) => o -> m ShortcutLabel
- shortcutLabelGetAccelerator :: (HasCallStack, MonadIO m, IsShortcutLabel a) => a -> m (Maybe Text)
- shortcutLabelGetDisabledText :: (HasCallStack, MonadIO m, IsShortcutLabel a) => a -> m (Maybe Text)
- shortcutLabelNew :: (HasCallStack, MonadIO m) => Text -> m ShortcutLabel
- shortcutLabelSetAccelerator :: (HasCallStack, MonadIO m, IsShortcutLabel a) => a -> Text -> m ()
- shortcutLabelSetDisabledText :: (HasCallStack, MonadIO m, IsShortcutLabel a) => a -> Text -> m ()
- constructShortcutLabelAccelerator :: (IsShortcutLabel o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutLabelAccelerator :: (MonadIO m, IsShortcutLabel o) => o -> m (Maybe Text)
- setShortcutLabelAccelerator :: (MonadIO m, IsShortcutLabel o) => o -> Text -> m ()
- constructShortcutLabelDisabledText :: (IsShortcutLabel o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutLabelDisabledText :: (MonadIO m, IsShortcutLabel o) => o -> m (Maybe Text)
- setShortcutLabelDisabledText :: (MonadIO m, IsShortcutLabel o) => o -> Text -> m ()
Exported types
newtype ShortcutLabel Source #
Memory-managed wrapper type.
ShortcutLabel (ManagedPtr ShortcutLabel) |
Instances
Eq ShortcutLabel Source # | |
Defined in GI.Gtk.Objects.ShortcutLabel (==) :: ShortcutLabel -> ShortcutLabel -> Bool # (/=) :: ShortcutLabel -> ShortcutLabel -> Bool # | |
GObject ShortcutLabel Source # | |
Defined in GI.Gtk.Objects.ShortcutLabel | |
ManagedPtrNewtype ShortcutLabel Source # | |
Defined in GI.Gtk.Objects.ShortcutLabel toManagedPtr :: ShortcutLabel -> ManagedPtr ShortcutLabel | |
TypedObject ShortcutLabel Source # | |
Defined in GI.Gtk.Objects.ShortcutLabel | |
HasParentTypes ShortcutLabel Source # | |
Defined in GI.Gtk.Objects.ShortcutLabel | |
IsGValue (Maybe ShortcutLabel) Source # | Convert |
Defined in GI.Gtk.Objects.ShortcutLabel gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ShortcutLabel -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ShortcutLabel) | |
type ParentTypes ShortcutLabel Source # | |
Defined in GI.Gtk.Objects.ShortcutLabel |
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
(GObject o, IsDescendantOf ShortcutLabel o) => IsShortcutLabel o Source # | |
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
Methods
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccelerator, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisabledText, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setAccelerator, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setDisabledText, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.
getAccelerator
shortcutLabelGetAccelerator Source #
:: (HasCallStack, MonadIO m, IsShortcutLabel a) | |
=> a |
|
-> m (Maybe Text) | Returns: the current accelerator. |
Retrieves the current accelerator of self
.
getDisabledText
shortcutLabelGetDisabledText Source #
:: (HasCallStack, MonadIO m, IsShortcutLabel a) | |
=> a |
|
-> m (Maybe Text) | Returns: the current text displayed when no accelerator is set. |
Retrieves the text that is displayed when no accelerator is set.
new
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m ShortcutLabel | Returns: a newly-allocated |
Creates a new GtkShortcutLabel
with accelerator
set.
setAccelerator
shortcutLabelSetAccelerator Source #
:: (HasCallStack, MonadIO m, IsShortcutLabel a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the accelerator to be displayed by self
.
setDisabledText
shortcutLabelSetDisabledText Source #
:: (HasCallStack, MonadIO m, IsShortcutLabel a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text to be displayed by self
when no accelerator is set.
Properties
accelerator
The accelerator that self
displays.
See ShortcutsShortcut:accelerator for the accepted syntax.
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.
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 ]