Package org.gnome.gobject

Class FlagsValue

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.FlagsValue

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class FlagsValue
extends ProxyInstance

A structure which contains a single flags value, its name, and its nickname.

Constructor Summary

Constructors

Constructor	Description
FlagsValue()	Allocate a new FlagsValue.
FlagsValue(int value, String valueName, String valueNick)	Allocate a new FlagsValue with the fields set to the provided values.
FlagsValue(int value, String valueName, String valueNick, Arena arena)	Allocate a new FlagsValue with the fields set to the provided values.
FlagsValue(Arena arena)	Allocate a new FlagsValue.
FlagsValue(MemorySegment address)	Create a FlagsValue proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
int	readValue()	Read the value of the field value.
String	readValueName()	Read the value of the field value_name.
String	readValueNick()	Read the value of the field value_nick.
void	writeValue(int value)	Write a value in the field value.
void	writeValueName(String valueName, Arena _arena)	Write a value in the field value_name.
void	writeValueNick(String valueNick, Arena _arena)	Write a value in the field value_nick.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FlagsValue

public FlagsValue(MemorySegment address)

Create a FlagsValue proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FlagsValue

public FlagsValue(Arena arena)

Allocate a new FlagsValue.

Parameters:

arena - to control the memory allocation scope

FlagsValue

public FlagsValue()

Allocate a new FlagsValue. The memory is allocated with Arena.ofAuto().

FlagsValue

public FlagsValue(int value,
 String valueName,
 String valueNick,
 Arena arena)

Allocate a new FlagsValue with the fields set to the provided values.

Parameters:

value - value for the field value

valueName - value for the field valueName

valueNick - value for the field valueNick

arena - to control the memory allocation scope

FlagsValue

public FlagsValue(int value,
 String valueName,
 String valueNick)

Allocate a new FlagsValue with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

value - value for the field value

valueName - value for the field valueName

valueNick - value for the field valueNick

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readValue

public int readValue()

Read the value of the field value.

Returns:

The value of the field value

writeValue

public void writeValue(int value)

Write a value in the field value.

Parameters:

value - The new value for the field value

readValueName

public String readValueName()

Read the value of the field value_name.

Returns:

The value of the field value_name

writeValueName

public void writeValueName(String valueName,
 Arena _arena)

Write a value in the field value_name.

Parameters:

valueName - The new value for the field value_name

_arena - to control the memory allocation scope

readValueNick

public String readValueNick()

Read the value of the field value_nick.

Returns:

The value of the field value_nick

writeValueNick

public void writeValueNick(String valueNick,
 Arena _arena)

Write a value in the field value_nick.

Parameters:

valueNick - The new value for the field value_nick

_arena - to control the memory allocation scope