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

class GObject o => IsShortcutsWindow o

Instances

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

IsShortcutsWindow ShortcutsWindow

toShortcutsWindow :: (MonadIO m, IsShortcutsWindow o) => o -> m ShortcutsWindow

noShortcutsWindow :: Maybe ShortcutsWindow

Properties

sectionName

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

viewName

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

Signals

close

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

type ShortcutsWindowCloseCallback = IO ()

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

genClosure_ShortcutsWindowClose :: ShortcutsWindowCloseCallback -> IO Closure

mk_ShortcutsWindowCloseCallback :: C_ShortcutsWindowCloseCallback -> IO (FunPtr C_ShortcutsWindowCloseCallback)

noShortcutsWindowCloseCallback :: Maybe ShortcutsWindowCloseCallback

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

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

search

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

type ShortcutsWindowSearchCallback = IO ()

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

genClosure_ShortcutsWindowSearch :: ShortcutsWindowSearchCallback -> IO Closure

mk_ShortcutsWindowSearchCallback :: C_ShortcutsWindowSearchCallback -> IO (FunPtr C_ShortcutsWindowSearchCallback)

noShortcutsWindowSearchCallback :: Maybe ShortcutsWindowSearchCallback

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

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