Struct Annot 

pub struct Annot { /* private fields */ }

A PDF annotation backed by a dictionary object.

Implementations

impl Annot

pub fn from_dict( dict: IndexMap<Vec<u8>, PdfObject>, id: Option<ObjectId>, ) -> Self

Create an Annot from a PDF dictionary.

pub fn load(obj_num: u32, doc: &mut CosDoc) -> Result<Self>

Load an annotation from a document by object number.

pub fn create(annot_type: AnnotType, rect: Rect) -> Self

Create a new annotation dictionary.

pub fn dict(&self) -> &IndexMap<Vec<u8>, PdfObject>

Get the raw dictionary.

pub fn dict_mut(&mut self) -> &mut IndexMap<Vec<u8>, PdfObject>

Get a mutable reference to the dictionary.

pub fn id(&self) -> Option<ObjectId>

Get the object ID (if loaded from a document).

pub fn annot_type(&self) -> AnnotType

Get the annotation type.

pub fn rect(&self) -> Rect

Get the annotation rectangle.

pub fn set_rect(&mut self, rect: Rect)

Set the annotation rectangle.

pub fn flags(&self) -> AnnotFlags

Get the annotation flags.

pub fn set_flags(&mut self, flags: AnnotFlags)

Set the annotation flags.

pub fn contents(&self) -> Option<String>

Get the contents (text displayed for the annotation or alternate description).

pub fn set_contents(&mut self, text: &str)

Set the annotation contents.

pub fn name(&self) -> Option<String>

Get the annotation name (unique ID within the page).

pub fn modified_date(&self) -> Option<PdfDate>

Get the modification date.

pub fn color(&self) -> Option<ColorPt>

Get the color (used for border, background, or title bar).

pub fn set_color(&mut self, color: ColorPt)

Set the annotation color.

pub fn title(&self) -> Option<String>

Get the title (author) — markup annotations only.

pub fn subject(&self) -> Option<String>

Get the subject — markup annotations only.

pub fn opacity(&self) -> f64

Get the opacity (0.0 = transparent, 1.0 = opaque) — markup annotations only.

pub fn creation_date(&self) -> Option<PdfDate>

Get the creation date — markup annotations only.

pub fn popup(&self) -> Option<ObjectId>

Get the popup annotation reference — markup annotations only.

pub fn to_pdf_object(&self) -> PdfObject

Convert to a PdfObject::Dict for saving.

Trait Implementations

impl Clone for Annot

fn clone(&self) -> Annot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annot

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

Formats the value using the given formatter.