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.Timer

Contents

Exported types
Methods

Description

Opaque datatype that records a start time.

Synopsis

Exported types

newtype Timer Source #

Constructors

Timer (ManagedPtr Timer)

Instances

WrappedPtr Timer Source #
Methods wrappedPtrCalloc :: IO (Ptr Timer) # wrappedPtrCopy :: Timer -> IO Timer # wrappedPtrFree :: Maybe (FunPtr (Ptr Timer -> IO ())) #
((~) * info (ResolveTimerMethod t Timer), MethodInfo * info Timer p) => IsLabel t (Timer -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> Timer -> p #
((~) * info (ResolveTimerMethod t Timer), MethodInfo * info Timer p) => IsLabelProxy t (Timer -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> Timer -> p #
HasAttributeList * Timer Source #

((~) * signature (m ()), MonadIO m) => MethodInfo * TimerStopMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerStopMethodInfo Timer -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * TimerStartMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerStartMethodInfo Timer -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * TimerResetMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerResetMethodInfo Timer -> signature -> s #
((~) * signature (CULong -> m Double), MonadIO m) => MethodInfo * TimerElapsedMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerElapsedMethodInfo Timer -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * TimerDestroyMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerDestroyMethodInfo Timer -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * TimerContinueMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerContinueMethodInfo Timer -> signature -> s #
type AttributeList Timer Source #
type AttributeList Timer

noTimer :: Maybe Timer Source #

Methods

continue

data TimerContinueMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * TimerContinueMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerContinueMethodInfo Timer -> signature -> s #

timerContinue Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Timer	`timer`: a `Timer`.
-> m ()

Resumes a timer that has previously been stopped with timerStop. timerStop must be called before using this function.

Since: 2.4

destroy

data TimerDestroyMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * TimerDestroyMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerDestroyMethodInfo Timer -> signature -> s #

timerDestroy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Timer	`timer`: a `Timer` to destroy.
-> m ()

Destroys a timer, freeing associated resources.

elapsed

data TimerElapsedMethodInfo Source #

Instances

((~) * signature (CULong -> m Double), MonadIO m) => MethodInfo * TimerElapsedMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerElapsedMethodInfo Timer -> signature -> s #

timerElapsed Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Timer	`timer`: a `Timer`.
-> CULong	`microseconds`: return location for the fractional part of seconds elapsed, in microseconds (that is, the total number of microseconds elapsed, modulo 1000000), or `Nothing`
-> m Double	Returns: seconds elapsed as a floating point value, including any fractional part.

If timer has been started but not stopped, obtains the time since the timer was started. If timer has been stopped, obtains the elapsed time between the time it was started and the time it was stopped. The return value is the number of seconds elapsed, including any fractional part. The microseconds out parameter is essentially useless.

reset

data TimerResetMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * TimerResetMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerResetMethodInfo Timer -> signature -> s #

timerReset Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Timer	`timer`: a `Timer`.
-> m ()

This function is useless; it's fine to call timerStart on an already-started timer to reset the start time, so timerReset serves no purpose.

start

data TimerStartMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * TimerStartMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerStartMethodInfo Timer -> signature -> s #

timerStart Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Timer	`timer`: a `Timer`.
-> m ()

Marks a start time, so that future calls to timerElapsed will report the time since timerStart was called. g_timer_new() automatically marks the start time, so no need to call timerStart immediately after creating the timer.

stop

data TimerStopMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * TimerStopMethodInfo Timer signature Source #
Methods overloadedMethod :: MethodProxy TimerStopMethodInfo Timer -> signature -> s #

timerStop Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Timer	`timer`: a `Timer`.
-> m ()

Marks an end time, so calls to timerElapsed will return the difference between this end time and the start time.