Struct genpdf::elements::OrderedList

pub struct OrderedList { /* fields omitted */ }

An ordered list of elements with arabic numbers.

Examples

With setters:

use genpdf::elements;
let mut list = elements::OrderedList::new();
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));

With setters and a custom start number:

use genpdf::elements;
let mut list = elements::OrderedList::with_start(5);
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));

Chained:

use genpdf::elements;
let list = elements::OrderedList::new()
    .element(elements::Paragraph::new("first"))
    .element(elements::Paragraph::new("second"))
    .element(elements::Paragraph::new("third"));

Implementations

impl OrderedList

pub fn new() -> OrderedList

Creates a new ordered list starting at 1.

pub fn with_start(start: usize) -> OrderedList

Creates a new ordered list with the given start number.

pub fn push<E: Element + 'static>(&mut self, element: E)

Adds an element to this list.

pub fn element<E: Element + 'static>(self, element: E) -> Self

Adds an element to this list and returns the list.

Trait Implementations

impl Default for OrderedList

fn default() -> OrderedList

Returns the "default value" for a type.

impl Element for OrderedList

fn render(
    &mut self,
    font_cache: &FontCache,
    area: Area<'_>,
    style: Style
) -> Result<RenderResult, Error>

Renders this element to the given area using the given style and font cache.

fn framed(self) -> FramedElement<Self> where
    Self: Sized, 

Draws a frame around this element.

fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self> where
    Self: Sized, 

Adds a padding to this element.

fn styled(self, style: impl Into<Style>) -> StyledElement<Self> where
    Self: Sized, 

Sets the default style for this element and its children.