Package org.gnome.gtk

Class ShortcutsSection

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

org.gnome.gtk.ShortcutsSection

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget, Orientable

@Generated("io.github.jwharm.JavaGI")
public class ShortcutsSection
extends Box
implements Accessible, Buildable, ConstraintTarget, Orientable

A GtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode.

If your application needs multiple sections, you should give each section a unique Gtk.ShortcutsSection:section-name and a Gtk.ShortcutsSection:title that can be shown in the section selector of the ShortcutsWindow.

The Gtk.ShortcutsSection:max-height property can be used to influence how the groups in the section are distributed over pages and columns.

This widget is only meant to be used with ShortcutsWindow.

The recommended way to construct a GtkShortcutsSection is with GtkBuilder, by using the <child> tag to populate a GtkShortcutsSection with one or more ShortcutsGroup instances, which in turn contain one or more ShortcutsShortcut objects.

If you need to add a group programmatically, use addGroup(org.gnome.gtk.ShortcutsGroup).

Shortcuts and Gestures
Pan gestures allow to navigate between sections.

The following signals have default keybindings:

• Gtk.ShortcutsSection::change-current-page

Nested Class Summary

Nested Classes

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

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

Box.BoxClass

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

Orientable.OrientableIface, Orientable.OrientableImpl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addGroup(ShortcutsGroup group)	Adds a group to the shortcuts section.
protected ShortcutsSection	asParent()	Returns this instance as if it were its parent type.
static ShortcutsSection.Builder<? extends ShortcutsSection.Builder>	builder()	A ShortcutsSection.Builder object constructs a ShortcutsSection with the specified properties.
boolean	emitChangeCurrentPage(int offset)	Emits the "change-current-page" signal.
static Type	getType()	Get the GType of the ShortcutsSection class
SignalConnection<ShortcutsSection.ChangeCurrentPageCallback>	onChangeCurrentPage(ShortcutsSection.ChangeCurrentPageCallback handler)	Emitted when we change the current page.

Methods inherited from class org.gnome.gtk.Box

append, getBaselineChild, getBaselinePosition, getHomogeneous, getMemoryLayout, getSpacing, insertChildAfter, prepend, remove, reorderChildAfter, setBaselineChild, setBaselinePosition, setHomogeneous, setSpacing

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

getOrientation, setOrientation

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

handle

Constructor Details

ShortcutsSection

public ShortcutsSection(MemorySegment address)

Create a ShortcutsSection 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 ShortcutsSection class

Returns:

the GType

asParent

protected ShortcutsSection 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 Box

addGroup

public void addGroup(ShortcutsGroup group)

Adds a group to the shortcuts section.

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

Adding children with the GtkBox API is not appropriate, as GtkShortcutsSection manages its children internally.

Parameters:

group - the GtkShortcutsGroup to add

onChangeCurrentPage

public SignalConnection<ShortcutsSection.ChangeCurrentPageCallback> onChangeCurrentPage(ShortcutsSection.ChangeCurrentPageCallback handler)

Emitted when we change the current page.

The default bindings for this signal are Ctrl+PgUp, PgUp, Ctrl+PgDn, PgDn.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• ShortcutsSection.ChangeCurrentPageCallback.run(int)

emitChangeCurrentPage

public boolean emitChangeCurrentPage(int offset)

Emits the "change-current-page" signal. See onChangeCurrentPage(org.gnome.gtk.ShortcutsSection.ChangeCurrentPageCallback).

builder

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

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