Package org.gnome.gtk

Class ShortcutsWindow

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.Window

org.gnome.gtk.ShortcutsWindow

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

@Generated("io.github.jwharm.JavaGI")
public class ShortcutsWindow
extends Window
implements Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

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 GtkBuilder, by using the <child> tag to populate a GtkShortcutsWindow with one or more ShortcutsSection objects, which contain one or more ShortcutsGroup instances, which, in turn, contain ShortcutsShortcut instances.

If you need to add a section programmatically, use addSection(org.gnome.gtk.ShortcutsSection) instead of Window.setChild(org.gnome.gtk.Widget), as the shortcuts window manages its children directly.

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

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.

Shortcuts and Gestures
The following signals have default keybindings:

• Gtk.ShortcutsWindow::close
• Gtk.ShortcutsWindow::search

CSS nodes
GtkShortcutsWindow has a single CSS node with the name window and style class .shortcuts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShortcutsWindow.Builder<B extends ShortcutsWindow.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	ShortcutsWindow.CloseCallback	Functional interface declaration of the CloseCallback callback.
static interface	ShortcutsWindow.SearchCallback	Functional interface declaration of the SearchCallback callback.

Nested classes/interfaces inherited from class org.gnome.gtk.Window

Window.ActivateDefaultCallback, Window.ActivateFocusCallback, Window.CloseRequestCallback, Window.EnableDebuggingCallback, Window.KeysChangedCallback, Window.WindowClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Native

Native.NativeImpl, Native.NativeInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Root

Root.RootImpl, Root.RootInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.ShortcutManager

ShortcutManager.ShortcutManagerImpl, ShortcutManager.ShortcutManagerInterface

Constructor Summary

Constructors

Constructor	Description
ShortcutsWindow(MemorySegment address)	Create a ShortcutsWindow proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addSection(ShortcutsSection section)	Adds a section to the shortcuts window.
protected ShortcutsWindow	asParent()	Returns this instance as if it were its parent type.
static ShortcutsWindow.Builder<? extends ShortcutsWindow.Builder>	builder()	A ShortcutsWindow.Builder object constructs a ShortcutsWindow with the specified properties.
void	emitClose()	Emits the "close" signal.
void	emitSearch()	Emits the "search" signal.
static Type	getType()	Get the GType of the ShortcutsWindow class
SignalConnection<ShortcutsWindow.CloseCallback>	onClose(ShortcutsWindow.CloseCallback handler)	Emitted when the user uses a keybinding to close the window.
SignalConnection<ShortcutsWindow.SearchCallback>	onSearch(ShortcutsWindow.SearchCallback handler)	Emitted when the user uses a keybinding to start a search.

Methods inherited from class org.gnome.gtk.Window

activateDefault, activateFocus, close, closeRequest, destroy, emitActivateDefault, emitActivateFocus, emitCloseRequest, emitEnableDebugging, emitKeysChanged, enableDebugging, fullscreen, fullscreenOnMonitor, getApplication, getChild, getDecorated, getDefaultIconName, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getFocus, getFocusVisible, getGroup, getHandleMenubarAccel, getHideOnClose, getIconName, getMemoryLayout, getMnemonicsVisible, getModal, getResizable, getTitle, getTitlebar, getToplevels, getTransientFor, hasGroup, isActive, isFullscreen, isMaximized, isSuspended, keysChanged, 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, setInteractiveDebugging, setMnemonicsVisible, setModal, setResizable, setStartupId, setTitle, setTitlebar, setTransientFor, unfullscreen, unmaximize, unminimize

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, 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, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.gnome.gtk.Native

getRenderer, getSurface, getSurfaceTransform, realize, unrealize

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.Root

getDisplay, getFocus, setFocus

Constructor Details

ShortcutsWindow

public ShortcutsWindow(MemorySegment address)

Create a ShortcutsWindow proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the ShortcutsWindow class

Returns:

the GType

asParent

protected ShortcutsWindow asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Window

addSection

public void addSection(ShortcutsSection section)

Adds a section to the shortcuts window.

This is the programmatic equivalent to using GtkBuilder and a <child> tag to add the child.

Using Window.setChild(org.gnome.gtk.Widget) is not appropriate as the shortcuts window manages its children internally.

Parameters:

section - the GtkShortcutsSection to add

onClose

public SignalConnection<ShortcutsWindow.CloseCallback> onClose(ShortcutsWindow.CloseCallback handler)

Emitted when the user uses a keybinding to close the window.

This is a keybinding signal.

The default binding for this signal is the Escape key.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ShortcutsWindow.CloseCallback.run()

emitClose

public void emitClose()

Emits the "close" signal. See onClose(org.gnome.gtk.ShortcutsWindow.CloseCallback).

onSearch

public SignalConnection<ShortcutsWindow.SearchCallback> onSearch(ShortcutsWindow.SearchCallback handler)

Emitted when the user uses a keybinding to start a search.

This is a keybinding signal.

The default binding for this signal is Control+F.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ShortcutsWindow.SearchCallback.run()

emitSearch

public void emitSearch()

Emits the "search" signal. See onSearch(org.gnome.gtk.ShortcutsWindow.SearchCallback).

builder

public static ShortcutsWindow.Builder<? extends ShortcutsWindow.Builder> builder()

A ShortcutsWindow.Builder object constructs a ShortcutsWindow with the specified properties. Use the various set...() methods to set properties, and finish construction with ShortcutsWindow.Builder.build().