Package org.gnome.adw

Class ShortcutsDialog

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.adw.Dialog

org.gnome.adw.ShortcutsDialog

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, ShortcutManager, Proxy

@Generated("io.github.jwharm.JavaGI")
public final class ShortcutsDialog
extends Dialog
implements Accessible, Buildable, ConstraintTarget, ShortcutManager

A dialog that displays application's keyboard shortcuts.

Shortcuts are grouped into sections, represented by ShortcutsSection objects. Each section has one or more items, represented by ShortcutsItem objects.

To add a section to the dialog, use add(org.gnome.adw.ShortcutsSection), or add it as a child when using UI files.

Sections without titles can be used to further subdivide each section into groups.

Example of an AdwShortcutsDialog UI definition:

<object class="AdwShortcutsDialog" id="shortcuts_dialog">
   <child>
     <object class="AdwShortcutsSection">
       <property name="title" translatable="yes">General</property>
       <child>
         <object class="AdwShortcutsItem">
           <property name="title" translatable="yes">Open Menu</property>
           <property name="accelerator">F10</property>
         </object>
       </child>
       <child>
         <object class="AdwShortcutsItem">
           <property name="title" translatable="yes">Quit</property>
           <property name="action-name">app.quit</property>
         </object>
       </child>
     </object>
   </child>
   <child>
     <object class="AdwShortcutsSection">
       <child>
         <object class="AdwShortcutsItem">
           <property name="title" translatable="yes">Move Tab Left</property>
           <property name="accelerator">&lt;Shift&gt;&lt;Ctrl&gt;Page_Up</property>
           <property name="direction">ltr</property>
         </object>
       </child>
       <child>
         <object class="AdwShortcutsItem">
           <property name="title" translatable="yes">Move Tab Right</property>
           <property name="accelerator">&lt;Shift&gt;&lt;Ctrl&gt;Page_Down</property>
           <property name="direction">ltr</property>
         </object>
       </child>
       <child>
         <object class="AdwShortcutsItem">
           <property name="title" translatable="yes">Move Tab Right</property>
           <property name="accelerator">&lt;Shift&gt;&lt;Ctrl&gt;Page_Up</property>
           <property name="direction">rtl</property>
         </object>
       </child>
       <child>
         <object class="AdwShortcutsItem">
           <property name="title" translatable="yes">Move Tab Left</property>
           <property name="accelerator">&lt;Shift&gt;&lt;Ctrl&gt;Page_Down</property>
           <property name="direction">rtl</property>
         </object>
       </child>
     </object>
   </child>
 </object>
 

If the app.quit action has the CtrlQ accelerator associated with it, the result will look as follows:

The recommended way to use AdwShortcutsDialog is via Application's automatic resource loading.

See also: ShortcutLabel.

Since:

1.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShortcutsDialog.Builder<B extends ShortcutsDialog.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ShortcutsDialog.ShortcutsDialogClass

Nested classes/interfaces inherited from class org.gnome.adw.Dialog

Dialog.CloseAttemptCallback, Dialog.ClosedCallback, Dialog.DialogClass

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.Widget$Impl, Widget.WidgetClass

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.Accessible$Impl, Accessible.AccessibleInterface

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

Buildable.Buildable$Impl, Buildable.BuildableIface

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

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

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

ShortcutManager.ShortcutManager$Impl, ShortcutManager.ShortcutManagerInterface

Constructor Summary

Constructors

Constructor	Description
ShortcutsDialog()	Creates a new ShortcutsDialog.
ShortcutsDialog(MemorySegment address)	Create a ShortcutsDialog proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	add(ShortcutsSection section)	Adds section to self.
protected ShortcutsDialog	asParent()	Returns this instance as if it were its parent type.
static ShortcutsDialog.Builder<? extends ShortcutsDialog.Builder>	builder()	A ShortcutsDialog.Builder object constructs a ShortcutsDialog with the specified properties.
static @Nullable Type	getType()	Get the GType of the ShortcutsDialog class

Methods inherited from class org.gnome.adw.Dialog

addBreakpoint, close, closeAttempt, closed, emitCloseAttempt, emitClosed, forceClose, getCanClose, getChild, getContentHeight, getContentWidth, getCurrentBreakpoint, getDefaultWidget, getFocus, getFollowsContentSize, getMemoryLayout, getPresentationMode, getTitle, onCloseAttempt, onClosed, present, setCanClose, setChild, setContentHeight, setContentWidth, setDefaultWidget, setFocus, setFollowsContentSize, setPresentationMode, setTitle

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, 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, getLimitEvents, 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, setLimitEvents, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.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, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

ShortcutsDialog

public ShortcutsDialog(MemorySegment address)

Create a ShortcutsDialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ShortcutsDialog

public ShortcutsDialog()

Creates a new ShortcutsDialog.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ShortcutsDialog class

Returns:

the GType

asParent

protected ShortcutsDialog 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 Dialog

add

public void add(ShortcutsSection section)

Adds section to self.

Parameters:

section - the section to add

Since:

1.8

builder

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

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

Returns:

the builder object