a11::flow::Proposal Struct Reference

One thing that may be written at an offset. More...

#include <cpp/a11/flow/complete.h>

Public Attributes
std::string	name
	The word, as it would be read back: truncate, x.question.
ProposalKind	kind = ProposalKind::kStatement
std::string	insert
	The text to insert, which is name unless taking it writes more: a function takes its parentheses, an argument takes the colon that has to follow it.
int	caret = -1
	Where the caret lands inside insert, in bytes.
std::string	tail
	Grey text an editor shows after the name: what a stage takes, whether a port is required.
std::string	type
	The type of the thing proposed, where it has one: a port's declared type.
std::string	documentation
	The whole of what is known about it, as Markdown, for the popup an editor shows beside the list.

Detailed Description

One thing that may be written at an offset.

Member Data Documentation

caret

int a11::flow::Proposal::caret = -1

Where the caret lands inside insert, in bytes.

-1 is the end of it, which is what almost everything wants; a function wants it between the parentheses it just wrote.

documentation

std::string a11::flow::Proposal::documentation

The whole of what is known about it, as Markdown, for the popup an editor shows beside the list.

Empty where the name is its own explanation.

The same text a hover over the finished word gives (see [ActionMarkdown] and friends), because a reader choosing interact_with_llm from a list and a reader hovering it afterwards are asking the same question. The tail is the one-line version that fits in the list; this is what is behind it.

insert

std::string a11::flow::Proposal::insert

The text to insert, which is name unless taking it writes more: a function takes its parentheses, an argument takes the colon that has to follow it.

kind

ProposalKind a11::flow::Proposal::kind = ProposalKind::kStatement

name

std::string a11::flow::Proposal::name

The word, as it would be read back: truncate, x.question.

tail

std::string a11::flow::Proposal::tail

Grey text an editor shows after the name: what a stage takes, whether a port is required.

Never part of what is inserted.

type

std::string a11::flow::Proposal::type

The type of the thing proposed, where it has one: a port's declared type.

---

The documentation for this struct was generated from the following file:

• cpp/a11/flow/complete.h