pub struct AdditionalActions<'a> { /* private fields */ }Expand description
Writer for an additional actions dictionary.
This struct is created by Annotation::additional_actions,
Field::additional_actions, Page::additional_actions and
Catalog::additional_actions.
Implementations§
source§impl<'a> AdditionalActions<'a>
impl<'a> AdditionalActions<'a>
Only permissible for annotations.
sourcepub fn annot_curser_enter(&mut self) -> Action<'_>
pub fn annot_curser_enter(&mut self) -> Action<'_>
Start writing the /E dictionary. An action that shall be performed
when the cursor enters the annotation’s active area. Only permissible
for annotations. PDF 1.2+.
sourcepub fn annot_cursor_exit(&mut self) -> Action<'_>
pub fn annot_cursor_exit(&mut self) -> Action<'_>
Start writing the /X dictionary. An action that shall be performed
when the cursor exits the annotation’s active area. Only permissible for
annotations. PDF 1.2+.
sourcepub fn annot_mouse_press(&mut self) -> Action<'_>
pub fn annot_mouse_press(&mut self) -> Action<'_>
Start writing the /D dictionary. This sets the action action
that shall be performed when the mouse button is pressed inside the
annotation’s active area. Only permissible for annotations. PDF 1.2+.
sourcepub fn annot_mouse_release(&mut self) -> Action<'_>
pub fn annot_mouse_release(&mut self) -> Action<'_>
Start writing the /U dictionary. This sets the action action that
shall be performed when the mouse button is released inside the
annotation’s active area. Only permissible for annotations. PDF 1.2+.
sourcepub fn annot_page_open(&mut self) -> Action<'_>
pub fn annot_page_open(&mut self) -> Action<'_>
Start writing the /PO dictionary. This sets the action action that
shall be performed when the page containing the annotation is opened.
Only permissible for annotations. PDF 1.5+.
sourcepub fn annot_page_close(&mut self) -> Action<'_>
pub fn annot_page_close(&mut self) -> Action<'_>
Start writing the /PC dictionary. This sets the action action that
shall be performed when the page containing the annotation is closed.
Only permissible for annotations. PDF 1.5+.
sourcepub fn annot_page_visible(&mut self) -> Action<'_>
pub fn annot_page_visible(&mut self) -> Action<'_>
Start writing the /PV dictionary. This sets the action action that
shall be performed when the page containing the annotation becomes
visible. Only permissible for annotations. PDF 1.5+.
sourcepub fn annot_page_invisible(&mut self) -> Action<'_>
pub fn annot_page_invisible(&mut self) -> Action<'_>
Start writing the /PI dictionary. This sets the action action that
shall be performed when the page containing the annotation is no longer
visible in the conforming reader’s user interface. Only permissible for
annotations. PDF 1.5+.
source§impl<'a> AdditionalActions<'a>
impl<'a> AdditionalActions<'a>
Only permissible for widget annotations.
sourcepub fn widget_focus(&mut self) -> Action<'_>
pub fn widget_focus(&mut self) -> Action<'_>
Start writing the /Fo dictionary. This sets the action that shall be
performed when the annotation receives the input focus. Only permissible
for widget annotations. PDF 1.2+.
sourcepub fn widget_focus_loss(&mut self) -> Action<'_>
pub fn widget_focus_loss(&mut self) -> Action<'_>
Start writing the /Bl dictionary. This sets the action that shall be
performed when the annotation loses the input focus. Only permissible
for widget annotations. PDF 1.2+.
source§impl<'a> AdditionalActions<'a>
impl<'a> AdditionalActions<'a>
Only permissible for page objects.
sourcepub fn page_open(&mut self) -> Action<'_>
pub fn page_open(&mut self) -> Action<'_>
Start writing the /O dictionary. This sets the action that shall be
performed when the page is opened. This action is independent of any
that may be defined by the open action entry in the
document catalog and shall be executed after such an action.
Only permissible for page objects. PDF 1.2+.
sourcepub fn page_close(&mut self) -> Action<'_>
pub fn page_close(&mut self) -> Action<'_>
Start writing the /C dictionary. This sets the action that shall
be performed when the page is closed. This action applies to the page
being closed and shall be executed before any other page is opened. Only
permissible for page objects. PDF 1.2+.
source§impl<'a> AdditionalActions<'a>
impl<'a> AdditionalActions<'a>
Only permisible for form fields.
sourcepub fn form_calculate_partial(&mut self) -> Action<'_>
pub fn form_calculate_partial(&mut self) -> Action<'_>
Start writing the /K dictionary. This sets the JavaScript action that
shall be performed when the user modifies a character in a text field
or combo box or modifies the selection in a scrollable list box. This
action may check the added text for validity and reject or modify it.
Only permissible for form fields. PDF 1.3+.
sourcepub fn form_format(&mut self) -> Action<'_>
pub fn form_format(&mut self) -> Action<'_>
Start writing the /F dictionary. This sets the JavaScript action
that shall be performed before the field is formatted to display its
value. This action may modify the field’s value before formatting. Only
permissible for form fields. PDF 1.3+.
sourcepub fn form_validate(&mut self) -> Action<'_>
pub fn form_validate(&mut self) -> Action<'_>
Start writing the /V dictionary. This sets the JavaScript action that
shall be performed when the field’s value is changed. This action may
check the new value for validity. Only permissible for form fields.
PDF 1.3+.
sourcepub fn form_calculate(&mut self) -> Action<'_>
pub fn form_calculate(&mut self) -> Action<'_>
Start writing the /C dictionary. This sets the JavaScript action that
shall be performed to recalculate the value of this field when that
of another field changes. The order in which the document’s fields are
recalculated shall be defined by the /CO entry in the interactive form
dictionary. Only permissible for form fields. PDF 1.3+.
source§impl<'a> AdditionalActions<'a>
impl<'a> AdditionalActions<'a>
Only permisible for document catalog.
sourcepub fn cat_before_close(&mut self) -> Action<'_>
pub fn cat_before_close(&mut self) -> Action<'_>
Start writing the /WC dictionary. This sets the JavaScript action
that shall be performed before closing a document. Only permissible for
the document catalog PDF 1.4+.
sourcepub fn cat_before_save(&mut self) -> Action<'_>
pub fn cat_before_save(&mut self) -> Action<'_>
Start writing the /WS dictionary. This sets the JavaScript action
that shall be performed before saving a document. Only permissible for
the document catalog PDF 1.4+.
sourcepub fn cat_after_save(&mut self) -> Action<'_>
pub fn cat_after_save(&mut self) -> Action<'_>
Start writing the /DS dictionary. This sets the JavaScript action
that shall be performed after saving a document. Only permissible for
the document catalog PDF 1.4+.
sourcepub fn cat_before_print(&mut self) -> Action<'_>
pub fn cat_before_print(&mut self) -> Action<'_>
Start writing the /WP dictionary. This sets the JavaScript action
that shall be performed before printing a document. Only permissible for
the document catalog PDF 1.4+.
sourcepub fn cat_after_print(&mut self) -> Action<'_>
pub fn cat_after_print(&mut self) -> Action<'_>
Start writing the /DP dictionary. This sets the JavaScript action
that shall be performed after printing a document. Only permissible for
the document catalog PDF 1.4+.
Methods from Deref<Target = Dict<'a>>§
sourcepub fn insert(&mut self, key: Name<'_>) -> Obj<'_>
pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>
Start writing a pair with an arbitrary value.
sourcepub fn pair<T: Primitive>(&mut self, key: Name<'_>, value: T) -> &mut Self
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).
sourcepub fn pairs<'n, T: Primitive>(
&mut self,
pairs: impl IntoIterator<Item = (Name<'n>, T)>,
) -> &mut Self
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.