Maintainer | gtk2hs-users@lists.sourceforge.net |
---|---|
Stability | provisional |
Portability | portable (depends on GHC) |
Safe Haskell | None |
Language | Haskell98 |
main event loop, and events
- type HandlerId = CUInt
- timeoutAdd :: IO Bool -> Int -> IO HandlerId
- timeoutAddFull :: IO Bool -> Priority -> Int -> IO HandlerId
- timeoutRemove :: HandlerId -> IO ()
- idleAdd :: IO Bool -> Priority -> IO HandlerId
- idleRemove :: HandlerId -> IO ()
- data IOCondition
- inputAdd :: FD -> [IOCondition] -> Priority -> IO Bool -> IO HandlerId
- inputRemove :: HandlerId -> IO ()
- type Priority = Int
- priorityLow :: Int
- priorityDefaultIdle :: Int
- priorityHighIdle :: Int
- priorityDefault :: Int
- priorityHigh :: Int
- data MainLoop
- mainLoopNew :: Maybe MainContext -> Bool -> IO MainLoop
- mainLoopRun :: MainLoop -> IO ()
- mainLoopQuit :: MainLoop -> IO ()
- mainLoopIsRunning :: MainLoop -> IO Bool
- data MainContext
- mainContextNew :: IO MainContext
- mainContextDefault :: MainContext
- mainContextIteration :: MainContext -> Bool -> IO Bool
- mainContextFindSourceById :: MainContext -> HandlerId -> IO Source
- newtype Source = Source (ForeignPtr Source)
- sourceAttach :: Source -> MainContext -> IO HandlerId
- sourceSetPriority :: Source -> Priority -> IO ()
- sourceGetPriority :: Source -> IO Priority
- sourceDestroy :: Source -> IO ()
- sourceIsDestroyed :: Source -> IO Bool
Documentation
timeoutAdd :: IO Bool -> Int -> IO HandlerId Source #
Sets a function to be called at regular intervals, with the default
priority priorityDefault
. The function is called repeatedly until it
returns False
, after which point the timeout function will not be called
again. The first call to the function will be at the end of the first interval.
Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to 'catch up' time lost in delays).
timeoutAddFull :: IO Bool -> Priority -> Int -> IO HandlerId Source #
Sets a function to be called at regular intervals, with the given
priority. The function is called repeatedly until it returns False
, after
which point the timeout function will not be called again. The first call
to the function will be at the end of the first interval.
Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to 'catch up' time lost in delays).
timeoutRemove :: HandlerId -> IO () Source #
Remove a previously added timeout handler by its HandlerId
.
idleAdd :: IO Bool -> Priority -> IO HandlerId Source #
Add a callback that is called whenever the system is idle.
- A priority can be specified via an integer. This should usually be
priorityDefaultIdle
. - If the function returns
False
it will be removed.
data IOCondition Source #
Flags representing a condition to watch for on a file descriptor.
IOIn
- There is data to read.
IOOut
- Data can be written (without blocking).
IOPri
- There is urgent data to read.
IOErr
- Error condition.
IOHup
- Hung up (the connection has been broken, usually for pipes and sockets).
IOInvalid
- Invalid request. The file descriptor is not open.
:: FD | a file descriptor |
-> [IOCondition] | the condition to watch for |
-> Priority | the priority of the event source |
-> IO Bool | the function to call when the condition is satisfied. The function should return False if the event source should be removed. |
-> IO HandlerId | the event source id |
Adds the file descriptor into the main event loop with the given priority.
inputRemove :: HandlerId -> IO () Source #
priorityLow :: Int Source #
priorityHigh :: Int Source #
:: Maybe MainContext |
|
-> Bool |
|
-> IO MainLoop | the new |
Create a new MainLoop
.
mainLoopRun :: MainLoop -> IO () Source #
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.
mainLoopQuit :: MainLoop -> IO () Source #
Stops a MainLoop
from running. Any calls to mainLoopRun for the
loop will return.
mainLoopIsRunning :: MainLoop -> IO Bool Source #
Checks to see if the main loop is currently being run via mainLoopRun.
data MainContext Source #
An opaque datatype representing a set of sources to be handled in a main loop.
mainContextNew :: IO MainContext Source #
Creates a new MainContext
.
mainContextDefault :: MainContext Source #
The default MainContext
. This is the main context used for main
loop functions when a main loop is not explicitly specified.
mainContextIteration :: MainContext -> Bool -> IO Bool Source #
Runs a single iteration for the given main loop. This involves
checking to see if any event sources are ready to be processed,
then if no events sources are ready and mayBlock
is True
,
waiting for a source to become ready, then dispatching the
highest priority events sources that are ready. Note that even
when mayBlock
is True
, it is still possible for
mainContextIteration
to return (0), since the the wait
may be interrupted for other reasons than an event source
becoming ready.
mainContextFindSourceById :: MainContext -> HandlerId -> IO Source Source #
sourceAttach :: Source -> MainContext -> IO HandlerId Source #
sourceDestroy :: Source -> IO () Source #