nimterm/widgets/transcript

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

Compact transcript widget backed by nimterm’s retained event reducer.

Types

TranscriptWidget

TranscriptWidget = ref object of Widget
  transcript*: transcript_model.Transcript
  userStyle*: Style
  assistantStyle*: Style
  thinkingStyle*: Style
  toolStyle*: Style
  errorStyle*: Style
  userRailStyle*: Style
  assistantRailStyle*: Style
  thinkingRailStyle*: Style
  toolRailStyle*: Style
  errorRailStyle*: Style
  selectionStyle*: Style
  viewport*: ScrollView
  selectionStart*: int
  selectionEnd*: int
  selectionStartCol*: int
  selectionEndCol*: int
  searchQuery*: string
  searchMatches*: seq[int]
  searchIndex*: int
  searchStyle*: Style
  toolDetails*: proc (name: string; input: JsonNode; output: string): seq[string] {.
      closure.}

View source

Procedures

newTranscriptWidget

proc newTranscriptWidget(transcript = transcript_model.newTranscript();
                         userStyle = defaultStyle();
                         assistantStyle = defaultStyle();
                         thinkingStyle = defaultStyle();
                         toolStyle = defaultStyle(); errorStyle = defaultStyle()): TranscriptWidget {.
    raises: [], tags: [], forbids: [].}

Returns: TranscriptWidget.

Arguments

Name	Type	Default
transcript	inferred	transcript_model.newTranscript()
userStyle	inferred	defaultStyle()
assistantStyle	inferred	defaultStyle()
thinkingStyle	inferred	defaultStyle()
toolStyle	inferred	defaultStyle()
errorStyle	inferred	defaultStyle()

View source

invalidateLines

proc invalidateLines(widget: TranscriptWidget) {.raises: [], tags: [],
    forbids: [].}

Arguments

Name	Type	Default
widget	TranscriptWidget

View source

appendUser

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

Arguments

Name	Type	Default
widget	TranscriptWidget
text	string

View source

appendStatus

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

Arguments

Name	Type	Default
widget	TranscriptWidget
text	string

View source

setTranscript

proc setTranscript(widget: TranscriptWidget;
                   transcript: transcript_model.Transcript) {.raises: [],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
widget	TranscriptWidget
transcript	transcript_model.Transcript

View source

apply

proc apply(widget: TranscriptWidget; event: AgentUiEvent) {.raises: [],
    tags: [], forbids: [].}

Arguments

Name	Type	Default
widget	TranscriptWidget
event	AgentUiEvent

View source

awaitingApproval

proc awaitingApproval(widget: TranscriptWidget): bool {.raises: [], tags: [],
    forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	TranscriptWidget

View source

selectedText

proc selectedText(widget: TranscriptWidget): string {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Returns: string.

Arguments

Name	Type	Default
widget	TranscriptWidget

View source

setSearch

proc setSearch(widget: TranscriptWidget; query: string): int {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: int.

Arguments

Name	Type	Default
widget	TranscriptWidget
query	string

View source

clearSearch

proc clearSearch(widget: TranscriptWidget) {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
widget	TranscriptWidget

View source

nextSearch

proc nextSearch(widget: TranscriptWidget; backwards = false): bool {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: bool.

Arguments

Name	Type	Default
widget	TranscriptWidget
backwards	inferred	false

View source

copySelection

proc copySelection(widget: TranscriptWidget): EventResponse {.
    raises: [Exception], tags: [RootEffect], forbids: [].}

Returns: EventResponse.

Arguments

Name	Type	Default
widget	TranscriptWidget

View source

scrollBy

proc scrollBy(widget: TranscriptWidget; delta: int) {.raises: [Exception],
    tags: [RootEffect], forbids: [].}

Arguments

Name	Type	Default
widget	TranscriptWidget
delta	int

View source

Methods

focusable

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

Returns: bool.

Arguments

Name	Type	Default
widget	TranscriptWidget

View source

handle

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

Returns: EventResponse.

Arguments

Name	Type	Default
widget	TranscriptWidget
event	UiEvent

View source

measure

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

Returns: Size.

Arguments

Name	Type	Default
widget	TranscriptWidget
constraints	Constraints

View source

paint

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

Arguments

Name	Type	Default
widget	TranscriptWidget
canvas	var Canvas

View source