Class ShortcutLabel

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

All Implemented Interfaces:

Accessible, Buildable, ConstraintTarget, Proxy

@Generated("org.javagi.JavaGI")
public final class ShortcutLabel
extends Widget
implements Accessible, Buildable, ConstraintTarget

A widget that displays a keyboard shortcut.

The shown shortcut can be set using the ShortcutLabel:accelerator property.

Optionally, if no shortcut is set, AdwShortcutLabel will display a placeholder set with the ShortcutLabel:disabled-text property.

The following types of shortcuts can be displayed:

• A single shortcut in Gtk#acceleratorParse format, e.g. <Control>C:

  

• Multiple alternative shortcuts, separated with spaces, e.g. <Shift>A Home:

  

• A range of shortcuts, separated with ..., e.g. <Alt>1...9:

  

• Multiple keys pressed at once, separated with &, e.g. Control_L&Control_R:

  

• Multiple shortcuts or keys, pressed sequentially, separated with +, e.g. <Control>C+<Control>X:

  

::: note <, > and & need to be escaped as <, > and & when used in UI files.

CSS nodes

AdwShortcutLabel has a single CSS node with name shortcut-label. The individual keycap labels each have the .keycap style class, while the labels separating them have the .dimmed style class.

Accessibility

AdwShortcutLabel uses the Gtk.AccessibleRole.label role.

See also: ShortcutsDialog.

Since:

1.8

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class 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 InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
ShortcutLabel()	Create a new ShortcutLabel.
ShortcutLabel(MemorySegment address)	Create a ShortcutLabel instance for the provided memory address.
ShortcutLabel(String accelerator)	Creates a new AdwShortcutLabel showing accelerator.

Method Summary

Modifier and Type	Method	Description
protected ShortcutLabel	asParent()	Return this instance as if it were its parent type.
static ShortcutLabel.Builder<? extends ShortcutLabel.Builder>	builder()	A ShortcutLabel.Builder object constructs a ShortcutLabel with the specified properties.
String	getAccelerator()	Gets the accelerator displayed by self.
String	getDisabledText()	Gets the text displayed by this ShortcutLabel when no accelerator is set.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the ShortcutLabel class.
void	setAccelerator(String accelerator)	Sets the accelerator to be displayed by self.
void	setDisabledText(String disabledText)	Sets the text to be displayed by this ShortcutLabel when no accelerator is set.

Methods inherited from class 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 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Methods inherited from interface Accessible

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

Methods inherited from interface Buildable

getBuildableId

Methods inherited from interface Proxy

handle

Constructor Details

ShortcutLabel

public ShortcutLabel(MemorySegment address)

Create a ShortcutLabel instance for the provided memory address.

Parameters:

address - the memory address of the native object

ShortcutLabel

public ShortcutLabel(String accelerator)

Creates a new AdwShortcutLabel showing accelerator.

Parameters:

accelerator - the accelerator to show

Since:

1.8

ShortcutLabel

public ShortcutLabel()

Create a new ShortcutLabel.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ShortcutLabel class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected ShortcutLabel asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class Widget

Returns:

the instance as if it were its parent type

getAccelerator

public String getAccelerator()

Gets the accelerator displayed by self.

Returns:

the displayed accelerator

Since:

1.8

getDisabledText

public String getDisabledText()

Gets the text displayed by this ShortcutLabel when no accelerator is set.

Returns:

the text displayed when no accelerator is set

Since:

1.8

setAccelerator

public void setAccelerator(String accelerator)

Sets the accelerator to be displayed by self.

Parameters:

accelerator - the accelerator to be displayed

Since:

1.8

setDisabledText

public void setDisabledText(String disabledText)

Sets the text to be displayed by this ShortcutLabel when no accelerator is set.

Parameters:

disabledText - the text displayed when no accelerator is set

Since:

1.8

builder

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

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

Returns:

the builder object