Package org.gnome.glib

Class MainLoop

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.glib.MainLoop

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class MainLoop
extends ProxyInstance

The GMainLoop struct is an opaque data type representing the main event loop of a GLib or GTK application.

Constructor Summary

Constructors

Constructor	Description
MainLoop(MemorySegment address)	Create a MainLoop proxy instance for the provided memory address.
MainLoop(@Nullable MainContext context, boolean isRunning)	Creates a new GLib.MainLoop structure.

Method Summary

Modifier and Type	Method	Description
MainContext	getContext()	Returns the GLib.MainContext of this MainLoop.
static Type	getType()	Get the GType of the MainLoop class
boolean	isRunning()	Checks to see if the main loop is currently being run via run().
void	quit()	Stops a GLib.MainLoop from running.
MainLoop	ref()	Increases the reference count on a GLib.MainLoop object by one.
void	run()	Runs a main loop until quit() is called on the loop.
void	unref()	Decreases the reference count on a GLib.MainLoop object by one.

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

Constructor Details

MainLoop

public MainLoop(MemorySegment address)

Create a MainLoop proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

MainLoop

public MainLoop(@Nullable
 @Nullable MainContext context,
 boolean isRunning)

Creates a new GLib.MainLoop structure.

Parameters:

context - a GMainContext (if null, the global-default main context will be used).

isRunning - set to true to indicate that the loop is running. This is not very important since calling run() will set this to true anyway.

Method Details

getType

public static Type getType()

Get the GType of the MainLoop class

Returns:

the GType

getContext

public MainContext getContext()

Returns the GLib.MainContext of this MainLoop.

Returns:

the GLib.MainContext of this MainLoop

isRunning

public boolean isRunning()

Checks to see if the main loop is currently being run via run().

Returns:

true if the mainloop is currently being run.

quit

public void quit()

Stops a GLib.MainLoop from running. Any calls to run() for the loop will return.

Note that sources that have already been dispatched when quit() is called will still be executed.

ref

public MainLoop ref()

Increases the reference count on a GLib.MainLoop object by one.

Returns:

this MainLoop

run

public void run()

Runs a main loop until quit() is called on the loop. If this is called for the thread of the loop's GMainContext, it will process events from the loop, otherwise it will simply wait.

unref

public void unref()

Decreases the reference count on a GLib.MainLoop object by one. If the result is zero, free the loop and free all associated memory.