nimterm/widgets/scroll

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

Shared viewport state for vertically scrollable widgets.

Types

ScrollView = object
  contentHeight*: int
  viewportHeight*: int
  offset*: int
  followTail*: bool

proc newScrollView(followTail = true): ScrollView {.raises: [], tags: [],
    forbids: [].}

Returns: ScrollView.

Name	Type	Default
`followTail`	`inferred`	`true`

proc maxOffset(view: ScrollView): int {.raises: [], tags: [], forbids: [].}

Returns: int.

Name	Type	Default
`view`	`ScrollView`

proc update(view: var ScrollView; contentHeight, viewportHeight: int) {.
    raises: [], tags: [], forbids: [].}

proc scrollBy(view: var ScrollView; lines: int) {.raises: [], tags: [],
    forbids: [].}

Name	Type	Default
`view`	`var ScrollView`
`lines`	`int`

proc pageBy(view: var ScrollView; pages: int) {.raises: [], tags: [],
    forbids: [].}

Name	Type	Default
`view`	`var ScrollView`
`pages`	`int`

proc home(view: var ScrollView) {.raises: [], tags: [], forbids: [].}

Name	Type	Default
`view`	`var ScrollView`

proc tail(view: var ScrollView) {.raises: [], tags: [], forbids: [].}

Name	Type	Default
`view`	`var ScrollView`

proc visibleRange(view: ScrollView): Slice[int] {.raises: [], tags: [],
    forbids: [].}

Returns: Slice[int].

Name	Type	Default
`view`	`ScrollView`