gi-gtk-3.0.31: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.ShortcutLabel

Contents

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.

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 # 
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

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 => Text -> IO (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 => Text -> IO (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 ]