GI.Gtk.Objects.ShortcutsWindow

A GtkShortcutsWindow shows brief information about the keyboard shortcuts and gestures of an application. The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.

Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.

The recommended way to construct a GtkShortcutsWindow is with GtkBuilder, by populating a ShortcutsWindow with one or more ShortcutsSection objects, which contain GtkShortcutsGroups that in turn contain objects of class ShortcutsShortcut.

A simple example:

This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.

The .ui file for this example can be found here.

An example with multiple views:

This example shows a ShortcutsWindow that has been configured to show only the shortcuts relevant to the "stopwatch" view.

The .ui file for this example can be found here.

An example with multiple sections:

This example shows a ShortcutsWindow with two sections, "Editor Shortcuts" and "Terminal Shortcuts".

The .ui file for this example can be found here.

Exported types

newtype ShortcutsWindow

Constructors

ShortcutsWindow (ManagedPtr ShortcutsWindow)

Instances

GObject ShortcutsWindow

Methods

gobjectType :: ShortcutsWindow -> IO GType

IsImplementorIface ShortcutsWindow

IsObject ShortcutsWindow

IsWindow ShortcutsWindow

IsWidget ShortcutsWindow

IsShortcutsWindow ShortcutsWindow

IsContainer ShortcutsWindow

IsBin ShortcutsWindow

IsBuildable ShortcutsWindow

((~) * info (ResolveShortcutsWindowMethod t ShortcutsWindow), MethodInfo * info ShortcutsWindow p) => IsLabel t (ShortcutsWindow -> p)

Methods

fromLabel :: Proxy# Symbol t -> ShortcutsWindow -> p

((~) * info (ResolveShortcutsWindowMethod t ShortcutsWindow), MethodInfo * info ShortcutsWindow p) => IsLabelProxy t (ShortcutsWindow -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> ShortcutsWindow -> p

HasAttributeList * ShortcutsWindow

type AttributeList ShortcutsWindow

type AttributeList ShortcutsWindow

type SignalList ShortcutsWindow

type SignalList ShortcutsWindow

class GObject o => IsShortcutsWindow o

Instances

(GObject a, UnknownAncestorError Constraint ShortcutsWindow a) => IsShortcutsWindow a

IsShortcutsWindow ShortcutsWindow

toShortcutsWindow :: IsShortcutsWindow o => o -> IO ShortcutsWindow

noShortcutsWindow :: Maybe ShortcutsWindow

Properties

sectionName

data ShortcutsWindowSectionNamePropertyInfo

Instances

AttrInfo ShortcutsWindowSectionNamePropertyInfo

Associated Types

type AttrAllowedOps ShortcutsWindowSectionNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ShortcutsWindowSectionNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo :: * -> Constraint

type AttrGetType ShortcutsWindowSectionNamePropertyInfo :: *

type AttrLabel ShortcutsWindowSectionNamePropertyInfo :: Symbol

type AttrOrigin ShortcutsWindowSectionNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo o => Proxy * ShortcutsWindowSectionNamePropertyInfo -> o -> IO (AttrGetType ShortcutsWindowSectionNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo o, AttrSetTypeConstraint ShortcutsWindowSectionNamePropertyInfo b) => Proxy * ShortcutsWindowSectionNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo o => Proxy * ShortcutsWindowSectionNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo o, AttrSetTypeConstraint ShortcutsWindowSectionNamePropertyInfo b) => Proxy * ShortcutsWindowSectionNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ShortcutsWindowSectionNamePropertyInfo

type AttrOrigin ShortcutsWindowSectionNamePropertyInfo = ShortcutsWindow

type AttrLabel ShortcutsWindowSectionNamePropertyInfo

type AttrLabel ShortcutsWindowSectionNamePropertyInfo = "section-name"

type AttrGetType ShortcutsWindowSectionNamePropertyInfo

type AttrGetType ShortcutsWindowSectionNamePropertyInfo = Maybe Text

type AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo

type AttrBaseTypeConstraint ShortcutsWindowSectionNamePropertyInfo = IsShortcutsWindow

type AttrSetTypeConstraint ShortcutsWindowSectionNamePropertyInfo

type AttrSetTypeConstraint ShortcutsWindowSectionNamePropertyInfo = * ~ Text

type AttrAllowedOps ShortcutsWindowSectionNamePropertyInfo

type AttrAllowedOps ShortcutsWindowSectionNamePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

clearShortcutsWindowSectionName :: (MonadIO m, IsShortcutsWindow o) => o -> m ()

constructShortcutsWindowSectionName :: IsShortcutsWindow o => Text -> IO (GValueConstruct o)

getShortcutsWindowSectionName :: (MonadIO m, IsShortcutsWindow o) => o -> m (Maybe Text)

setShortcutsWindowSectionName :: (MonadIO m, IsShortcutsWindow o) => o -> Text -> m ()

shortcutsWindowSectionName :: AttrLabelProxy "sectionName"

viewName

data ShortcutsWindowViewNamePropertyInfo

Instances

AttrInfo ShortcutsWindowViewNamePropertyInfo

Associated Types

type AttrAllowedOps ShortcutsWindowViewNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ShortcutsWindowViewNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo :: * -> Constraint

type AttrGetType ShortcutsWindowViewNamePropertyInfo :: *

type AttrLabel ShortcutsWindowViewNamePropertyInfo :: Symbol

type AttrOrigin ShortcutsWindowViewNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo o => Proxy * ShortcutsWindowViewNamePropertyInfo -> o -> IO (AttrGetType ShortcutsWindowViewNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo o, AttrSetTypeConstraint ShortcutsWindowViewNamePropertyInfo b) => Proxy * ShortcutsWindowViewNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo o => Proxy * ShortcutsWindowViewNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo o, AttrSetTypeConstraint ShortcutsWindowViewNamePropertyInfo b) => Proxy * ShortcutsWindowViewNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ShortcutsWindowViewNamePropertyInfo

type AttrOrigin ShortcutsWindowViewNamePropertyInfo = ShortcutsWindow

type AttrLabel ShortcutsWindowViewNamePropertyInfo

type AttrLabel ShortcutsWindowViewNamePropertyInfo = "view-name"

type AttrGetType ShortcutsWindowViewNamePropertyInfo

type AttrGetType ShortcutsWindowViewNamePropertyInfo = Maybe Text

type AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo

type AttrBaseTypeConstraint ShortcutsWindowViewNamePropertyInfo = IsShortcutsWindow

type AttrSetTypeConstraint ShortcutsWindowViewNamePropertyInfo

type AttrSetTypeConstraint ShortcutsWindowViewNamePropertyInfo = * ~ Text

type AttrAllowedOps ShortcutsWindowViewNamePropertyInfo

type AttrAllowedOps ShortcutsWindowViewNamePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

clearShortcutsWindowViewName :: (MonadIO m, IsShortcutsWindow o) => o -> m ()

constructShortcutsWindowViewName :: IsShortcutsWindow o => Text -> IO (GValueConstruct o)

getShortcutsWindowViewName :: (MonadIO m, IsShortcutsWindow o) => o -> m (Maybe Text)

setShortcutsWindowViewName :: (MonadIO m, IsShortcutsWindow o) => o -> Text -> m ()

shortcutsWindowViewName :: AttrLabelProxy "viewName"

Signals

close

type C_ShortcutsWindowCloseCallback = Ptr () -> Ptr () -> IO ()

type ShortcutsWindowCloseCallback = IO ()

data ShortcutsWindowCloseSignalInfo

Instances

SignalInfo ShortcutsWindowCloseSignalInfo

Associated Types

type HaskellCallbackType ShortcutsWindowCloseSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o ShortcutsWindowCloseSignalInfo -> o -> HaskellCallbackType ShortcutsWindowCloseSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType ShortcutsWindowCloseSignalInfo

type HaskellCallbackType ShortcutsWindowCloseSignalInfo = ShortcutsWindowCloseCallback

afterShortcutsWindowClose :: (GObject a, MonadIO m) => a -> ShortcutsWindowCloseCallback -> m SignalHandlerId

genClosure_ShortcutsWindowClose :: ShortcutsWindowCloseCallback -> IO Closure

mk_ShortcutsWindowCloseCallback :: C_ShortcutsWindowCloseCallback -> IO (FunPtr C_ShortcutsWindowCloseCallback)

noShortcutsWindowCloseCallback :: Maybe ShortcutsWindowCloseCallback

onShortcutsWindowClose :: (GObject a, MonadIO m) => a -> ShortcutsWindowCloseCallback -> m SignalHandlerId

wrap_ShortcutsWindowCloseCallback :: ShortcutsWindowCloseCallback -> Ptr () -> Ptr () -> IO ()

search

type C_ShortcutsWindowSearchCallback = Ptr () -> Ptr () -> IO ()

type ShortcutsWindowSearchCallback = IO ()

data ShortcutsWindowSearchSignalInfo

Instances

SignalInfo ShortcutsWindowSearchSignalInfo

Associated Types

type HaskellCallbackType ShortcutsWindowSearchSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o ShortcutsWindowSearchSignalInfo -> o -> HaskellCallbackType ShortcutsWindowSearchSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType ShortcutsWindowSearchSignalInfo

type HaskellCallbackType ShortcutsWindowSearchSignalInfo = ShortcutsWindowSearchCallback

afterShortcutsWindowSearch :: (GObject a, MonadIO m) => a -> ShortcutsWindowSearchCallback -> m SignalHandlerId

genClosure_ShortcutsWindowSearch :: ShortcutsWindowSearchCallback -> IO Closure

mk_ShortcutsWindowSearchCallback :: C_ShortcutsWindowSearchCallback -> IO (FunPtr C_ShortcutsWindowSearchCallback)

noShortcutsWindowSearchCallback :: Maybe ShortcutsWindowSearchCallback

onShortcutsWindowSearch :: (GObject a, MonadIO m) => a -> ShortcutsWindowSearchCallback -> m SignalHandlerId

wrap_ShortcutsWindowSearchCallback :: ShortcutsWindowSearchCallback -> Ptr () -> Ptr () -> IO ()