Struct AppearanceCharacteristics

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

Writer for an appearance characteristics dictionary.

This struct is created by Annotation::appearance_characteristics.

Implementations

impl<'a> AppearanceCharacteristics<'a>

pub fn rotate(&mut self, degrees: i32) -> &mut Self

Write the /R attribute. This is the number of degrees the widget annotation should be rotated by counterclockwise relative to its page when displayed. This should be a multiple of 90.

pub fn border_color_transparent(&mut self) -> &mut Self

Write the /BC attribute forcing a transparent color. This sets the widget annotation’s border color.

pub fn border_color_gray(&mut self, gray: f32) -> &mut Self

Write the /BC attribute using a grayscale color. This sets the widget annotation’s border color.

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

Write the /BC attribute using an RGB color. This sets the widget annotation’s border color.

pub fn border_color_cymk(&mut self, c: f32, y: f32, m: f32, k: f32) -> &mut Self

Write the /BC attribute using an RGB color. This sets the widget annotation’s border color.

pub fn background_color_transparent(&mut self) -> &mut Self

Write the /BG attribute forcing a transparent color. This sets the widget annotation’s background color.

pub fn background_color_gray(&mut self, gray: f32) -> &mut Self

Write the /BG attribute using a grayscale color. This sets the widget annotation’s backround color.

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

Write the /BG attribute using an RGB color. This sets the widget annotation’s backround color.

pub fn background_color_cymk( &mut self, c: f32, y: f32, m: f32, k: f32, ) -> &mut Self

Write the /BG attribute using an RGB color. This sets the widget annotation’s backround color.

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

Write the /CA attribute. This sets the widget annotation’s normal caption. Only permissible for button fields.

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

Write the /RC attribute. This sets the widget annotation’s rollover (hover) caption. Only permissible for push button fields.

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

Write the /AC attribute. This sets the widget annotation’s alternate (down) caption. Only permissible for push button fields.

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

Write the /I attribute. This sets the widget annotation’s normal icon as a reference to a FormXObject. Only permissible for push button fields.

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

Write the /RI attribute. This sets the widget annotation’s rollover (hover) icon as a reference to a FormXObject. Only permissible for push button fields.

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

Write the /IX attribute. This sets the widget annotation’s alternate (down) icon as a reference to a FormXObject. Only permissible for push button fields.

pub fn icon_fit(&mut self) -> IconFit<'_>

Start writing the /IF dictonary. This sets the widget annotation’s icon display characteristics. Only permissible for push button fields.

pub fn text_position(&mut self, position: TextPosition) -> &mut Self

Write the /TP attribute. This sets the widget annotation’s caption position relative to the annotation’s icon. Only permissible for push button fields.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for AppearanceCharacteristics<'a>

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

Mutably dereferences the value.

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

type Output = AppearanceCharacteristics<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for AppearanceCharacteristics<'a>

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

Start writing the object.