Struct pdf_writer::writers::OutlineItem

pub struct OutlineItem<'a> { /* fields omitted */ }

Writer for an outline item dictionary.

This struct is created by PdfWriter::outline_item.

Implementations

impl<'a> OutlineItem<'a>

pub fn title(&mut self, title: TextStr<'_>) -> &mut Self

Write the /Title attribute.

pub fn parent(&mut self, outline: Ref) -> &mut Self

Write the /Parent attribute which points to the item’s parent or the top-level outline dictionary.

pub fn prev(&mut self, outline: Ref) -> &mut Self

Write the /Prev attribute which points to the previous item on the item’s level.

pub fn next(&mut self, outline: Ref) -> &mut Self

Write the /Next attribute which points to the next item on the item’s level.

pub fn first(&mut self, outline: Ref) -> &mut Self

Write the /First attribute which points to the item’s first child.

pub fn last(&mut self, outline: Ref) -> &mut Self

Write the /Last attribute which points to the item’s last child.

pub fn count(&mut self, items: i32) -> &mut Self

Write the /Count attribute. This tells the viewer how many outline element children are currently visible. If the item is collapsed, this number shall be negative indicating how many elements you would be able to see if it was open.

pub fn dest_direct(&mut self) -> Destination<'_>

Start writing the /Dest attribute to set the destination of this outline item.

pub fn dest_name(&mut self, name: Name<'_>) -> &mut Self

Write the /Dest attribute to set the destination of this outline item to a named destination.

pub fn color_rgb(&mut self, r: f32, g: f32, b: f32) -> &mut Self

Write the /C attribute using an RGB color. This sets the color in which the outline item’s title should be rendered. PDF 1.4+.

pub fn flags(&mut self, flags: OutlineItemFlags) -> &mut Self

Write the /F attribute. PDF 1.4+.

Methods from Deref<Target = Dict<'a>>

pub fn len(&self) -> i32

The number of written pairs.

pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>

Start writing a pair with an arbitrary value.

pub fn pair<T: Primitive>(&mut self, key: Name<'_>, value: T) -> &mut Self

Write a pair with a primitive value.

This is a shorthand for dict.insert(key).primitive(value).

pub fn pairs<'n, T: Primitive>(
    &mut self,
    pairs: impl IntoIterator<Item = (Name<'n>, T)>
) -> &mut Self

Write a sequence of pairs with primitive values.

Trait Implementations

impl<'a> Deref for OutlineItem<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for OutlineItem<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a> Writer<'a> for OutlineItem<'a>

fn start(obj: Obj<'a>) -> Self

Start writing the object.