Enum PdfPageAnnotationType

pub enum PdfPageAnnotationType {
    Unknown = 0,
    Text = 1,
    Link = 2,
    FreeText = 3,
    Line = 4,
    Square = 5,
    Circle = 6,
    Polygon = 7,
    Polyline = 8,
    Highlight = 9,
    Underline = 10,
    Squiggly = 11,
    Strikeout = 12,
    Stamp = 13,
    Caret = 14,
    Ink = 15,
    Popup = 16,
    FileAttachment = 17,
    Sound = 18,
    Movie = 19,
    Widget = 20,
    Screen = 21,
    PrinterMark = 22,
    TrapNet = 23,
    Watermark = 24,
    ThreeD = 25,
    RichMedia = 26,
    XfaWidget = 27,
    Redacted = 28,
}

The type of a single PdfPageAnnotation, as defined in table 8.20 of the PDF Reference, version 1.7, on page 615.

Not all PDF annotation types are supported by Pdfium. For example, Pdfium does not currently support embedded sound or movie file annotations, embedded 3D animations, or annotations containing embedded file attachments.

Pdfium currently supports creating, editing, and rendering the following types of annotations:

• PdfPageAnnotationType::Circle
• PdfPageAnnotationType::FreeText
• PdfPageAnnotationType::Highlight
• PdfPageAnnotationType::Ink
• PdfPageAnnotationType::Link
• PdfPageAnnotationType::Popup
• PdfPageAnnotationType::Redacted
• PdfPageAnnotationType::Square
• PdfPageAnnotationType::Squiggly
• PdfPageAnnotationType::Stamp
• PdfPageAnnotationType::Strikeout
• PdfPageAnnotationType::Text
• PdfPageAnnotationType::Underline
• PdfPageAnnotationType::Widget
• PdfPageAnnotationType::XfaWidget

Note that a FreeText annotation is rendered directly on the page, whereas a Text annotation floats over the page inside its own enclosed area. Adobe often uses the term “sticky note” in reference to Text annotations to distinguish them from FreeText annotations.

Variants

Unknown = 0

Text = 1

Link = 2

FreeText = 3

Line = 4

Square = 5

Circle = 6

Polygon = 7

Polyline = 8

Highlight = 9

Underline = 10

Squiggly = 11

Strikeout = 12

Stamp = 13

Caret = 14

Ink = 15

Popup = 16

FileAttachment = 17

Sound = 18

Movie = 19

Widget = 20

Screen = 21

PrinterMark = 22

TrapNet = 23

Watermark = 24

ThreeD = 25

RichMedia = 26

XfaWidget = 27

Redacted = 28

Trait Implementations

impl Clone for PdfPageAnnotationType

fn clone(&self) -> PdfPageAnnotationType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfPageAnnotationType

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

Formats the value using the given formatter.

impl PartialEq for PdfPageAnnotationType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PdfPageAnnotationType

fn partial_cmp(&self, other: &PdfPageAnnotationType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for PdfPageAnnotationType

impl StructuralPartialEq for PdfPageAnnotationType