nimterm/widgets/menu

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

Selectable label/description menu.

Types

MenuItem

MenuItem = object
  label*: string
  description*: string

View source

Menu = ref object of Widget
  items*: seq[MenuItem]
  selected*: int
  scrollOffset*: int
  title*: string
  bordered*: bool
  style*: Style
  selectedStyle*: Style
  descriptionStyle*: Style
  selectedDescriptionStyle*: Style
  borderStyle*: Style
  titleStyle*: Style

View source

Procedures

newMenu

proc newMenu(items: seq[MenuItem]; style = defaultStyle();
             selectedStyle = defaultStyle(); title = ""; bordered = false;
             borderStyle = defaultStyle(); titleStyle = defaultStyle();
             descriptionStyle = defaultStyle();
             selectedDescriptionStyle = defaultStyle()): Menu {.raises: [],
    tags: [], forbids: [].}

Returns: Menu.

Arguments

Name	Type	Default
`items`	`seq[MenuItem]`
`style`	`inferred`	`defaultStyle()`
`selectedStyle`	`inferred`	`defaultStyle()`
`title`	`inferred`	`""`
`bordered`	`inferred`	`false`
`borderStyle`	`inferred`	`defaultStyle()`
`titleStyle`	`inferred`	`defaultStyle()`
`descriptionStyle`	`inferred`	`defaultStyle()`
`selectedDescriptionStyle`	`inferred`	`defaultStyle()`

View source

Methods

focusable

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

Returns: bool.

Arguments

Name	Type	Default
`widget`	`Menu`

View source

measure

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

Returns: Size.

Arguments

Name	Type	Default
`widget`	`Menu`
`constraints`	`Constraints`

View source

handle

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

Returns: EventResponse.

Arguments

Name	Type	Default
`widget`	`Menu`
`event`	`UiEvent`

View source

paint

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

Arguments

Name	Type	Default
`widget`	`Menu`
`canvas`	`var Canvas`

View source