Struct AnnotationFlags 

pub struct AnnotationFlags(/* private fields */);

Annotation flags per PDF spec Table 165.

These flags control how the annotation behaves when displayed or printed.

Implementations

impl AnnotationFlags

pub const INVISIBLE: u32

Invisible flag (bit 1) - If set, do not display if no AP.

pub const HIDDEN: u32

Hidden flag (bit 2) - If set, do not display or print.

pub const PRINT: u32

Print flag (bit 3) - If set, print annotation when printing.

pub const NO_ZOOM: u32

NoZoom flag (bit 4) - If set, do not scale with page zoom.

pub const NO_ROTATE: u32

NoRotate flag (bit 5) - If set, do not rotate with page.

pub const NO_VIEW: u32

NoView flag (bit 6) - If set, do not display on screen.

pub const READ_ONLY: u32

ReadOnly flag (bit 7) - If set, do not allow interaction.

pub const LOCKED: u32

Locked flag (bit 8) - If set, do not allow deletion/modification.

pub const TOGGLE_NO_VIEW: u32

ToggleNoView flag (bit 9) - Invert NoView on mouse events.

pub const LOCKED_CONTENTS: u32

LockedContents flag (bit 10) - If set, do not allow content modification.

pub fn new(value: u32) -> Self

Create new flags from raw value.

pub fn empty() -> Self

Create empty flags.

pub fn printable() -> Self

Create default flags for printing (PRINT flag set).

pub fn bits(&self) -> u32

Get raw value.

pub fn contains(&self, flag: u32) -> bool

Check if a flag is set.

pub fn set(&mut self, flag: u32)

Set a flag.

pub fn clear(&mut self, flag: u32)

Clear a flag.

pub fn is_invisible(&self) -> bool

Check if invisible.

pub fn is_hidden(&self) -> bool

Check if hidden.

pub fn is_printable(&self) -> bool

Check if printable.

pub fn is_no_zoom(&self) -> bool

Check if no zoom.

pub fn is_no_rotate(&self) -> bool

Check if no rotate.

pub fn is_read_only(&self) -> bool

Check if read only.

pub fn is_locked(&self) -> bool

Check if locked.

Trait Implementations

impl Clone for AnnotationFlags

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for AnnotationFlags

impl Debug for AnnotationFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AnnotationFlags

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AnnotationFlags

impl PartialEq for AnnotationFlags

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AnnotationFlags