Struct pdf_writer::writers::ViewerPreferences

source ·
pub struct ViewerPreferences<'a> { /* private fields */ }
Expand description

Writer for a viewer preference dictionary.

This struct is created by Catalog::viewer_preferences.

Implementations§

source§

impl<'a> ViewerPreferences<'a>

source

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

Write the /HideToolbar attribute to set whether the viewer should hide its toolbars while the document is open.

source

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

Write the /HideMenubar attribute to set whether the viewer should hide its menu bar while the document is open.

source

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

Write the /FitWindow attribute to set whether the viewer should resize its window to the size of the first page.

source

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

Write the /CenterWindow attribute to set whether the viewer should center its window on the screen.

source

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

Write the /NonFullScreenPageMode attribute to set which chrome elements the viewer should show for a document which requests full screen rendering in its catalog when it is not shown in full screen mode.

Panics if mode is PageMode::FullScreen.

source

pub fn direction(&mut self, dir: Direction) -> &mut Self

Write the /Direction attribute to aid the viewer in how to lay out the pages visually. PDF 1.3+.

Methods from Deref<Target = Dict<'a>>§

source

pub fn len(&self) -> i32

The number of written pairs.

source

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

source

pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>

Start writing a pair with an arbitrary value.

source

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).

source

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§

source§

impl<'a> Deref for ViewerPreferences<'a>

§

type Target = Dict<'a>

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<'a> DerefMut for ViewerPreferences<'a>

source§

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

Mutably dereferences the value.
source§

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

§

type Output = ViewerPreferences<'a>

The writer with the rewritten lifetime.
source§

impl<'a> Writer<'a> for ViewerPreferences<'a>

source§

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

Start writing the object.

Auto Trait Implementations§

§

impl<'a> Freeze for ViewerPreferences<'a>

§

impl<'a> RefUnwindSafe for ViewerPreferences<'a>

§

impl<'a> Send for ViewerPreferences<'a>

§

impl<'a> Sync for ViewerPreferences<'a>

§

impl<'a> Unpin for ViewerPreferences<'a>

§

impl<'a> !UnwindSafe for ViewerPreferences<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Finish for T

source§

fn finish(self)

Does nothing but move self, equivalent to drop.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.