| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
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
- newtype MainLoop = MainLoop (ManagedPtr MainLoop)
- type family ResolveMainLoopMethod (t :: Symbol) o where ...
- data MainLoopGetContextMethodInfo
- mainLoopGetContext :: (HasCallStack, MonadIO m) => MainLoop -> m MainContext
- data MainLoopIsRunningMethodInfo
- mainLoopIsRunning :: (HasCallStack, MonadIO m) => MainLoop -> m Bool
- mainLoopNew :: (HasCallStack, MonadIO m) => Maybe MainContext -> Bool -> m MainLoop
- data MainLoopQuitMethodInfo
- mainLoopQuit :: (HasCallStack, MonadIO m) => MainLoop -> m ()
- data MainLoopRefMethodInfo
- mainLoopRef :: (HasCallStack, MonadIO m) => MainLoop -> m MainLoop
- data MainLoopRunMethodInfo
- mainLoopRun :: (HasCallStack, MonadIO m) => MainLoop -> m ()
- data MainLoopUnrefMethodInfo
- mainLoopUnref :: (HasCallStack, MonadIO m) => MainLoop -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| MainLoop (ManagedPtr MainLoop) |
Instances
Methods
Click to display all available methods, including inherited ones
type family ResolveMainLoopMethod (t :: Symbol) o where ... Source #
Equations
| ResolveMainLoopMethod "isRunning" o = MainLoopIsRunningMethodInfo | |
| ResolveMainLoopMethod "quit" o = MainLoopQuitMethodInfo | |
| ResolveMainLoopMethod "ref" o = MainLoopRefMethodInfo | |
| ResolveMainLoopMethod "run" o = MainLoopRunMethodInfo | |
| ResolveMainLoopMethod "unref" o = MainLoopUnrefMethodInfo | |
| ResolveMainLoopMethod "getContext" o = MainLoopGetContextMethodInfo | |
| ResolveMainLoopMethod l o = MethodResolutionFailed l o :: Type |
getContext
data MainLoopGetContextMethodInfo Source #
Instances
| (signature ~ m MainContext, MonadIO m) => OverloadedMethod MainLoopGetContextMethodInfo MainLoop signature Source # | |
Defined in GI.GLib.Structs.MainLoop Methods overloadedMethod :: MainLoop -> signature # | |
| OverloadedMethodInfo MainLoopGetContextMethodInfo MainLoop Source # | |
Defined in GI.GLib.Structs.MainLoop Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => MainLoop |
|
| -> m MainContext | Returns: the |
Returns the MainContext of loop.
isRunning
data MainLoopIsRunningMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m) => OverloadedMethod MainLoopIsRunningMethodInfo MainLoop signature Source # | |
Defined in GI.GLib.Structs.MainLoop Methods overloadedMethod :: MainLoop -> signature # | |
| OverloadedMethodInfo MainLoopIsRunningMethodInfo MainLoop Source # | |
Defined in GI.GLib.Structs.MainLoop Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => MainLoop |
|
| -> 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
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Maybe MainContext |
|
| -> Bool |
|
| -> m MainLoop | Returns: a new main loop |
Creates a new MainLoop structure.
quit
data MainLoopQuitMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod MainLoopQuitMethodInfo MainLoop signature Source # | |
Defined in GI.GLib.Structs.MainLoop Methods overloadedMethod :: MainLoop -> signature # | |
| OverloadedMethodInfo MainLoopQuitMethodInfo MainLoop Source # | |
Defined in GI.GLib.Structs.MainLoop Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => 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
data MainLoopRefMethodInfo Source #
Instances
| (signature ~ m MainLoop, MonadIO m) => OverloadedMethod MainLoopRefMethodInfo MainLoop signature Source # | |
Defined in GI.GLib.Structs.MainLoop Methods overloadedMethod :: MainLoop -> signature # | |
| OverloadedMethodInfo MainLoopRefMethodInfo MainLoop Source # | |
Defined in GI.GLib.Structs.MainLoop Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => MainLoop |
|
| -> m MainLoop | Returns: |
Increases the reference count on a MainLoop object by one.
run
data MainLoopRunMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod MainLoopRunMethodInfo MainLoop signature Source # | |
Defined in GI.GLib.Structs.MainLoop Methods overloadedMethod :: MainLoop -> signature # | |
| OverloadedMethodInfo MainLoopRunMethodInfo MainLoop Source # | |
Defined in GI.GLib.Structs.MainLoop Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => MainLoop |
|
| -> 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
data MainLoopUnrefMethodInfo Source #
Instances
| (signature ~ m (), MonadIO m) => OverloadedMethod MainLoopUnrefMethodInfo MainLoop signature Source # | |
Defined in GI.GLib.Structs.MainLoop Methods overloadedMethod :: MainLoop -> signature # | |
| OverloadedMethodInfo MainLoopUnrefMethodInfo MainLoop Source # | |
Defined in GI.GLib.Structs.MainLoop Methods | |
Arguments
| :: (HasCallStack, MonadIO m) | |
| => MainLoop |
|
| -> m () |
Decreases the reference count on a MainLoop object by one.
If the result is zero, the loop and all associated memory are freed.