OrderedList

Struct OrderedList 

Source
pub struct OrderedList {
    layout: LinearLayout,
    number: usize,
}
Expand description

An ordered list of elements with arabic numbers.

§Examples

With setters:

use genpdfi_extended::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 genpdfi_extended::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 genpdfi_extended::elements;
let list = elements::OrderedList::new()
    .element(elements::Paragraph::new("first"))
    .element(elements::Paragraph::new("second"))
    .element(elements::Paragraph::new("third"));

Nested list using a LinearLayout:

use genpdfi_extended::elements;
let list = elements::OrderedList::new()
    .element(
        elements::UnorderedList::new()
            .element(elements::Paragraph::new("Sublist with number"))
    )
    .element(
        elements::LinearLayout::vertical()
            .element(elements::Paragraph::new("Sublist without number:"))
            .element(
                elements::UnorderedList::new()
                    .element(elements::Paragraph::new("first"))
                    .element(elements::Paragraph::new("second"))
            )
    );

Fields§

§layout: LinearLayout§number: usize

Implementations§

Source§

impl OrderedList

Source

pub fn new() -> OrderedList

Creates a new ordered list starting at 1.

Source

pub fn with_start(start: usize) -> OrderedList

Creates a new ordered list with the given start number.

Source

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

Adds an element to this list.

Source

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

Adds an element to this list and returns the list.

Trait Implementations§

Source§

impl Default for OrderedList

Source§

fn default() -> OrderedList

Returns the “default value” for a type. Read more
Source§

impl Element for OrderedList

Source§

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

Renders this element to the given area using the given style and font cache. Read more
Source§

fn framed(self, line_style: impl Into<LineStyle>) -> FramedElement<Self>
where Self: Sized,

Draws a frame around this element using the given line style.
Source§

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

Adds a padding to this element.
Source§

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

Sets the default style for this element and its children.
Source§

impl<E: Element + 'static> Extend<E> for OrderedList

Source§

fn extend<I: IntoIterator<Item = E>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<E: Element + 'static> FromIterator<E> for OrderedList

Source§

fn from_iter<I: IntoIterator<Item = E>>(iter: I) -> Self

Creates a value from an iterator. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Finish for T

§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<E> IntoBoxedElement for E
where E: Element + 'static,

Source§

fn into_boxed_element(self) -> Box<dyn Element>

Creates a boxed element from this element.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

§

fn to_owned_table(&self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V