nimterm/widgets/diff

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

Generic diff document and renderer.

Types

DiffLineKind

DiffLineKind = enum
  dlContext, dlRemoved, dlAdded, dlHeader

View source

DiffLine

DiffLine = object
  kind*: DiffLineKind
  oldNumber*: int
  newNumber*: int
  text*: string

View source

DiffDocument

DiffDocument = object
  path*: string
  lines*: seq[DiffLine]
  additions*: int
  removals*: int

View source

DiffCard

DiffCard = ref object of Widget
  document*: DiffDocument
  contextStyle*: Style
  addedStyle*: Style
  removedStyle*: Style
  headerStyle*: Style

View source

Procedures

newDiffCard

proc newDiffCard(document: DiffDocument; contextStyle = defaultStyle();
                 addedStyle = defaultStyle(); removedStyle = defaultStyle();
                 headerStyle = defaultStyle()): DiffCard {.raises: [], tags: [],
    forbids: [].}

Returns: DiffCard.

Arguments

Name	Type	Default
document	DiffDocument
contextStyle	inferred	defaultStyle()
addedStyle	inferred	defaultStyle()
removedStyle	inferred	defaultStyle()
headerStyle	inferred	defaultStyle()

View source

Methods

measure

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

Returns: Size.

Arguments

Name	Type	Default
widget	DiffCard
constraints	Constraints

View source

paint

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

Arguments

Name	Type	Default
widget	DiffCard
canvas	var Canvas

View source