Struct Group

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

Writer for a group XObject dictionary. PDF 1.4+.

This struct is created by FormXObject::group and Page::group.

Implementations

impl<'a> Group<'a>

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

Set the /S attribute to /Transparency. Required to set the remaining transparency parameters.

pub fn color_space(&mut self) -> ColorSpace<'_>

Start writing the /CS attribute to set the color space.

This is optional for isolated groups and required for groups where the color space cannot be derived from the parent.

Required in PDF/A-2 through PDF/A-4 if there is no OutputIntent.

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

Set the /I attribute to indicate whether the group is isolated.

If it is true, the group will initially be composited against a clear backdrop. If it is false, the group will be composited against the backdrop of the parent group.

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

Set the /K attribute to indicate whether the group is a knockout group.

Within a knockout group, the group children are all composited separately against the backdrop instead of on top of each other.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Group<'a>

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

Mutably dereferences the value.

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

type Output = Group<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Group<'a>

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

Start writing the object.