nimterm/backend

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

Platform-neutral terminal backend contract.

Types

TerminalCapabilities = object
  mouse*: bool
  bracketedPaste*: bool
  focusEvents*: bool
  modifyOtherKeys*: bool
  kittyKeyboard*: bool

TerminalBackend = ref object of RootObj

proc defaultCapabilities(): TerminalCapabilities {.raises: [], tags: [],
    forbids: [].}

Returns: TerminalCapabilities.

method init(backend: TerminalBackend) {.base, raises: [], tags: [], forbids: [].}

Name	Type	Default
`backend`	`TerminalBackend`

method shutdown(backend: TerminalBackend) {.base, raises: [], tags: [],
    forbids: [].}

Name	Type	Default
`backend`	`TerminalBackend`

method size(backend: TerminalBackend): Size {.base, raises: [], tags: [],
    forbids: [].}

Returns: Size.

Name	Type	Default
`backend`	`TerminalBackend`

method readEvent(backend: TerminalBackend; timeoutMs: int): UiEvent {.base,
    raises: [], tags: [], forbids: [].}

Returns: UiEvent.

Name	Type	Default
`backend`	`TerminalBackend`
`timeoutMs`	`int`

method wake(backend: TerminalBackend) {.base, raises: [], tags: [], forbids: [].}

Name	Type	Default
`backend`	`TerminalBackend`

method present(backend: TerminalBackend; frame: Canvas) {.base, raises: [],
    tags: [], forbids: [].}

Name	Type	Default
`backend`	`TerminalBackend`
`frame`	`Canvas`

method resetPresentation(backend: TerminalBackend) {.base, raises: [], tags: [],
    forbids: [].}

Name	Type	Default
`backend`	`TerminalBackend`