Package ch.bailu.gtk.gtk

Class ShortcutsWindow

java.lang.Object

ch.bailu.gtk.type.Type

ch.bailu.gtk.type.Pointer

ch.bailu.gtk.gobject.Object

ch.bailu.gtk.gobject.InitiallyUnowned

ch.bailu.gtk.gtk.Widget

ch.bailu.gtk.gtk.Window

ch.bailu.gtk.gtk.ShortcutsWindow

All Implemented Interfaces:

PointerInterface

public class ShortcutsWindow
extends Window

A `GtkShortcutsWindow` shows 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
[class@Gtk.Builder], by populating a `GtkShortcutsWindow` with one or
more `GtkShortcutsSection` objects, which contain `GtkShortcutsGroups`
that in turn contain objects of class `GtkShortcutsShortcut`.

# 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](https://gitlab.gnome.org/GNOME/gtk/tree/main/demos/gtk-demo/shortcuts-gedit.ui).

# An example with multiple views:


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

The .ui file for this example can be found [here](https://gitlab.gnome.org/GNOME/gtk/tree/main/demos/gtk-demo/shortcuts-clocks.ui).

# An example with multiple sections:


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

The .ui file for this example can be found [here](https://gitlab.gnome.org/GNOME/gtk/tree/main/demos/gtk-demo/shortcuts-builder.ui).

https://docs.gtk.org/gtk4/class.ShortcutsWindow.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShortcutsWindow.OnClose
static interface	ShortcutsWindow.OnSearch

Nested classes/interfaces inherited from class ch.bailu.gtk.gtk.Window

Window.OnActivateDefault, Window.OnActivateFocus, Window.OnCloseRequest, Window.OnEnableDebugging, Window.OnKeysChanged

Nested classes/interfaces inherited from class ch.bailu.gtk.gtk.Widget

Widget.OnDestroy, Widget.OnDestroyNotify, Widget.OnDirectionChanged, Widget.OnHide, Widget.OnKeynavFailed, Widget.OnMap, Widget.OnMnemonicActivate, Widget.OnMoveFocus, Widget.OnQueryTooltip, Widget.OnRealize, Widget.OnShow, Widget.OnStateFlagsChanged, Widget.OnTickCallback, Widget.OnUnmap, Widget.OnUnrealize

Nested classes/interfaces inherited from class ch.bailu.gtk.gobject.Object

Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SIGNAL_ON_CLOSE
static final String	SIGNAL_ON_SEARCH

Fields inherited from class ch.bailu.gtk.gtk.Window

SIGNAL_ON_ACTIVATE_DEFAULT, SIGNAL_ON_ACTIVATE_FOCUS, SIGNAL_ON_CLOSE_REQUEST, SIGNAL_ON_ENABLE_DEBUGGING, SIGNAL_ON_KEYS_CHANGED

Fields inherited from class ch.bailu.gtk.gtk.Widget

SIGNAL_ON_DESTROY, SIGNAL_ON_DIRECTION_CHANGED, SIGNAL_ON_HIDE, SIGNAL_ON_KEYNAV_FAILED, SIGNAL_ON_MAP, SIGNAL_ON_MNEMONIC_ACTIVATE, SIGNAL_ON_MOVE_FOCUS, SIGNAL_ON_QUERY_TOOLTIP, SIGNAL_ON_REALIZE, SIGNAL_ON_SHOW, SIGNAL_ON_STATE_FLAGS_CHANGED, SIGNAL_ON_UNMAP, SIGNAL_ON_UNREALIZE

Fields inherited from class ch.bailu.gtk.gobject.Object

SIGNAL_ON_NOTIFY

Fields inherited from class ch.bailu.gtk.type.Pointer

NULL

Constructor Summary

Constructors

Constructor	Description
ShortcutsWindow(PointerContainer pointer)

Method Summary

Modifier and Type	Method	Description
Accessible	asAccessible()	Implements interface Accessible.
Buildable	asBuildable()	Implements interface Buildable.
ConstraintTarget	asConstraintTarget()	Implements interface ConstraintTarget.
Native	asNative()	Implements interface Native.
Root	asRoot()	Implements interface Root.
ShortcutManager	asShortcutManager()	Implements interface ShortcutManager.
static ClassHandler	getClassHandler()
static int	getInstanceSize()
static long	getParentTypeID()
static TypeSystem.TypeSize	getParentTypeSize()
static long	getTypeID()
static TypeSystem.TypeSize	getTypeSize()
SignalHandler	onClose(ShortcutsWindow.OnClose signal)	Connect to signal "close".
SignalHandler	onSearch(ShortcutsWindow.OnSearch signal)	Connect to signal "search".

Methods inherited from class ch.bailu.gtk.gtk.Window

close, destroy, fullscreen, fullscreenOnMonitor, getApplication, getChild, getDecorated, getDefaultIconName, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getFocus, getFocusVisible, getGroup, getHandleMenubarAccel, getHideOnClose, getIconName, getMnemonicsVisible, getModal, getResizable, getTitle, getTitlebar, getToplevels, getTransientFor, hasGroup, isActive, isFullscreen, isMaximized, listToplevels, maximize, minimize, onActivateDefault, onActivateFocus, onCloseRequest, onEnableDebugging, onKeysChanged, present, presentWithTime, setApplication, setAutoStartupNotification, setChild, setDecorated, setDefaultIconName, setDefaultSize, setDefaultWidget, setDeletable, setDestroyWithParent, setDisplay, setFocus, setFocusVisible, setHandleMenubarAccel, setHideOnClose, setIconName, setIconName, setInteractiveDebugging, setMnemonicsVisible, setModal, setResizable, setStartupId, setStartupId, setTitle, setTitle, setTitlebar, setTransientFor, unfullscreen, unmaximize, unminimize

Methods inherited from class ch.bailu.gtk.gtk.Widget

actionSetEnabled, actionSetEnabled, activate, activateAction, activateAction, activateActionVariant, activateActionVariant, activateDefault, addController, addCssClass, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeCssClass, removeMnemonicLabel, removeTickCallback, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipMarkup, setTooltipText, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, snapshotChild, triggerTooltipQuery, unmap, unparent, unrealize, unsetStateFlags

Methods inherited from class ch.bailu.gtk.gobject.Object

addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref

Methods inherited from class ch.bailu.gtk.type.Pointer

asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacks

Methods inherited from class ch.bailu.gtk.type.Type

asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.bailu.gtk.type.PointerInterface

asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull

Field Details

SIGNAL_ON_CLOSE

public static final String SIGNAL_ON_CLOSE

See Also:

• Constant Field Values

SIGNAL_ON_SEARCH

public static final String SIGNAL_ON_SEARCH

See Also:

• Constant Field Values

Constructor Details

ShortcutsWindow

public ShortcutsWindow(PointerContainer pointer)

Method Details

getClassHandler

public static ClassHandler getClassHandler()

onClose

public SignalHandler onClose(ShortcutsWindow.OnClose signal)

Connect to signal "close".
See ShortcutsWindow.OnClose.onClose() for signal description.
Field SIGNAL_ON_CLOSE contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

onSearch

public SignalHandler onSearch(ShortcutsWindow.OnSearch signal)

Connect to signal "search".
See ShortcutsWindow.OnSearch.onSearch() for signal description.
Field SIGNAL_ON_SEARCH contains original signal name and can be used as resource reference.

Parameters:

signal - callback function (lambda).

Returns:

SignalHandler. Can be used to disconnect signal and to release callback function.

asAccessible

public Accessible asAccessible()

Implements interface Accessible. Call this to get access to interface functions.

Overrides:

asAccessible in class Window

Returns:

Accessible

asBuildable

public Buildable asBuildable()

Implements interface Buildable. Call this to get access to interface functions.

Overrides:

asBuildable in class Window

Returns:

Buildable

asConstraintTarget

public ConstraintTarget asConstraintTarget()

Implements interface ConstraintTarget. Call this to get access to interface functions.

Overrides:

asConstraintTarget in class Window

Returns:

ConstraintTarget

asNative

public Native asNative()

Implements interface Native. Call this to get access to interface functions.

Overrides:

asNative in class Window

Returns:

Native

asRoot

public Root asRoot()

Implements interface Root. Call this to get access to interface functions.

Overrides:

asRoot in class Window

Returns:

Root

asShortcutManager

public ShortcutManager asShortcutManager()

Implements interface ShortcutManager. Call this to get access to interface functions.

Overrides:

asShortcutManager in class Window

Returns:

ShortcutManager

getTypeID

public static long getTypeID()

getParentTypeID

public static long getParentTypeID()

getTypeSize

public static TypeSystem.TypeSize getTypeSize()

getParentTypeSize

public static TypeSystem.TypeSize getParentTypeSize()

getInstanceSize

public static int getInstanceSize()