Struct Catalog

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

Writer for a document catalog dictionary.

This struct is created by Pdf::catalog.

Implementations

impl<'a> Catalog<'a>

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

Write the /Pages attribute pointing to the root page tree.

pub fn page_layout(&mut self, layout: PageLayout) -> &mut Self

Write the /PageLayout attribute to determine how the viewer will display the document’s pages.

pub fn page_labels(&mut self) -> NumberTree<'_, Ref>

Start writing the /PageLabels number tree. PDF 1.3+.

pub fn page_mode(&mut self, mode: PageMode) -> &mut Self

Write the /PageMode attribute to set which chrome elements the viewer should show.

pub fn viewer_preferences(&mut self) -> ViewerPreferences<'_>

Start writing the /ViewerPreferences dictionary. PDF 1.2+.

pub fn names(&mut self) -> Names<'_>

Start writing the /Names dictionary. PDF 1.2+.

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

Write the /Dests attribute pointing to a named destinations dictionary. PDF 1.1+.

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

Write the /Outlines attribute pointing to the root outline dictionary.

pub fn struct_tree_root(&mut self) -> StructTreeRoot<'_>

Start writing the /StructTreeRoot attribute to specify the root of the document’s structure tree. PDF 1.3+.

Must be present in some PDF/A profiles like PDF/A-2a.

pub fn mark_info(&mut self) -> MarkInfo<'_>

Start writing the /MarkInfo dictionary to specify this document’s conformance with the tagged PDF specification. PDF 1.4+.

Must be present in some PDF/A profiles like PDF/A-2a.

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

Write the /Lang attribute to specify the language of the document as a RFC 3066 language tag. PDF 1.4+.

Required in some PDF/A profiles like PDF/A-2a.

pub fn version(&mut self, major: u8, minor: u8) -> &mut Self

Write the /Version attribute to override the PDF version stated in the header. PDF 1.4+.

pub fn additional_actions(&mut self) -> AdditionalActions<'_>

Start writing the /AA dictionary. This sets the additional actions for the whole document. PDF 1.4+.

Note that this attribute is forbidden in PDF/A.

pub fn form(&mut self) -> Form<'_>

Start writing the /AcroForm dictionary to specify the document wide form. PDF 1.2+.

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

Write the /Metadata attribute to specify the document’s metadata. PDF 1.4+.

The reference shall point to a metadata stream.

pub fn extensions(&mut self) -> TypedDict<'_, DeveloperExtension<'_>>

Start writing the /Extensions dictionary to specify which PDF extensions are in use in the document. PDF 1.5+.

The dictionary maps a vendor name to an extension dictionary. The Adobe PDF extensions use the Name prefix ADBE.

pub fn separation_info(&mut self) -> SeparationInfo<'_>

Start writing the /SeparationInfo dictionary to specify which separation colors are in use on the page and how it relates to other pages in the document. PDF 1.3+.

pub fn output_intents(&mut self) -> TypedArray<'_, OutputIntent<'_>>

Start writing the /OutputIntents array to specify the output destinations for the document. PDF 1.4+.

Each entry in the array is an output intent dictionary.

Must be present in PDF/X documents, encouraged in PDF/A documents.

pub fn associated_files(&mut self) -> TypedArray<'_, FileSpec<'_>>

Start writing the /AF array to specify the associated files of the document. PDF 2.0+ or PDF/A-3.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Catalog<'a>

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

Mutably dereferences the value.

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

type Output = Catalog<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Catalog<'a>

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

Start writing the object.