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

Memory-managed wrapper type.

Constructors

ShortcutsWindow (ManagedPtr ShortcutsWindow)

Instances

Eq ShortcutsWindow

Defined in GI.Gtk.Objects.ShortcutsWindow

Methods

(==) :: ShortcutsWindow -> ShortcutsWindow -> Bool

(/=) :: ShortcutsWindow -> ShortcutsWindow -> Bool

IsGValue ShortcutsWindow

Convert ShortcutsWindow to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.ShortcutsWindow

Methods

toGValue :: ShortcutsWindow -> IO GValue

fromGValue :: GValue -> IO ShortcutsWindow

GObject ShortcutsWindow

Defined in GI.Gtk.Objects.ShortcutsWindow

Methods

gobjectType :: IO GType

HasParentTypes ShortcutsWindow

Defined in GI.Gtk.Objects.ShortcutsWindow

type ParentTypes ShortcutsWindow

Defined in GI.Gtk.Objects.ShortcutsWindow

type ParentTypes ShortcutsWindow = '[Window, Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf ShortcutsWindow o) => IsShortcutsWindow o

Type class for types which can be safely cast to ShortcutsWindow, for instance with toShortcutsWindow.

Instances

(GObject o, IsDescendantOf ShortcutsWindow o) => IsShortcutsWindow o

Defined in GI.Gtk.Objects.ShortcutsWindow

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

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

noShortcutsWindow :: Maybe ShortcutsWindow

A convenience alias for Nothing :: Maybe ShortcutsWindow.

Methods

Overloaded methods

Properties

sectionName

The name of the section to show.

This should be the section-name of one of the ShortcutsSection objects that are in this shortcuts window.

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

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

clear #sectionName

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

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

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

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

get shortcutsWindow #sectionName

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

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

set shortcutsWindow [ #sectionName := value ]

viewName

The view name by which to filter the contents.

This should correspond to the ShortcutsGroup:view property of some of the ShortcutsGroup objects that are inside this shortcuts window.

Set this to Nothing to show all groups.

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

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

clear #viewName

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

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

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

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

get shortcutsWindow #viewName

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

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

set shortcutsWindow [ #viewName := value ]

Signals

close

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

Type for the callback on the (unwrapped) C side.

type ShortcutsWindowCloseCallback = IO ()

The close signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to close the window.

The default binding for this signal is the Escape key.

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

Connect a signal handler for the close signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after shortcutsWindow #close callback

genClosure_ShortcutsWindowClose :: MonadIO m => ShortcutsWindowCloseCallback -> m (GClosure C_ShortcutsWindowCloseCallback)

Wrap the callback into a GClosure.

mk_ShortcutsWindowCloseCallback :: C_ShortcutsWindowCloseCallback -> IO (FunPtr C_ShortcutsWindowCloseCallback)

Generate a function pointer callable from C code, from a C_ShortcutsWindowCloseCallback.

noShortcutsWindowCloseCallback :: Maybe ShortcutsWindowCloseCallback

A convenience synonym for Nothing :: Maybe ShortcutsWindowCloseCallback.

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

Connect a signal handler for the close signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on shortcutsWindow #close callback

wrap_ShortcutsWindowCloseCallback :: ShortcutsWindowCloseCallback -> C_ShortcutsWindowCloseCallback

Wrap a ShortcutsWindowCloseCallback into a C_ShortcutsWindowCloseCallback.

search

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

Type for the callback on the (unwrapped) C side.

type ShortcutsWindowSearchCallback = IO ()

The search signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to start a search.

The default binding for this signal is Control-F.

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

Connect a signal handler for the search signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after shortcutsWindow #search callback

genClosure_ShortcutsWindowSearch :: MonadIO m => ShortcutsWindowSearchCallback -> m (GClosure C_ShortcutsWindowSearchCallback)

Wrap the callback into a GClosure.

mk_ShortcutsWindowSearchCallback :: C_ShortcutsWindowSearchCallback -> IO (FunPtr C_ShortcutsWindowSearchCallback)

Generate a function pointer callable from C code, from a C_ShortcutsWindowSearchCallback.

noShortcutsWindowSearchCallback :: Maybe ShortcutsWindowSearchCallback

A convenience synonym for Nothing :: Maybe ShortcutsWindowSearchCallback.

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

Connect a signal handler for the search signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on shortcutsWindow #search callback

wrap_ShortcutsWindowSearchCallback :: ShortcutsWindowSearchCallback -> C_ShortcutsWindowSearchCallback

Wrap a ShortcutsWindowSearchCallback into a C_ShortcutsWindowSearchCallback.