Class SignalAction

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ShortcutAction

org.gnome.gtk.SignalAction

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class SignalAction
extends ShortcutAction

Emits a signal on a widget.

Signals that are used in this way are referred to as keybinding signals, and they are expected to be defined with the G_SIGNAL_ACTION flag.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class ShortcutAction

ShortcutAction.ShortcutAction$Impl, ShortcutAction.ShortcutActionClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
SignalAction()	Create a new SignalAction.
SignalAction(MemorySegment address)	Create a SignalAction instance for the provided memory address.
SignalAction(String signalName)	Creates an action that when activated, emits the given action signal on the provided widget.

Method Summary

Modifier and Type	Method	Description
protected SignalAction	asParent()	Return this instance as if it were its parent type.
static SignalAction.Builder<? extends SignalAction.Builder>	builder()	A SignalAction.Builder object constructs a SignalAction with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getSignalName()	Returns the name of the signal that will be emitted.
static @Nullable Type	getType()	Get the GType of the SignalAction class.

Methods inherited from class ShortcutAction

activate, activate, parseString, print, toString

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

Constructor Details

SignalAction

public SignalAction(MemorySegment address)

Create a SignalAction instance for the provided memory address.

Parameters:

address - the memory address of the native object

SignalAction

public SignalAction(String signalName)

Creates an action that when activated, emits the given action signal on the provided widget.

It will also unpack the args into arguments passed to the signal.

Parameters:

signalName - name of the signal to emit

SignalAction

public SignalAction()

Create a new SignalAction.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SignalAction class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

Returns:

the instance as if it were its parent type

getSignalName

public String getSignalName()

Returns the name of the signal that will be emitted.

Returns:

the name of the signal to emit

builder

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

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

Returns:

the builder object