GLib.MainLoop

Fields

None

Methods

class	new (context, is_running)
	get_context ()
	is_running ()
	quit ()
	ref ()
	run ()
	unref ()

Details

class GLib.MainLoop(context=None)

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

classmethod new(context, is_running)

Parameters:

• context (GLib.MainContext or None) – a GLib.MainContext (if None, the global-default main context will be used).

• is_running (bool) – set to True to indicate that the loop is running. This is not very important since calling [method`GLib`.MainLoop.run] will set this to True anyway.

Returns:

a new GLib.MainLoop.

Return type:

GLib.MainLoop

Creates a new [struct`GLib`.MainLoop] structure.

get_context()

Returns:

the [struct`GLib`.MainContext] of self

Return type:

GLib.MainContext

Returns the [struct`GLib`.MainContext] of self.

is_running()

Returns:

True if the mainloop is currently being run.

Return type:

bool

Checks to see if the main loop is currently being run via [method`GLib`.MainLoop.run].

quit()

Stops a [struct`GLib`.MainLoop] from running. Any calls to [method`GLib`.MainLoop.run] for the loop will return.

Note that sources that have already been dispatched when [method`GLib`.MainLoop.quit] is called will still be executed.

ref()

Returns:

self

Return type:

GLib.MainLoop

Increases the reference count on a [struct`GLib`.MainLoop] object by one.

run()

Runs a main loop until [method`GLib`.MainLoop.quit] is called on the loop. If this is called for the thread of the loop’s GLib.MainContext, it will process events from the loop, otherwise it will simply wait.

unref()

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