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.ShortcutsGroup

Contents

Exported types
Properties

Description

A GtkShortcutsGroup represents a group of related keyboard shortcuts or gestures. The group has a title. It may optionally be associated with a view of the application, which can be used to show only relevant shortcuts depending on the application context.

This widget is only meant to be used with ShortcutsWindow.

Synopsis

newtype ShortcutsGroup = ShortcutsGroup (ManagedPtr ShortcutsGroup)
class GObject o => IsShortcutsGroup o
toShortcutsGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ShortcutsGroup
noShortcutsGroup :: Maybe ShortcutsGroup
clearShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
constructShortcutsGroupAccelSizeGroup :: (IsShortcutsGroup o, IsSizeGroup a) => a -> IO (GValueConstruct o)
setShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup o, IsSizeGroup a) => o -> a -> m ()
getShortcutsGroupHeight :: (MonadIO m, IsShortcutsGroup o) => o -> m Word32
clearShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
constructShortcutsGroupTitle :: IsShortcutsGroup o => Text -> IO (GValueConstruct o)
getShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text)
setShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m ()
clearShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
constructShortcutsGroupTitleSizeGroup :: (IsShortcutsGroup o, IsSizeGroup a) => a -> IO (GValueConstruct o)
setShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup o, IsSizeGroup a) => o -> a -> m ()
clearShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m ()
constructShortcutsGroupView :: IsShortcutsGroup o => Text -> IO (GValueConstruct o)
getShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text)
setShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m ()

Exported types

newtype ShortcutsGroup Source #

Memory-managed wrapper type.

Constructors

ShortcutsGroup (ManagedPtr ShortcutsGroup)

Instances

GObject ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup Methods gobjectType :: ShortcutsGroup -> IO GType #
IsImplementorIface ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsObject ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsBuildable ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsOrientable ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsBox ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsContainer ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsWidget ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsShortcutsGroup ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup

class GObject o => IsShortcutsGroup o Source #

Type class for types which can be safely cast to ShortcutsGroup, for instance with toShortcutsGroup.

Instances

(GObject a, (UnknownAncestorError ShortcutsGroup a :: Constraint)) => IsShortcutsGroup a Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup
IsShortcutsGroup ShortcutsGroup Source #
Instance details Defined in GI.Gtk.Objects.ShortcutsGroup

toShortcutsGroup :: (MonadIO m, IsShortcutsGroup o) => o -> m ShortcutsGroup Source #

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

noShortcutsGroup :: Maybe ShortcutsGroup Source #

A convenience alias for Nothing :: Maybe ShortcutsGroup.

Properties

accelSizeGroup

The size group for the accelerator portion of shortcuts in this group.

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

clearShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup 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

constructShortcutsGroupAccelSizeGroup :: (IsShortcutsGroup 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.

setShortcutsGroupAccelSizeGroup :: (MonadIO m, IsShortcutsGroup 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 shortcutsGroup [ #accelSizeGroup := value ]

height

A rough measure for the number of lines in this group.

This is used internally by GTK+, and is not useful for applications.

getShortcutsGroupHeight :: (MonadIO m, IsShortcutsGroup o) => o -> m Word32 Source #

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

get shortcutsGroup #height

title

The title for this group of shortcuts.

clearShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m () Source #

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

clear #title

constructShortcutsGroupTitle :: IsShortcutsGroup 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.

getShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text) Source #

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

get shortcutsGroup #title

setShortcutsGroupTitle :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m () Source #

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

set shortcutsGroup [ #title := value ]

titleSizeGroup

The size group for the textual portion of shortcuts in this group.

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

clearShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup 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

constructShortcutsGroupTitleSizeGroup :: (IsShortcutsGroup 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.

setShortcutsGroupTitleSizeGroup :: (MonadIO m, IsShortcutsGroup 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 shortcutsGroup [ #titleSizeGroup := value ]

view

An optional view that the shortcuts in this group are relevant for. The group will be hidden if the ShortcutsWindow:view-name property does not match the view of this group.

Set this to Nothing to make the group always visible.

clearShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m () Source #

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

clear #view

constructShortcutsGroupView :: IsShortcutsGroup o => Text -> IO (GValueConstruct o) Source #

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

getShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> m (Maybe Text) Source #

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

get shortcutsGroup #view

setShortcutsGroupView :: (MonadIO m, IsShortcutsGroup o) => o -> Text -> m () Source #

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

set shortcutsGroup [ #view := value ]