6ef13b2cc8a6
options.rs
use super::{NumeralMode, WriteError, imposition};
#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum PdfError {
#[error("the document has no pages to export")]
NoPages,
#[error("page {0} does not exist")]
BadPage(usize),
#[error("PDF writing failed: {0}")]
Write(String),
}
impl From<WriteError> for PdfError {
fn from(error: WriteError) -> Self {
Self::Write(error.to_string())
}
}
/// Export options.
#[derive(Clone, Debug)]
pub struct PdfOptions {
/// Physical sheet layout used only by printing.
pub imposition: imposition::Imposition,
/// Repeat complete sheet plans (padding never spills into another copy).
pub sheet_copies: u32,
/// Collate physical sheet sides when repeating a print job.
pub sheet_collate: bool,
/// Pages to export (0-based layout page indexes, in output order); `None` = all.
pub pages: Option<Vec<usize>>,
/// Title / author overrides (default: the document properties).
pub title: Option<String>,
pub author: Option<String>,
/// Write a structure tree (tagged PDF, best effort).
pub tagged: bool,
/// Show tracked changes as markup (coloured, underlined / struck through).
pub include_markup: bool,
/// Print Markup's comments: each page is scaled down to make room on its right for the
/// comments in balloons joined to their anchors (Word's "Document showing markup").
pub comments: bool,
/// Compress content streams.
pub compress: bool,
/// Write hyperlinks and in-document links as link annotations. A print job leaves them out:
/// they print nothing, and a printer driver can't fit a page with annotations to the paper
/// (#4734).
pub links: bool,
/// Print on this paper (width, height in points) instead of each page's own size: the page
/// is scaled to fit and centred, the paper turned to the page's orientation (Scale to paper
/// size, #2108). `None` keeps the document's page sizes.
pub paper: Option<(f32, f32)>,
/// How [`export`] shows digits (the Numeral setting; callers resolve `System`, see
/// [`NumeralMode::resolve`]). [`export_layout`] keeps the layout it is given.
pub numeral: NumeralMode,
/// What [`export`] shows for a page reference to a bookmark the document doesn't have, in the
/// interface language (`None`: Word's English "Error! Bookmark not defined."). [`export_layout`]
/// keeps the layout it is given.
pub bookmark_error: Option<std::sync::Arc<str>>,
}
/// How many characters of the watermark text the PDF draws.
pub const WATERMARK_MAX_CHARS: usize = 200;
impl PdfOptions {
/// What a page shows when drawn into the PDF: no marks or dimming, tracked changes as markup
/// only with `include_markup`. The one place that says so; strict export (#6005) checks the
/// same display list.
pub fn display_options(&self) -> wordcraft_layout::display::DisplayOptions {
wordcraft_layout::display::DisplayOptions {
marks: false,
dim_header: false,
dim_body: false,
markup: self.include_markup,
placeholders: false,
..Default::default()
}
}
/// How [`crate::export`] lays a document out for these options. Page references in the body
/// show their bookmarks' pages, as Word's export fills them in.
pub fn layout_options(&self) -> wordcraft_layout::LayoutOptions {
wordcraft_layout::LayoutOptions {
hide_deleted: !self.include_markup,
comment_balloons: self.comments,
numeral: self.numeral,
output_page_refs: true,
bookmark_error: self.bookmark_error.clone(),
..Default::default()
}
}
}
impl Default for PdfOptions {
/// Keep ordinary document export unchanged unless a print layout is requested.
fn default() -> Self {
PdfOptions {
imposition: Default::default(),
sheet_copies: 1,
sheet_collate: true,
pages: None,
title: None,
author: None,
tagged: true,
include_markup: false,
comments: false,
compress: true,
links: true,
paper: None,
numeral: NumeralMode::Arabic,
bookmark_error: None,
}
}
}
No file is open. Choose one in the tree, or press Ctrl+O (⌘O on a Mac) to find one by name.
Syntax highlighting could not load. The unmodified read-only text remains available above.