Package org.gnome.gtk

Class SignalAction

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.ShortcutAction

org.gnome.gtk.SignalAction

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.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 org.gnome.gtk.ShortcutAction

ShortcutAction.ShortcutActionClass, ShortcutAction.ShortcutActionImpl

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

GObject.NotifyCallback, GObject.ObjectClass

Field Summary

Fields inherited from class io.github.jwharm.javagi.base.ProxyInstance

address

Constructor Summary

Constructors

Constructor	Description
SignalAction()	Creates a new SignalAction.
SignalAction(MemorySegment address)	Create a SignalAction proxy 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()	Returns 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.
String	getSignalName()	Returns the name of the signal that will be emitted.
static Type	getType()	Get the GType of the SignalAction class

Methods inherited from class org.gnome.gtk.ShortcutAction

activate, activate, parseString, print, toString

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

SignalAction

public SignalAction(MemorySegment address)

Create a SignalAction proxy 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()

Creates a new SignalAction.

Method Details

getType

public static Type getType()

Get the GType of the SignalAction class

Returns:

the GType

asParent

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

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().