GI.Gtk.Objects.ShortcutLabel

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

Exported types

newtype ShortcutLabel

Memory-managed wrapper type.

Constructors

ShortcutLabel (ManagedPtr ShortcutLabel)

Instances

GObject ShortcutLabel

Defined in GI.Gtk.Objects.ShortcutLabel

Methods

gobjectType :: IO GType

HasParentTypes ShortcutLabel

Defined in GI.Gtk.Objects.ShortcutLabel

type ParentTypes ShortcutLabel

Defined in GI.Gtk.Objects.ShortcutLabel

type ParentTypes ShortcutLabel = Box ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (Orientable ': ([] :: [Type])))))))

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

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

Instances

(GObject o, IsDescendantOf ShortcutLabel o) => IsShortcutLabel o

Defined in GI.Gtk.Objects.ShortcutLabel

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

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

noShortcutLabel :: Maybe ShortcutLabel

A convenience alias for Nothing :: Maybe ShortcutLabel.

Methods

getAccelerator

shortcutLabelGetAccelerator

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

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

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

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

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)

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)

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 ()

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)

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)

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 ()

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

set shortcutLabel [ #disabledText := value ]