nimterm/app

This page is generated from the module’s exported API and ## documentation comments.

Small, deterministic application shell for widgets and event sources.

Types

EventSource

EventSource = ref object of RootObj
  id*: string

View source

App

App = object
  backend*: TerminalBackend
  root*: Widget
  queue*: EventQueue
  size*: Size
  frame*: Canvas
  running*: bool
  dirty*: bool
  focus*: Widget
  mouseCapture*: Widget
  onEvent*: proc (app: var App; event: UiEvent): EventResponse {.closure.}
  onAction*: proc (app: var App; action: UiAction) {.closure.}
  pollIntervalMs*: int
  minFrameIntervalMs*: int
  sources*: seq[EventSource]

View source

Methods

poll

method poll(source: EventSource): seq[UiEvent] {.base, raises: [], tags: [],
    forbids: [].}

Returns: seq[UiEvent].

Arguments

Name	Type	Default
source	EventSource

View source

close

method close(source: EventSource) {.base, raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
source	EventSource

View source

needsPolling

method needsPolling(source: EventSource): bool {.base, raises: [], tags: [],
    forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
source	EventSource

View source

Procedures

newApp

proc newApp(backend: TerminalBackend; root: Widget = nil): App {.raises: [],
    tags: [ReadEnvEffect, TimeEffect], forbids: [].}

Returns: App.

Arguments

Name	Type	Default
backend	TerminalBackend
root	Widget	nil

View source

addSource

proc addSource(app: var App; source: EventSource) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
app	var App
source	EventSource

View source

schedule

proc schedule(app: var App; id: string; delayMs: int; intervalMs = 0) {.
    raises: [], tags: [TimeEffect], forbids: [].}

Arguments

Name	Type	Default
app	var App
id	string
delayMs	int
intervalMs	inferred	0

View source

cancelTimer

proc cancelTimer(app: var App; id: string) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
app	var App
id	string

View source

invalidate

proc invalidate(app: var App) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
app	var App

View source

post

proc post(app: var App; event: UiEvent) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
app	var App
event	UiEvent

View source

focus

proc focus(app: var App; widget: Widget) {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
app	var App
widget	Widget

View source

dispatch

proc dispatch(app: var App; event: UiEvent) {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
app	var App
event	UiEvent

View source

render

proc render(app: var App) {.raises: [Exception, IOError],
                            tags: [TimeEffect, RootEffect, WriteIOEffect],
                            forbids: [].}

Arguments

Name	Type	Default
app	var App

View source

flush

proc flush(app: var App; force = false) {.raises: [Exception, IOError],
    tags: [TimeEffect, RootEffect, WriteIOEffect], forbids: [].}

Arguments

Name	Type	Default
app	var App
force	inferred	false

View source

step

Process one queued/backend event and render if invalidated.

proc step(app: var App; timeoutMs = 0): bool {.
    raises: [Exception, Exception, IOError],
    tags: [RootEffect, TimeEffect, WriteIOEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
app	var App
timeoutMs	inferred	0

View source

pump

proc pump(app: var App; timeoutMs = 0): bool {.raises: [Exception, IOError],
    tags: [RootEffect, TimeEffect, WriteIOEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
app	var App
timeoutMs	inferred	0

View source

run

proc run(app: var App) {.raises: [ValueError, Exception, IOError],
                         tags: [RootEffect, TimeEffect, WriteIOEffect],
                         forbids: [].}

Arguments

Name	Type	Default
app	var App

View source