Package org.gnome.gtksourceview

Class RegionIter

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gtksourceview.RegionIter

All Implemented Interfaces:

Proxy

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

An opaque datatype.

Ignore all its fields and initialize the iter with Region.getStartRegionIter(org.gnome.gtksourceview.RegionIter).

Constructor Summary

Constructors

Constructor	Description
RegionIter()	Allocate a new RegionIter.
RegionIter(Arena arena)	Allocate a new RegionIter.
RegionIter(MemorySegment address)	Create a RegionIter proxy instance for the provided memory address.
RegionIter(MemorySegment dummy1, int dummy2, MemorySegment dummy3)	Allocate a new RegionIter with the fields set to the provided values.
RegionIter(MemorySegment dummy1, int dummy2, MemorySegment dummy3, Arena arena)	Allocate a new RegionIter with the fields set to the provided values.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getSubregion(@Nullable TextIter start, @Nullable TextIter end)	Gets the subregion at this iterator.
boolean	isEnd()
boolean	next()	Moves this RegionIter to the next subregion.
MemorySegment	readDummy1()	Read the value of the field dummy1.
int	readDummy2()	Read the value of the field dummy2.
MemorySegment	readDummy3()	Read the value of the field dummy3.
void	writeDummy1(MemorySegment dummy1)	Write a value in the field dummy1.
void	writeDummy2(int dummy2)	Write a value in the field dummy2.
void	writeDummy3(MemorySegment dummy3)	Write a value in the field dummy3.

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

RegionIter

public RegionIter(MemorySegment address)

Create a RegionIter proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

RegionIter

public RegionIter(Arena arena)

Allocate a new RegionIter.

Parameters:

arena - to control the memory allocation scope

RegionIter

public RegionIter()

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

RegionIter

public RegionIter(MemorySegment dummy1,
 int dummy2,
 MemorySegment dummy3,
 Arena arena)

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

Parameters:

dummy1 - value for the field dummy1

dummy2 - value for the field dummy2

dummy3 - value for the field dummy3

arena - to control the memory allocation scope

RegionIter

public RegionIter(MemorySegment dummy1,
 int dummy2,
 MemorySegment dummy3)

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

Parameters:

dummy1 - value for the field dummy1

dummy2 - value for the field dummy2

dummy3 - value for the field dummy3

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readDummy1

public MemorySegment readDummy1()

Read the value of the field dummy1.

Returns:

The value of the field dummy1

writeDummy1

public void writeDummy1(MemorySegment dummy1)

Write a value in the field dummy1.

Parameters:

dummy1 - The new value for the field dummy1

readDummy2

public int readDummy2()

Read the value of the field dummy2.

Returns:

The value of the field dummy2

writeDummy2

public void writeDummy2(int dummy2)

Write a value in the field dummy2.

Parameters:

dummy2 - The new value for the field dummy2

readDummy3

public MemorySegment readDummy3()

Read the value of the field dummy3.

Returns:

The value of the field dummy3

writeDummy3

public void writeDummy3(MemorySegment dummy3)

Write a value in the field dummy3.

Parameters:

dummy3 - The new value for the field dummy3

getSubregion

public boolean getSubregion(@Nullable TextIter start,
 @Nullable TextIter end)

Gets the subregion at this iterator.

Parameters:

start - iterator to initialize with the subregion start, or null.

end - iterator to initialize with the subregion end, or null.

Returns:

true if start and end have been set successfully (if non-null), or false if this RegionIter is the end iterator or if the region is empty.

isEnd

public boolean isEnd()

next

public boolean next()

Moves this RegionIter to the next subregion.

Returns:

true if this RegionIter moved and is dereferenceable, or false if this RegionIter has been set to the end iterator.