Annotation Class Documentation

classAnnotation

Namespace:datalogics_interface

Derived classes:
CircleAnnotation, FreeTextAnnotation, InkAnnotation, LineAnnotation, LinkAnnotation, PolyLineAnnotation, PolygonAnnotation, Redaction, SquareAnnotation, TextMarkupAnnotation

Detailed Description

An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

Referenced by

Page

Constructor & Destructor Documentation

~Annotation

~Annotation()

Member Function Documentation

clear_interior_color

voidclear_interior_color()

Returns:

void

Clear the interior color.

generate_appearance

std::unique_ptr< Form >generate_appearance()

Returns:

A Form representing the visual appearance, or null if the appearance could not be generated.

The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

get_annotation_feature_level

doubleget_annotation_feature_level()

Returns:

The minimum PDF version level (e.g. 1.3, 1.4, or 1.5).

The minimum PDF version necessary to support the features used in this annotation.

get_color

Colorget_color()

Returns:

The annotation's color.

The color of the annotation.

get_contents

std::stringget_contents()

Returns:

The annotation's text contents.

The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.

get_flags

AnnotationFlagsget_flags()

Returns:

The annotation's flags.

The flags for the annotation.

get_interior_color

std::unique_ptr< Color >get_interior_color()

Returns:

The interior fill color, or null if no interior color is set.

The color of the border itself can be retrieved from Annotation.Color.

get_normal_appearance

std::unique_ptr< Form >get_normal_appearance()

Returns:

A Form representing the annotation's normal appearance, or null if no normal appearance has been set.

The normal appearance of the annotation, represented as a Form XObject.

get_opacity

doubleget_opacity()

Returns:

The opacity value for this annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

get_rect

Rectget_rect()

Returns:

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

get_subtype

std::stringget_subtype()

Returns:

The subtype string (e.g. "Circle", "Square", "Line").

The annotation's subtype.

get_title

std::stringget_title()

Returns:

The title string.

The title of the annotation.

has_rich_text_data

boolhas_rich_text_data()

Returns:

true if the annotation contains Rich Text String content.

Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.

operator==

booloperator==(const Annotation &other)

Parameters

other: const Annotation &

The annotation to compare with this annotation.

Returns:

true if the two annotations are equal.

Test annotations for equality (if they are the same annotation).

set_annotation_feature_level

voidset_annotation_feature_level(doublelevel)

Parameters

level: double

The target PDF version level. Features requiring a higher version will be removed.

Returns:

void

Removes features not supported in the supplied version number.

set_color

voidset_color(const Color &color)

Parameters

color: const Color &

The new color to set.

Returns:

void

The color of the annotation.

set_contents

voidset_contents(const std::string &contents)

Parameters

contents: const std::string &

The new text contents.

Returns:

void

The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.

set_interior_color

voidset_interior_color(const Color &color)

Parameters

color: const Color &

The new interior fill color. Pass null to remove the interior color.

Returns:

void

Only RGB colors are allowed.

The color of the border itself can be retrieved from Annotation.Color.

set_normal_appearance

voidset_normal_appearance(Form &form)

Parameters

form: Form &

The Form to use as the annotation's normal appearance.

Returns:

void

The normal appearance of the annotation, represented as a Form XObject.

set_opacity

voidset_opacity(doubleopacity)

Parameters

opacity: double

The new opacity value to set.

Returns:

void

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

set_rect

voidset_rect(const Rect &rect)

Parameters

rect: const Rect &

The new bounding rectangle in user space coordinates.

Returns:

void

The size and location of the annotation on its page.

set_title

voidset_title(const std::string &title)

Parameters

title: const std::string &

The new title string.

Returns:

void

The title of the annotation.

to_string

std::stringto_string()

Returns:

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.

try_as

T *try_as(typename T)

Parameters

: typename T

Returns:

T *

Attempt to downcast this annotation to a derived type. Returns a pointer to the derived type, or nullptr if the type doesn't match.

try_as

const T *try_as(typename T)

Parameters

: typename T

Returns:

const T *

Const overload of try_as(). Returns a const pointer, or nullptr.