Struct FieldAttributes

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

Writer for an PrintField attributes dictionary. PDF 1.6+

This struct is created by Attributes::field.

Implementations

impl<'a> FieldAttributes<'a>

pub fn role(&mut self, role: FieldRole) -> &mut Self

Write the /Role attribute to determine the kind of form control.

pub fn checked(&mut self, checked: FieldState) -> &mut Self

Write the /checked attribute to set whether a radio button or checkbox is checked.

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

Write the /Desc attribute to set the description of the form control.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for FieldAttributes<'a>

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

Mutably dereferences the value.

impl<'a, 'any> Rewrite<'a> for FieldAttributes<'any>

type Output = FieldAttributes<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for FieldAttributes<'a>

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

Start writing the object.