nimterm/widget

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

Minimal retained widget protocol.

Types

EventResponse

EventResponse = object
  handled*: bool
  requestFocus*: bool
  captureMouse*: bool
  releaseMouse*: bool
  action*: UiAction

View source

Widget

Widget = ref object of RootObj
  id*: string
  area*: Rect

View source

Methods

children

method children(widget: Widget): seq[Widget] {.base, raises: [], tags: [],
    forbids: [].}

Returns: seq[Widget].

Arguments

Name	Type	Default
widget	Widget

View source

focusable

method focusable(widget: Widget): bool {.base, raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	Widget

View source

visible

method visible(widget: Widget): bool {.base, raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	Widget

View source

enabled

method enabled(widget: Widget): bool {.base, raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	Widget

View source

modal

method modal(widget: Widget): bool {.base, raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	Widget

View source

allowsBackgroundEvent

method allowsBackgroundEvent(widget: Widget; event: UiEvent): bool {.base,
    raises: [], tags: [], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	Widget
event	UiEvent

View source

measure

method measure(widget: Widget; constraints: Constraints): Size {.base,
    raises: [], tags: [], forbids: [].}

Returns: Size.

Arguments

Name	Type	Default
widget	Widget
constraints	Constraints

View source

layout

method layout(widget: Widget; area: Rect) {.base, raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
widget	Widget
area	Rect

View source

handle

method handle(widget: Widget; event: UiEvent): EventResponse {.base, raises: [],
    tags: [], forbids: [].}

Returns: EventResponse.

Arguments

Name	Type	Default
widget	Widget
event	UiEvent

View source

paint

method paint(widget: Widget; canvas: var Canvas) {.base, raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
widget	Widget
canvas	var Canvas

View source

Constants

eventIgnored

eventIgnored = (handled: false, requestFocus: false, captureMouse: false,
                releaseMouse: false, action: (sourceId: "", targetId: "",
    kind: "", value: "", index: 0, cancelled: false))

View source

eventHandled

eventHandled = (handled: true, requestFocus: false, captureMouse: false,
                releaseMouse: false, action: (sourceId: "", targetId: "",
    kind: "", value: "", index: 0, cancelled: false))

View source

Procedures

focusHandled

proc focusHandled(): EventResponse {.raises: [], tags: [], forbids: [].}

Returns: EventResponse.

View source

captureHandled

proc captureHandled(): EventResponse {.raises: [], tags: [], forbids: [].}

Returns: EventResponse.

View source

releaseHandled

proc releaseHandled(): EventResponse {.raises: [], tags: [], forbids: [].}

Returns: EventResponse.

View source

actionHandled

proc actionHandled(widget: Widget; kind: string; value = ""; index = -1;
                   cancelled = false; targetId = ""): EventResponse {.
    raises: [], tags: [], forbids: [].}

Returns: EventResponse.

Arguments

Name	Type	Default
widget	Widget
kind	string
value	inferred	""
index	inferred	-1
cancelled	inferred	false
targetId	inferred	""

View source

focusActionHandled

proc focusActionHandled(widget: Widget; kind: string; value = ""; index = -1): EventResponse {.
    raises: [], tags: [], forbids: [].}

Returns: EventResponse.

Arguments

Name	Type	Default
widget	Widget
kind	string
value	inferred	""
index	inferred	-1

View source

render

proc render(widget: Widget; canvas: var Canvas; area: Rect) {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
widget	Widget
canvas	var Canvas
area	Rect

View source

contains

proc contains(widget: Widget; target: Widget): bool {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	Widget
target	Widget

View source