Struct Checklist 

pub struct Checklist { /* private fields */ }

A checklist, as a screen describes it.

Implementations

impl Checklist

pub fn new(label: impl Into<String>) -> Self

An empty checklist. label names it to a screen reader.

pub fn id(self, id: impl Into<String>) -> Self

The element id of the list, for a link or a label to point at.

pub fn choice(self, choice: Choice) -> Self

Adds a choice at the top level.

pub fn group(self, label: impl Into<String>, entries: Vec<Entry>) -> Self

Adds a group at the top level.

pub fn entry(self, entry: impl Into<Entry>) -> Self

Adds an entry built elsewhere.

pub fn select_all(self, offer: Offer) -> Self

Select all and select none. Default: past SELECT_ALL_PAST choices.

pub fn search(self, offer: Offer) -> Self

The search box. Default: past SEARCH_PAST choices.

pub fn expand(self, expand: Expand) -> Self

Which groups start open. Default: Expand::Auto.

pub fn read_only(self, read_only: bool) -> Self

Shows the list without letting it change: every box is locked and select all is withheld.

pub fn total(&self) -> usize

How many choices the list holds, at every depth.

pub fn checked(&self) -> usize

How many of them are ticked.

pub fn view(&self, i18n: &Translator) -> ChecklistView

Resolves the list for rendering: every decision made, every string in the reader’s language. Serialisable, so a field type carries it in its view-model and an override presents the same list.

pub fn render(&self, i18n: &Translator) -> Markup

The checklist as markup.

Trait Implementations

impl Clone for Checklist

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Checklist

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Checklist

impl PartialEq for Checklist

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Checklist