gi-glib-2.0.17: GLib bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.MainLoop

Contents

Description

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

Synopsis

Exported types

newtype MainLoop Source #

Memory-managed wrapper type.

Constructors

MainLoop (ManagedPtr MainLoop) 
Instances
BoxedObject MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

boxedType :: MainLoop -> IO GType #

noMainLoop :: Maybe MainLoop Source #

A convenience alias for Nothing :: Maybe MainLoop.

Methods

getContext

mainLoopGetContext Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a MainLoop.

-> m MainContext

Returns: the MainContext of loop

Returns the MainContext of loop.

isRunning

mainLoopIsRunning Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a MainLoop.

-> m Bool

Returns: True if the mainloop is currently being run.

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

new

mainLoopNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Maybe MainContext

context: a MainContext (if Nothing, the default context will be used).

-> Bool

isRunning: set to True to indicate that the loop is running. This is not very important since calling mainLoopRun will set this to True anyway.

-> m MainLoop

Returns: a new MainLoop.

Creates a new MainLoop structure.

quit

mainLoopQuit Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a MainLoop

-> m () 

Stops a MainLoop from running. Any calls to mainLoopRun for the loop will return.

Note that sources that have already been dispatched when mainLoopQuit is called will still be executed.

ref

mainLoopRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a MainLoop

-> m MainLoop

Returns: loop

Increases the reference count on a MainLoop object by one.

run

mainLoopRun Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a MainLoop

-> m () 

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

unref

mainLoopUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a MainLoop

-> m () 

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