nimterm/widgets/question

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

Multiple-choice question with an optional free-text answer.

Types

QuestionOption

QuestionOption = object
  label*: string
  description*: string

View source

QuestionAnswer

QuestionAnswer = object
  selected*: int
  text*: string
  cancelled*: bool

View source

QuestionWidget

QuestionWidget = ref object of Widget
  prompt*: string
  options*: seq[QuestionOption]
  selected*: int
  allowFreeText*: bool
  freeTextLabel*: string
  freeText*: InputWidget
  style*: Style
  selectedStyle*: Style
  descriptionStyle*: Style
  hintStyle*: Style

View source

Procedures

newQuestion

proc newQuestion(prompt: string; options: seq[QuestionOption];
                 style = defaultStyle(); selectedStyle = defaultStyle();
                 descriptionStyle = defaultStyle(); hintStyle = defaultStyle();
                 allowFreeText = true; freeTextLabel = "Other"): QuestionWidget {.
    raises: [], tags: [], forbids: [].}

Returns: QuestionWidget.

Arguments

Name	Type	Default
`prompt`	`string`
`options`	`seq[QuestionOption]`
`style`	`inferred`	`defaultStyle()`
`selectedStyle`	`inferred`	`defaultStyle()`
`descriptionStyle`	`inferred`	`defaultStyle()`
`hintStyle`	`inferred`	`defaultStyle()`
`allowFreeText`	`inferred`	`true`
`freeTextLabel`	`inferred`	`"Other"`

View source

answer

proc answer(widget: QuestionWidget): EventResponse {.raises: [], tags: [],
    forbids: [].}

Returns: EventResponse.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`

View source

cancel

proc cancel(widget: QuestionWidget): EventResponse {.raises: [], tags: [],
    forbids: [].}

Returns: EventResponse.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`

View source

Methods

focusable

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

Returns: bool.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`

View source

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

Returns: bool.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`

View source

allowsBackgroundEvent

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

Returns: bool.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`
`event`	`UiEvent`

View source

handle

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

Returns: EventResponse.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`
`event`	`UiEvent`

View source

measure

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

Returns: Size.

Arguments

Name	Type	Default
`widget`	`QuestionWidget`
`constraints`	`Constraints`

View source

paint

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

Arguments

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

View source