Table of Contents

Interface ITimedEvents

Namespace
Terminal.Gui
Assembly
Terminal.Gui.dll

Manages timers and idles

public interface ITimedEvents

Properties

IdleHandlers

Returns all currently registered idles. May not include actively executing idles.

Timeouts

Returns the next planned execution time (key - UTC ticks) for each timeout that is not actively executing.

Methods

AddIdle(Func<bool>)

Adds specified idle handler function to main iteration processing. The handler function will be called once per iteration of the main loop after other events have been handled.

AddTimeout(TimeSpan, Func<bool>)

Adds a timeout to the application.

CheckTimersAndIdleHandlers(out int)

Called from Terminal.Gui.IMainLoopDriver.EventsPending() to check if there are any outstanding timers or idle handlers.

LockAndRunIdles()

Runs all idle hooks

LockAndRunTimers()

Runs all timeouts that are due

RemoveIdle(Func<bool>)

Removes an idle handler added with AddIdle(Func<bool>) from processing.

RemoveTimeout(object)

Removes a previously scheduled timeout

Events

TimeoutAdded

Invoked when a new timeout is added. To be used in the case when EndAfterFirstIteration is true.