nimterm/widgets/input

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

Editable text input widget with UTF-8-safe cursor movement.

Types

InputWidget

InputWidget = ref object of Widget
  text*: string
  cursor*: int
  prefix*: string
  continuationPrefix*: string
  style*: Style
  prefixStyle*: Style
  cursorStyle*: Style
  cursorBarStyle*: Style
  paddingLeft*: int
  paddingRight*: int
  paddingTop*: int
  paddingBottom*: int
  scrollOffset*: int
  yankText*: string

View source

Procedures

newInput

proc newInput(prefix = "> "; continuationPrefix = "  "; style = defaultStyle();
              cursorStyle = defaultCursorStyle();
              cursorBarStyle = defaultCursorStyle();
              prefixStyle = defaultStyle()): InputWidget {.raises: [], tags: [],
    forbids: [].}

Returns: InputWidget.

Arguments

Name	Type	Default
prefix	inferred	"> "
continuationPrefix	inferred	" "
style	inferred	defaultStyle()
cursorStyle	inferred	defaultCursorStyle()
cursorBarStyle	inferred	defaultCursorStyle()
prefixStyle	inferred	defaultStyle()

View source

clear

proc clear(widget: InputWidget) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
widget	InputWidget

View source

setText

proc setText(widget: InputWidget; text: string) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
widget	InputWidget
text	string

View source

insert

proc insert(widget: InputWidget; piece: string) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
widget	InputWidget
piece	string

View source

undo

proc undo(widget: InputWidget) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
widget	InputWidget

View source

yank

proc yank(widget: InputWidget) {.raises: [], tags: [], forbids: [].}

Arguments

Name	Type	Default
widget	InputWidget

View source

visualLineCount

proc visualLineCount(widget: InputWidget; contentWidth: int): int {.raises: [],
    tags: [], forbids: [].}

Returns: int.

Arguments

Name	Type	Default
widget	InputWidget
contentWidth	int

View source

Methods

focusable

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

Returns: bool.

Arguments

Name	Type	Default
widget	InputWidget

View source

handle

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

Returns: EventResponse.

Arguments

Name	Type	Default
widget	InputWidget
event	UiEvent

View source

measure

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

Returns: Size.

Arguments

Name	Type	Default
widget	InputWidget
constraints	Constraints

View source

paint

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

Arguments

Name	Type	Default
widget	InputWidget
canvas	var Canvas

View source