HighlightAnnotation Class Documentation
classHighlightAnnotation : TextMarkupAnnotationNamespace:datalogics_interface
- Inherits from:
TextMarkupAnnotation
Detailed Description
The annotated text is still readable on the PDF, but highlighted in yellow.
Uses types
Constructor & Destructor Documentation
HighlightAnnotation
HighlightAnnotation(Page &page, const std::vector< Quad > &quads)Parameters
page: Page &The page to which the HighlightAnnotation is added.
quads: const std::vector< Quad > &A list of quads to highlight. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.
Create a new HighlightAnnotation at the end of a page's annotation array. To create a FreeTextAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.
HighlightAnnotation
HighlightAnnotation(Page &page, intadd_after, const std::vector< Quad > &quads)Parameters
page: Page &The page to which the HighlightAnnotation is added.
add_after: intA list of quads to highlight. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.
quads: const std::vector< Quad > &
Create a new HighlightAnnotation at the end of a page's annotation array. To create a FreeTextAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.
~HighlightAnnotation
~HighlightAnnotation()Member Function Documentation
clear_interior_color
voidclear_interior_color()Returns:
voidClear 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_annotated_text
std::stringget_annotated_text(boolsplit_lines)Parameters
split_lines: boolIf true, text corresponding to each quadrilateral will be separated by CRLF characters. If false, text corresponding to each quadrilateral will be separated by spaces.
Returns:
The text marked by the annotation.The text that is marked by the annotation. Marked text is defined as text which falls within one or more of the quadrilaterals specified by the annotation's QuadPoints entry. If the annotation marks partial words, only those portions of the word that are bounded within the QuadPoints array will be returned. If the annotation marks partial characters, the characters that fall partially within the annotation bounds may not be returned.
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_quads
std::vector< Quad >get_quads()Returns:
std::vector< Quad >A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.
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: doubleThe target PDF version level. Features requiring a higher version will be removed.
Returns:
voidRemoves 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:
voidThe color of the annotation.
set_contents
voidset_contents(const std::string &contents)Parameters
contents: const std::string &The new text contents.
Returns:
voidThe 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_flags
voidset_flags(AnnotationFlagsflags)Parameters
flags: AnnotationFlagsThe new annotation flags to set.
Returns:
voidThe flags for the annotation.
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:
voidOnly 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:
voidThe normal appearance of the annotation, represented as a Form XObject.
set_opacity
voidset_opacity(doubleopacity)Parameters
opacity: doubleThe new opacity value to set.
Returns:
voidOpacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).
set_quads
voidset_quads(const std::vector< Quad > &quads)Parameters
quads: const std::vector< Quad > &a list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation
Returns:
voidA list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.
set_rect
voidset_rect(const Rect &rect)Parameters
rect: const Rect &The new bounding rectangle in user space coordinates.
Returns:
voidThe 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:
voidThe 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.