Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
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.
- newtype MainLoop = MainLoop (ManagedPtr MainLoop)
- noMainLoop :: Maybe MainLoop
- 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
Constructors
MainLoop (ManagedPtr MainLoop) |
Instances
BoxedObject MainLoop # | |
((~) * info (ResolveMainLoopMethod t MainLoop), MethodInfo * info MainLoop p) => IsLabel t (MainLoop -> p) # | |
((~) * info (ResolveMainLoopMethod t MainLoop), MethodInfo * info MainLoop p) => IsLabelProxy t (MainLoop -> p) # | |
HasAttributeList * MainLoop # | |
((~) * signature (m ()), MonadIO m) => MethodInfo * MainLoopUnrefMethodInfo MainLoop signature # | |
((~) * signature (m ()), MonadIO m) => MethodInfo * MainLoopRunMethodInfo MainLoop signature # | |
((~) * signature (m MainLoop), MonadIO m) => MethodInfo * MainLoopRefMethodInfo MainLoop signature # | |
((~) * signature (m ()), MonadIO m) => MethodInfo * MainLoopQuitMethodInfo MainLoop signature # | |
((~) * signature (m Bool), MonadIO m) => MethodInfo * MainLoopIsRunningMethodInfo MainLoop signature # | |
((~) * signature (m MainContext), MonadIO m) => MethodInfo * MainLoopGetContextMethodInfo MainLoop signature # | |
type AttributeList MainLoop # | |
noMainLoop :: Maybe MainLoop #
Methods
getContext
data MainLoopGetContextMethodInfo #
Instances
((~) * signature (m MainContext), MonadIO m) => MethodInfo * MainLoopGetContextMethodInfo MainLoop signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> MainLoop |
|
-> m MainContext | Returns: the |
Returns the MainContext
of loop
.
isRunning
data MainLoopIsRunningMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m) => MethodInfo * MainLoopIsRunningMethodInfo MainLoop signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> MainLoop |
|
-> m Bool | Returns: |
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 |
Creates a new MainLoop
structure.
quit
data MainLoopQuitMethodInfo #
Instances
((~) * signature (m ()), MonadIO m) => MethodInfo * MainLoopQuitMethodInfo MainLoop signature # | |
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 #
Instances
((~) * signature (m MainLoop), MonadIO m) => MethodInfo * MainLoopRefMethodInfo MainLoop signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> MainLoop |
|
-> m MainLoop | Returns: |
Increases the reference count on a MainLoop
object by one.
run
data MainLoopRunMethodInfo #
Instances
((~) * signature (m ()), MonadIO m) => MethodInfo * MainLoopRunMethodInfo MainLoop signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> 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
data MainLoopUnrefMethodInfo #
Instances
((~) * signature (m ()), MonadIO m) => MethodInfo * MainLoopUnrefMethodInfo MainLoop signature # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> 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.