Package org.gnome.gtk

Class ShortcutTrigger

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ShortcutTrigger

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

AlternativeTrigger, KeyvalTrigger, MnemonicTrigger, NeverTrigger, ShortcutTrigger.ShortcutTriggerImpl

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

GtkShortcutTrigger tracks how a GtkShortcut should be activated.

To find out if a GtkShortcutTrigger triggers, you can call trigger(org.gnome.gdk.Event, boolean) on a GdkEvent.

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

All GtkShortcutTriggers are immutable, you can only specify their properties during construction. If you want to change a trigger, you have to replace it with a new one.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ShortcutTrigger	asParent()	Returns this instance as if it were its parent type.
static ShortcutTrigger.Builder<? extends ShortcutTrigger.Builder>	builder()	A ShortcutTrigger.Builder object constructs a ShortcutTrigger with the specified properties.
int	compare(ShortcutTrigger trigger2)	The types of this ShortcutTrigger and trigger2 are gconstpointer only to allow use of this function as a GCompareFunc.
boolean	equal(ShortcutTrigger trigger2)	Checks if this ShortcutTrigger and trigger2 trigger under the same conditions.
static Type	getType()	Get the GType of the ShortcutTrigger class
int	hash()	Generates a hash value for a GtkShortcutTrigger.
static ShortcutTrigger	parseString(String string)	Tries to parse the given string into a trigger.
void	print(GString string)	Prints the given trigger into a string for the developer.
boolean	printLabel(Display display, GString string)	Prints the given trigger into a string.
String	toLabel(Display display)	Gets textual representation for the given trigger.
String	toString()	Prints the given trigger into a human-readable string.
KeyMatch	trigger(Event event, boolean enableMnemonics)	Checks if the given event triggers this ShortcutTrigger.

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

ShortcutTrigger

public ShortcutTrigger(MemorySegment address)

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

Returns:

the GType

asParent

protected ShortcutTrigger 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 ShortcutTrigger parseString(String string)

Tries to parse the given string into a trigger.

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

The accepted strings are:

• never, for GtkNeverTrigger
• a string parsed by gtk_accelerator_parse(), for a GtkKeyvalTrigger, e.g. <Control>C
• underscore, followed by a single character, for GtkMnemonicTrigger, e.g. _l
• two valid trigger strings, separated by a | character, for a GtkAlternativeTrigger: <Control>q|<Control>w

Note that you will have to escape the < and > characters when specifying triggers in XML files, such as GtkBuilder ui files. Use < instead of < and > instead of >.

Parameters:

string - the string to parse

Returns:

a new GtkShortcutTrigger

compare

public int compare(ShortcutTrigger trigger2)

The types of this ShortcutTrigger and trigger2 are gconstpointer only to allow use of this function as a GCompareFunc.

They must each be a GtkShortcutTrigger.

Parameters:

trigger2 - a GtkShortcutTrigger

Returns:

An integer less than, equal to, or greater than zero if this ShortcutTrigger is found, respectively, to be less than, to match, or be greater than trigger2.

equal

public boolean equal(ShortcutTrigger trigger2)

Checks if this ShortcutTrigger and trigger2 trigger under the same conditions.

The types of one and two are gconstpointer only to allow use of this function with GHashTable. They must each be a GtkShortcutTrigger.

Parameters:

trigger2 - a GtkShortcutTrigger

Returns:

true if this ShortcutTrigger and trigger2 are equal

hash

public int hash()

Generates a hash value for a GtkShortcutTrigger.

The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor architectures or even different versions of GTK. Do not use this function as a basis for building protocols or file formats.

The types of this ShortcutTrigger is gconstpointer only to allow use of this function with GHashTable. They must each be a GtkShortcutTrigger.

Returns:

a hash value corresponding to this ShortcutTrigger

print

public void print(GString string)

Prints the given trigger 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

printLabel

public boolean printLabel(Display display,
 GString string)

Prints the given trigger into a string.

This function is returning a translated string for presentation to end users for example in menu items or in help texts.

The display in use may influence the resulting string in various forms, such as resolving hardware keycodes or by causing display-specific modifier names.

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

Parameters:

display - GdkDisplay to print for

string - a GString to print into

Returns:

true if something was printed or false if the trigger did not have a textual representation suitable for end users.

toLabel

public String toLabel(Display display)

Gets textual representation for the given trigger.

This function is returning a translated string for presentation to end users for example in menu items or in help texts.

The display in use may influence the resulting string in various forms, such as resolving hardware keycodes or by causing display-specific modifier names.

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

Parameters:

display - GdkDisplay to print for

Returns:

a new string

toString

public String toString()

Prints the given trigger 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

trigger

public KeyMatch trigger(Event event,
 boolean enableMnemonics)

Checks if the given event triggers this ShortcutTrigger.

Parameters:

event - the event to check

enableMnemonics - true if mnemonics should trigger. Usually the value of this property is determined by checking that the passed in event is a Key event and has the right modifiers set.

Returns:

Whether the event triggered the shortcut

builder

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

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