Package org.gnome.gtk

Class ShortcutAction

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ShortcutAction

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

ActivateAction, CallbackAction, MnemonicAction, NamedAction, NothingAction, ShortcutAction.ShortcutActionImpl, SignalAction

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

GtkShortcutAction encodes an action that can be triggered by a keyboard shortcut.

GtkShortcutActions contain functions that allow easy presentation to end users as well as being printed for debugging.

All GtkShortcutActions are immutable, you can only specify their properties during construction. If you want to change a action, you have to replace it with a new one. If you need to pass arguments to an action, these are specified by the higher-level GtkShortcut object.

To activate a GtkShortcutAction manually, activate(java.util.Set<org.gnome.gtk.ShortcutActionFlags>, org.gnome.gtk.Widget, org.gnome.glib.Variant) can be called.

GTK provides various actions:

• MnemonicAction: a shortcut action that calls gtk_widget_mnemonic_activate()
• CallbackAction: a shortcut action that invokes a given callback
• SignalAction: a shortcut action that emits a given signal
• ActivateAction: a shortcut action that calls gtk_widget_activate()
• NamedAction: a shortcut action that calls gtk_widget_activate_action()
• NothingAction: a shortcut action that does nothing

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShortcutAction.Builder<B extends ShortcutAction.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ShortcutAction.ShortcutActionClass
static class	ShortcutAction.ShortcutActionImpl	The ShortcutActionImpl type represents a native instance of the abstract ShortcutAction class.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	activate(Set<ShortcutActionFlags> flags, Widget widget, @Nullable Variant args)	Activates the action on the widget with the given args.
boolean	activate(ShortcutActionFlags flags, Widget widget, @Nullable Variant args)	Activates the action on the widget with the given args.
protected ShortcutAction	asParent()	Returns this instance as if it were its parent type.
static ShortcutAction.Builder<? extends ShortcutAction.Builder>	builder()	A ShortcutAction.Builder object constructs a ShortcutAction with the specified properties.
static Type	getType()	Get the GType of the ShortcutAction class
static ShortcutAction	parseString(String string)	Tries to parse the given string into an action.
void	print(GString string)	Prints the given action into a string for the developer.
String	toString()	Prints the given action into a human-readable string.

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

Constructor Details

ShortcutAction

public ShortcutAction(MemorySegment address)

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

Returns:

the GType

asParent

protected ShortcutAction 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

parseString

public static ShortcutAction parseString(String string)

Tries to parse the given string into an action.

On success, the parsed action is returned. When parsing failed, null is returned.

The accepted strings are:

• nothing, for GtkNothingAction
• activate, for GtkActivateAction
• mnemonic-activate, for GtkMnemonicAction
• action(NAME), for a GtkNamedAction for the action named NAME
• signal(NAME), for a GtkSignalAction for the signal NAME

Parameters:

string - the string to parse

Returns:

a new GtkShortcutAction

activate

public boolean activate(Set<ShortcutActionFlags> flags,
 Widget widget,
 @Nullable
 @Nullable Variant args)

Activates the action on the widget with the given args.

Note that some actions ignore the passed in flags, widget or args.

Activation of an action can fail for various reasons. If the action is not supported by the widget, if the args don't match the action or if the activation otherwise had no effect, false will be returned.

Parameters:

flags - flags to activate with

widget - Target of the activation

args - arguments to pass

Returns:

true if this action was activated successfully

activate

public boolean activate(ShortcutActionFlags flags,
 Widget widget,
 @Nullable
 @Nullable Variant args)

Activates the action on the widget with the given args.

Note that some actions ignore the passed in flags, widget or args.

Activation of an action can fail for various reasons. If the action is not supported by the widget, if the args don't match the action or if the activation otherwise had no effect, false will be returned.

Parameters:

flags - flags to activate with

widget - Target of the activation

args - arguments to pass

Returns:

true if this action was activated successfully

print

public void print(GString string)

Prints the given action into a string for the developer.

This is meant for debugging and logging.

The form of the representation may change at any time and is not guaranteed to stay identical.

Parameters:

string - a GString to print into

toString

public String toString()

Prints the given action into a human-readable string.

This is a small wrapper around print(org.gnome.glib.GString) to help when debugging.

Overrides:

toString in class Object

Returns:

a new string

builder

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

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