gi-glib
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GLib.Structs.MainLoop

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

Instances details
Eq MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

GBoxed MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

ManagedPtrNewtype MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

TypedObject MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

glibType :: IO GType #

HasParentTypes MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

HasAttributeList MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

(signature ~ m MainContext, MonadIO m) => OverloadedMethod MainLoopGetContextMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

(signature ~ m Bool, MonadIO m) => OverloadedMethod MainLoopIsRunningMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod MainLoopQuitMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

(signature ~ m MainLoop, MonadIO m) => OverloadedMethod MainLoopRefMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod MainLoopRunMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

(signature ~ m (), MonadIO m) => OverloadedMethod MainLoopUnrefMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

OverloadedMethodInfo MainLoopGetContextMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

OverloadedMethodInfo MainLoopIsRunningMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

OverloadedMethodInfo MainLoopQuitMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

OverloadedMethodInfo MainLoopRefMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

OverloadedMethodInfo MainLoopRunMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

OverloadedMethodInfo MainLoopUnrefMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

(info ~ ResolveMainLoopMethod t MainLoop, OverloadedMethod info MainLoop p, HasField t MainLoop p) => HasField (t :: Symbol) MainLoop (p :: Type) Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

getField :: MainLoop -> p #

(info ~ ResolveMainLoopMethod t MainLoop, OverloadedMethodInfo info MainLoop) => IsLabel t (MethodProxy info MainLoop) Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

(info ~ ResolveMainLoopMethod t MainLoop, OverloadedMethod info MainLoop p) => IsLabel t (MainLoop -> p) Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

fromLabel :: MainLoop -> p #

IsGValue (Maybe MainLoop) Source #

Convert MainLoop to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.GLib.Structs.MainLoop

type AttributeList MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

type ParentTypes MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

type ParentTypes MainLoop = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

isRunning, quit, ref, run, unref.

Getters

getContext.

Setters

None.

getContext

mainLoopGetContext Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a main loop

-> m MainContext

Returns: the MainContext of loop

Returns the MainContext of loop.

isRunning

mainLoopIsRunning Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a main loop

-> m Bool

Returns: true if the main loop is currently being run, false otherwise

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

new

mainLoopNew Source #

Arguments

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

context: a main context (if NULL, the global-default main 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 main loop

Creates a new MainLoop structure.

quit

data MainLoopQuitMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod MainLoopQuitMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

OverloadedMethodInfo MainLoopQuitMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

mainLoopQuit Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a main loop

-> 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 main loop

-> m MainLoop

Returns: loop

Increases the reference count on a MainLoop object by one.

run

data MainLoopRunMethodInfo Source #

Instances

Instances details
(signature ~ m (), MonadIO m) => OverloadedMethod MainLoopRunMethodInfo MainLoop signature Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

Methods

overloadedMethod :: MainLoop -> signature #

OverloadedMethodInfo MainLoopRunMethodInfo MainLoop Source # 
Instance details

Defined in GI.GLib.Structs.MainLoop

mainLoopRun Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> MainLoop

loop: a main loop

-> m () 

Runs a main loop until mainLoopQuit is called on the loop.

If this is called from 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 main loop

-> m () 

Decreases the reference count on a MainLoop object by one.

If the result is zero, the loop and all associated memory are freed.