Package org.gnome.gtk

Class Shortcut

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.Shortcut

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class Shortcut
extends GObject

Describes a keyboard shortcut.

It contains a description of how to trigger the shortcut via a ShortcutTrigger and a way to activate the shortcut on a widget via a ShortcutAction.

The actual work is usually done via ShortcutController, which decides if and when to activate a shortcut. Using that controller directly however is rarely necessary as various higher level convenience APIs exist on GtkWidgets that make it easier to use shortcuts in GTK.

GtkShortcut does provide functionality to make it easy for users to work with shortcuts, either by providing informational strings for display purposes or by allowing shortcuts to be configured.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Shortcut()	Creates a new Shortcut.
Shortcut(MemorySegment address)	Create a Shortcut proxy instance for the provided memory address.
Shortcut(@Nullable ShortcutTrigger trigger, @Nullable ShortcutAction action)	Creates a new GtkShortcut that is triggered by trigger and then activates action.

Method Summary

Modifier and Type	Method	Description
protected Shortcut	asParent()	Returns this instance as if it were its parent type.
static Shortcut.Builder<? extends Shortcut.Builder>	builder()	A Shortcut.Builder object constructs a Shortcut with the specified properties.
@Nullable ShortcutAction	getAction()	Gets the action that is activated by this shortcut.
@Nullable Variant	getArguments()	Gets the arguments that are passed when activating the shortcut.
@Nullable ShortcutTrigger	getTrigger()	Gets the trigger used to trigger self.
static @Nullable Type	getType()	Get the GType of the Shortcut class
void	setAction(@Nullable ShortcutAction action)	Sets the new action for this Shortcut to be action.
void	setArguments(@Nullable Variant args)	Sets the arguments to pass when activating the shortcut.
void	setTrigger(@Nullable ShortcutTrigger trigger)	Sets the new trigger for this Shortcut to be trigger.
static Shortcut	withArguments(@Nullable ShortcutTrigger trigger, @Nullable ShortcutAction action, @Nullable String formatString, Object... varargs)	Creates a new GtkShortcut that is triggered by trigger and then activates action with arguments given by formatString.

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, getMemoryLayout, 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

Constructor Details

Shortcut

public Shortcut(MemorySegment address)

Create a Shortcut proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Shortcut

public Shortcut(@Nullable ShortcutTrigger trigger,
 @Nullable ShortcutAction action)

Creates a new GtkShortcut that is triggered by trigger and then activates action.

Parameters:

trigger - The trigger that will trigger the shortcut

action - The action that will be activated upon triggering

Shortcut

public Shortcut()

Creates a new Shortcut.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Shortcut class

Returns:

the GType

asParent

protected Shortcut 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 GObject

withArguments

public static Shortcut withArguments(@Nullable ShortcutTrigger trigger,
 @Nullable ShortcutAction action,
 @Nullable String formatString,
 Object... varargs)

Creates a new GtkShortcut that is triggered by trigger and then activates action with arguments given by formatString.

Parameters:

trigger - The trigger that will trigger the shortcut

action - The action that will be activated upon triggering

formatString - GVariant format string for arguments or null for no arguments

varargs - arguments, as given by format string.

Returns:

a new GtkShortcut

getAction

public @Nullable ShortcutAction getAction()

Gets the action that is activated by this shortcut.

Returns:

the action

getArguments

public @Nullable Variant getArguments()

Gets the arguments that are passed when activating the shortcut.

Returns:

the arguments

getTrigger

public @Nullable ShortcutTrigger getTrigger()

Gets the trigger used to trigger self.

Returns:

the trigger used

setAction

public void setAction(@Nullable ShortcutAction action)

Sets the new action for this Shortcut to be action.

Parameters:

action - The new action. If the action is null, the nothing action will be used.

setArguments

public void setArguments(@Nullable Variant args)

Sets the arguments to pass when activating the shortcut.

Parameters:

args - arguments to pass when activating this Shortcut

setTrigger

public void setTrigger(@Nullable ShortcutTrigger trigger)

Sets the new trigger for this Shortcut to be trigger.

Parameters:

trigger - The new trigger. If the trigger is null, the never trigger will be used.

builder

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

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

Returns:

the builder object