Struct pdf_writer::writers::Action

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

Writer for an action dictionary.

This struct is created by Annotation::action.

Implementations

impl<'a> Action<'a>

pub fn action_type(&mut self, kind: ActionType) -> &mut Self

Write the /S attribute to set the action type.

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

Start writing the /D attribute to set the destination of this GoTo-type action.

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

Write the /D attribute to set the destination of this GoTo-type action to a named destination.

pub fn file_spec(&mut self) -> FileSpec<'_>

Start writing the /F attribute, setting which file to go to or which application to launch.

pub fn new_window(&mut self, new: bool) -> &mut Self

Write the /NewWindow attribute to set whether this remote GoTo action should open the referenced destination in another window.

pub fn uri(&mut self, uri: Str<'_>) -> &mut Self

Write the /URI attribute to set where this link action goes.

pub fn is_map(&mut self, map: bool) -> &mut Self

Write the /IsMap attribute to set if the click position of the user’s cursor inside the link rectangle should be appended to the referenced URI as a query parameter.

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 Action<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Action<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for Action<'a>

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

Start writing the object.