Struct Action

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

Writer for an action dictionary.

This struct is created by Annotation::action and many keys of AdditionalActions.

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(&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, depending on the ActionType, setting:

• RemoteGoTo: which file to go to
• Launch: which application to launch
• SubmitForm: script location of the webserver that processes the submission
• ImportData: the FDF file from which to import data.

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.

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

Write the /JS attribute to set the script of this action as a text string. Only permissible for JavaScript and Rendition actions.

pub fn js_stream(&mut self, script: Ref) -> &mut Self

Write the /JS attribute to set the script of this action as a text stream. The indirect reference shall point to a stream containing valid ECMAScript. The stream must have PdfDocEncoding or be in Unicode, starting with U+FEFF. Only permissible for JavaScript and Rendition actions.

pub fn fields(&mut self) -> Fields<'_>

Start writing the /Fields array to set the fields which are include/exclude when submitting a form, resetting a form, or loading an FDF file.

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

Write the /Flags attribute to set the various characteristics of form action.

pub fn operation(&mut self, op: RenditionOperation) -> &mut Self

Write the /OP attribute to set the operation to perform when the action is triggered.

pub fn annotation(&mut self, id: Ref) -> &mut Self

Write the /AN attribute to provide a reference to the screen annotation for the operation. Required if OP is present.

pub fn rendition(&mut self) -> Rendition<'_>

Start writing the /R dictionary. Only permissible for the subtype Rendition.

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

pub fn len(&self) -> i32

The number of written pairs.

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

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, 'any> Rewrite<'a> for Action<'any>

type Output = Action<'a>

The writer with the rewritten lifetime.

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

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

Start writing the object.