Struct FontDescriptor

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

Writer for a font descriptor dictionary.

This struct is created by Chunk::font_descriptor.

Implementations

impl<'a> FontDescriptor<'a>

pub fn name(&mut self, name: Name<'_>) -> &mut Self

Write the /FontName attribute. Required, except for Type 3 fonts.

pub fn family(&mut self, family: Str<'_>) -> &mut Self

Write the /FontFamily attribute. Recommended for Type 3 fonts in Tagged PDFs. PDF 1.5+.

pub fn stretch(&mut self, stretch: FontStretch) -> &mut Self

Write the /FontStretch attribute. Recommended for Type 3 fonts in Tagged PDFs. PDF 1.5+.

pub fn weight(&mut self, weight: u16) -> &mut Self

Write the /FontWeight attribute. Should be between 100 (lightest) and 900 (heaviest), 400 is normal weight, 700 is bold. Recommended for Type 3 fonts in Tagged PDFs. PDF 1.5+.

pub fn flags(&mut self, flags: FontFlags) -> &mut Self

Write the /Flags attribute. Required.

pub fn bbox(&mut self, bbox: Rect) -> &mut Self

Write the /FontBBox attribute. Required, except for Type 3 fonts.

pub fn italic_angle(&mut self, angle: f32) -> &mut Self

Write the /ItalicAngle attribute. Required.

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

Write the /Ascent attribute. Required.

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

Write the /Descent attribute. Required.

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

Write the /Leading attribute.

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

Write the /CapHeight attribute. Required for fonts with Latin characters, except for Type 3 fonts.

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

Write the /XHeight attribute.

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

Write the /StemV attribute. Required, except for Type 3 fonts.

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

Write the /StemH attribute.

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

Write the /AvgWidth attribute.

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

Write the /MaxWidth attribute.

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

Write the /MissingWidth attribute.

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

Write the /FontFile attribute, referecing Type 1 font data.

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

Write the /FontFile2 attribute, referencing TrueType font data. PDF 1.1+.

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

Write the /FontFile3 attribute, referencing CFF font data. PDF 1.2+ or PDF 1.3+ for CID-keyed fonts.

pub fn char_set(&mut self, names: Str<'_>) -> &mut Self

Write the /CharSet attribute, encoding the character names of a font subset as a string. This is only relevant for Type 1 fonts. PDF 1.1+.

If present in PDF/A, this must include all characters in the subset, even if they are not used in the document.

impl FontDescriptor<'_>

Additional FontDescriptor attributes for CIDFonts.

pub fn style(&mut self, class: u8, subclass: u8, panose: [u8; 10]) -> &mut Self

Write the /Style attribute. Optional.

The class and subclass values should be extracted from the sFamilyClass field of the OS/2 table. The panose array should be extracted from the panose field of the OS/2 table.

pub fn descriptor_override(&mut self) -> FontDescriptorOverride<'_>

Start writing the /FD attribute. Optional.

Overrides the global font descriptor for specific glyphs.

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

Write the /CIDSet attribute.

If present in PDF/A, this must include all characters in the subset, even if they are not used in the document.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for FontDescriptor<'a>

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

Mutably dereferences the value.

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

type Output = FontDescriptor<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for FontDescriptor<'a>

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

Start writing the object.