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

GI.Gtk.Objects.ShortcutsShortcut

Contents

Exported types
Properties

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

newtype ShortcutsShortcut = ShortcutsShortcut (ManagedPtr ShortcutsShortcut)
class GObject o => IsShortcutsShortcut o
toShortcutsShortcut :: (MonadIO m, IsShortcutsShortcut o) => o -> m ShortcutsShortcut
noShortcutsShortcut :: Maybe ShortcutsShortcut
clearShortcutsShortcutAccelSizeGroup :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutAccelSizeGroup :: (IsShortcutsShortcut o, IsSizeGroup a) => a -> IO (GValueConstruct o)
setShortcutsShortcutAccelSizeGroup :: (MonadIO m, IsShortcutsShortcut o, IsSizeGroup a) => o -> a -> m ()
clearShortcutsShortcutAccelerator :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutAccelerator :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o)
getShortcutsShortcutAccelerator :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text)
setShortcutsShortcutAccelerator :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m ()
clearShortcutsShortcutActionName :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutActionName :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o)
getShortcutsShortcutActionName :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text)
setShortcutsShortcutActionName :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m ()
constructShortcutsShortcutDirection :: IsShortcutsShortcut o => TextDirection -> IO (GValueConstruct o)
getShortcutsShortcutDirection :: (MonadIO m, IsShortcutsShortcut o) => o -> m TextDirection
setShortcutsShortcutDirection :: (MonadIO m, IsShortcutsShortcut o) => o -> TextDirection -> m ()
clearShortcutsShortcutIcon :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutIcon :: (IsShortcutsShortcut o, IsIcon a) => a -> IO (GValueConstruct o)
getShortcutsShortcutIcon :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Icon)
setShortcutsShortcutIcon :: (MonadIO m, IsShortcutsShortcut o, IsIcon a) => o -> a -> m ()
constructShortcutsShortcutIconSet :: IsShortcutsShortcut o => Bool -> IO (GValueConstruct o)
getShortcutsShortcutIconSet :: (MonadIO m, IsShortcutsShortcut o) => o -> m Bool
setShortcutsShortcutIconSet :: (MonadIO m, IsShortcutsShortcut o) => o -> Bool -> m ()
constructShortcutsShortcutShortcutType :: IsShortcutsShortcut o => ShortcutType -> IO (GValueConstruct o)
getShortcutsShortcutShortcutType :: (MonadIO m, IsShortcutsShortcut o) => o -> m ShortcutType
setShortcutsShortcutShortcutType :: (MonadIO m, IsShortcutsShortcut o) => o -> ShortcutType -> m ()
clearShortcutsShortcutSubtitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutSubtitle :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o)
getShortcutsShortcutSubtitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text)
setShortcutsShortcutSubtitle :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m ()
constructShortcutsShortcutSubtitleSet :: IsShortcutsShortcut o => Bool -> IO (GValueConstruct o)
getShortcutsShortcutSubtitleSet :: (MonadIO m, IsShortcutsShortcut o) => o -> m Bool
setShortcutsShortcutSubtitleSet :: (MonadIO m, IsShortcutsShortcut o) => o -> Bool -> m ()
clearShortcutsShortcutTitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutTitle :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o)
getShortcutsShortcutTitle :: (MonadIO m, IsShortcutsShortcut o) => o -> m (Maybe Text)
setShortcutsShortcutTitle :: (MonadIO m, IsShortcutsShortcut o) => o -> Text -> m ()
clearShortcutsShortcutTitleSizeGroup :: (MonadIO m, IsShortcutsShortcut o) => o -> m ()
constructShortcutsShortcutTitleSizeGroup :: (IsShortcutsShortcut o, IsSizeGroup a) => a -> IO (GValueConstruct o)
setShortcutsShortcutTitleSizeGroup :: (MonadIO m, IsShortcutsShortcut o, IsSizeGroup a) => o -> a -> m ()

Exported types

newtype ShortcutsShortcut Source #

Memory-managed wrapper type.

Constructors

ShortcutsShortcut (ManagedPtr ShortcutsShortcut)

Instances

GObject ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut Methods gobjectType :: ShortcutsShortcut -> IO GType #
IsImplementorIface ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsObject ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsBuildable ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsOrientable ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsBox ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsContainer ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsWidget ShortcutsShortcut Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsShortcutsShortcut ShortcutsShortcut Source #
Instance details Defined 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

(GObject a, (UnknownAncestorError ShortcutsShortcut a :: Constraint)) => IsShortcutsShortcut a Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsShortcut
IsShortcutsShortcut ShortcutsShortcut Source #
Instance details Defined 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.

noShortcutsShortcut :: Maybe ShortcutsShortcut Source #

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

constructShortcutsShortcutAccelSizeGroup :: (IsShortcutsShortcut o, IsSizeGroup a) => a -> IO (GValueConstruct o) Source #

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 <, > and & 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

constructShortcutsShortcutAccelerator :: IsShortcutsShortcut 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.

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

constructShortcutsShortcutActionName :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o) Source #

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.

constructShortcutsShortcutDirection :: IsShortcutsShortcut o => TextDirection -> IO (GValueConstruct o) Source #

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

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

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

constructShortcutsShortcutIcon :: (IsShortcutsShortcut o, IsIcon a) => a -> IO (GValueConstruct o) Source #

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.

constructShortcutsShortcutIconSet :: IsShortcutsShortcut o => Bool -> IO (GValueConstruct o) Source #

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.

constructShortcutsShortcutShortcutType :: IsShortcutsShortcut o => ShortcutType -> IO (GValueConstruct o) Source #

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

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

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

constructShortcutsShortcutSubtitle :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o) Source #

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.

constructShortcutsShortcutSubtitleSet :: IsShortcutsShortcut o => Bool -> IO (GValueConstruct o) Source #

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

constructShortcutsShortcutTitle :: IsShortcutsShortcut o => Text -> IO (GValueConstruct o) Source #

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

constructShortcutsShortcutTitleSizeGroup :: (IsShortcutsShortcut o, IsSizeGroup a) => a -> IO (GValueConstruct o) Source #

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 ]