Enum Class SignalFlags

java.lang.Object

java.lang.Enum<SignalFlags>

org.gnome.gobject.SignalFlags

All Implemented Interfaces:

Serializable, Comparable<SignalFlags>, Constable, Enumeration

@Generated("org.javagi.JavaGI")
public enum SignalFlags
extends Enum<SignalFlags>
implements Enumeration

The signal flags are used to specify a signal's behaviour.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCUMULATOR_FIRST_RUN	The signal accumulator was invoked for the first time.
ACTION	Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object.
DEPRECATED	The signal is deprecated and will be removed in a future version.
DETAILED	This signal supports "::detail" appendices to the signal name upon handler connections and emissions.
MUST_COLLECT	Varargs signal emission will always collect the arguments, even if there are no signal handlers connected.
NO_HOOKS	No emissions hooks are supported for this signal.
NO_RECURSE	Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted.
RUN_CLEANUP	Invoke the object method handler in the last emission stage.
RUN_FIRST	Invoke the object method handler in the first emission stage.
RUN_LAST	Invoke the object method handler in the third emission stage.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Get the numeric value of this enum
static Set<SignalFlags>	of(int flags)	Create a new EnumSet<SignalFlags> for the provided bitfield
static Set<SignalFlags>	of(MemorySegment address)	Create a new EnumSet<SignalFlags> for the bitfield in the provided memory address.
static SignalFlags	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SignalFlags[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RUN_FIRST

public static final SignalFlags RUN_FIRST

Invoke the object method handler in the first emission stage.

RUN_LAST

public static final SignalFlags RUN_LAST

Invoke the object method handler in the third emission stage.

RUN_CLEANUP

public static final SignalFlags RUN_CLEANUP

Invoke the object method handler in the last emission stage.

NO_RECURSE

public static final SignalFlags NO_RECURSE

Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted.

DETAILED

public static final SignalFlags DETAILED

This signal supports "::detail" appendices to the signal name upon handler connections and emissions.

ACTION

public static final SignalFlags ACTION

Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or post emission adjustments on the object. They can also be thought of as object methods which can be called generically by third-party code.

NO_HOOKS

public static final SignalFlags NO_HOOKS

No emissions hooks are supported for this signal.

MUST_COLLECT

public static final SignalFlags MUST_COLLECT

Varargs signal emission will always collect the arguments, even if there are no signal handlers connected.

Since:

2.30

DEPRECATED

public static final SignalFlags DEPRECATED

The signal is deprecated and will be removed in a future version.

A warning will be generated if it is connected while running with G_ENABLE_DIAGNOSTIC=1.

Since:

2.32

ACCUMULATOR_FIRST_RUN

public static final SignalFlags ACCUMULATOR_FIRST_RUN

The signal accumulator was invoked for the first time.

This flag is only used in GObject.SignalAccumulator``GObject.SignalInvocationHint, to mark the first call to the accumulator function for a signal emission.

Since:

2.68

Method Details

values

public static SignalFlags[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SignalFlags valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

of

public static Set<SignalFlags> of(int flags)

Create a new EnumSet<SignalFlags> for the provided bitfield

Parameters:

flags - the SignalFlags bitfield

Returns:

the EnumSet for the provided bitfield

of

public static Set<SignalFlags> of(MemorySegment address)

Create a new EnumSet<SignalFlags> for the bitfield in the provided memory address.

Parameters:

address - the memory address holding a bitfield value

Returns:

the EnumSet for the bitfield in the provided memory address