gi-gtk-3.0.26: Gtk bindings

Copyright Will Thompson Iñaki García Etxebarria and Jonas Platte LGPL-2.1 Iñaki García Etxebarria (garetxe@gmail.com) None Haskell2010

GI.Gtk.Objects.ShortcutsShortcut

Description

A GtkShortcutsShortcut represents a single keyboard shortcut or gesture with a short text. This widget is only meant to be used with ShortcutsWindow.

Synopsis

# Exported types

newtype ShortcutsShortcut Source #

Memory-managed wrapper type.

Constructors

 ShortcutsShortcut (ManagedPtr ShortcutsShortcut)
Instances
 Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Methods Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut

class GObject o => IsShortcutsShortcut o Source #

Type class for types which can be safely cast to ShortcutsShortcut, for instance with toShortcutsShortcut.

Instances
 Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut Source # Instance detailsDefined in GI.Gtk.Objects.ShortcutsShortcut

toShortcutsShortcut :: (MonadIO m, IsShortcutsShortcut o) => o -> m ShortcutsShortcut Source #

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

A convenience alias for Nothing :: Maybe ShortcutsShortcut.

# Properties

## accelSizeGroup

The size group for the accelerator portion of this shortcut.

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

clearShortcutsShortcutAccelSizeGroup :: (MonadIO m, IsShortcutsShortcut 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


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

setShortcutsShortcutAccelSizeGroup :: (MonadIO m, IsShortcutsShortcut 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 shortcutsShortcut [ #accelSizeGroup := value ]


## accelerator

The accelerator(s) represented by this object. This property is used if ShortcutsShortcut:shortcut-type is set to GTK_SHORTCUT_ACCELERATOR.

The syntax of this property is (an extension of) the syntax understood by acceleratorParse. Multiple accelerators can be specified by separating them with a space, but keep in mind that the available width is limited. It is also possible to specify ranges of shortcuts, using ... between the keys. Sequences of keys can be specified using a + or & between the keys.

Examples:

• A single shortcut: <ctl><alt>delete
• Two alternative shortcuts: <shift>a Home
• A range of shortcuts: <alt>1...<alt>9
• Several keys pressed together: Control_L&Control_R
• A sequence of shortcuts or keys: <ctl>c+<ctl>x

Use + instead of & when the keys may (or have to be) pressed sequentially (e.g use t+t for 'press the t key twice').

Note that <, > and & need to be escaped as &lt;, &gt; and &amp; when used in .ui files.

clearShortcutsShortcutAccelerator :: (MonadIO m, IsShortcutsShortcut o) => o -> m () Source #

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

clear #accelerator


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

getShortcutsShortcutAccelerator :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text) Source #

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

get shortcutsShortcut #accelerator


setShortcutsShortcutAccelerator :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m () Source #

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

set shortcutsShortcut [ #accelerator := value ]


## actionName

A detailed action name. If this is set for a shortcut of type ShortcutTypeAccelerator, then GTK+ will use the accelerators that are associated with the action via applicationSetAccelsForAction, and setting ShortcutsShortcut::accelerator is not necessary.

Since: 3.22

clearShortcutsShortcutActionName :: (MonadIO m, IsShortcutsShortcut o) => o -> m () Source #

Set the value of the “action-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #actionName


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

getShortcutsShortcutActionName :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text) Source #

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

get shortcutsShortcut #actionName


setShortcutsShortcutActionName :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m () Source #

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

set shortcutsShortcut [ #actionName := value ]


## direction

The text direction for which this shortcut is active. If the shortcut is used regardless of the text direction, set this property to GTK_TEXT_DIR_NONE.

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

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

get shortcutsShortcut #direction


setShortcutsShortcutDirection :: (MonadIO m, IsShortcutsShortcut o) => o -> TextDirection -> m () Source #

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

set shortcutsShortcut [ #direction := value ]


## icon

An icon to represent the shortcut or gesture. This property is used if ShortcutsShortcut:shortcut-type is set to GTK_SHORTCUT_GESTURE. For the other predefined gesture types, GTK+ provides an icon on its own.

clearShortcutsShortcutIcon :: (MonadIO m, IsShortcutsShortcut o) => o -> m () Source #

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

clear #icon


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

getShortcutsShortcutIcon :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Icon) Source #

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

get shortcutsShortcut #icon


setShortcutsShortcutIcon :: (MonadIO m, IsShortcutsShortcut o, IsIcon a) => o -> a -> m () Source #

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

set shortcutsShortcut [ #icon := value ]


## iconSet

True if an icon has been set.

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

getShortcutsShortcutIconSet :: (MonadIO m, IsShortcutsShortcut o) => o -> m Bool Source #

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

get shortcutsShortcut #iconSet


setShortcutsShortcutIconSet :: (MonadIO m, IsShortcutsShortcut o) => o -> Bool -> m () Source #

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

set shortcutsShortcut [ #iconSet := value ]


## shortcutType

The type of shortcut that is represented.

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

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

get shortcutsShortcut #shortcutType


setShortcutsShortcutShortcutType :: (MonadIO m, IsShortcutsShortcut o) => o -> ShortcutType -> m () Source #

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

set shortcutsShortcut [ #shortcutType := value ]


## subtitle

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture types, GTK+ provides a subtitle on its own.

clearShortcutsShortcutSubtitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m () Source #

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

clear #subtitle


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

getShortcutsShortcutSubtitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text) Source #

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

get shortcutsShortcut #subtitle


setShortcutsShortcutSubtitle :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m () Source #

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

set shortcutsShortcut [ #subtitle := value ]


## subtitleSet

True if a subtitle has been set.

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

getShortcutsShortcutSubtitleSet :: (MonadIO m, IsShortcutsShortcut o) => o -> m Bool Source #

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

get shortcutsShortcut #subtitleSet


setShortcutsShortcutSubtitleSet :: (MonadIO m, IsShortcutsShortcut o) => o -> Bool -> m () Source #

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

set shortcutsShortcut [ #subtitleSet := value ]


## title

The textual description for the shortcut or gesture represented by this object. This should be a short string that can fit in a single line.

clearShortcutsShortcutTitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m () Source #

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

clear #title


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

getShortcutsShortcutTitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text) Source #

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

get shortcutsShortcut #title


setShortcutsShortcutTitle :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m () Source #

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

set shortcutsShortcut [ #title := value ]


## titleSizeGroup

The size group for the textual portion of this shortcut.

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

clearShortcutsShortcutTitleSizeGroup :: (MonadIO m, IsShortcutsShortcut 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


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

setShortcutsShortcutTitleSizeGroup :: (MonadIO m, IsShortcutsShortcut 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 shortcutsShortcut [ #titleSizeGroup := value ]