pub struct PdfPageTextAnnotation<'a> { /* private fields */ }Expand description
A single PdfPageAnnotation of type PdfPageAnnotationType::Text.
Auto Trait Implementations§
impl<'a> Freeze for PdfPageTextAnnotation<'a>
impl<'a> !RefUnwindSafe for PdfPageTextAnnotation<'a>
impl<'a> !Send for PdfPageTextAnnotation<'a>
impl<'a> !Sync for PdfPageTextAnnotation<'a>
impl<'a> Unpin for PdfPageTextAnnotation<'a>
impl<'a> !UnwindSafe for PdfPageTextAnnotation<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<'a, T> PdfPageAnnotationCommon for Twhere
T: PdfPageAnnotationPrivate<'a>,
impl<'a, T> PdfPageAnnotationCommon for Twhere
T: PdfPageAnnotationPrivate<'a>,
Source§fn name(&self) -> Option<String>
fn name(&self) -> Option<String>
Returns the name of this PdfPageAnnotation, if any. This is a text string uniquely identifying
this annotation among all the annotations attached to the containing page.
Source§fn is_markup_annotation(&self) -> bool
fn is_markup_annotation(&self) -> bool
Returns
true if this PdfPageAnnotation supports applying text markup to the page
by setting the annotation contents using the PdfPageAnnotationCommon::set_contents()
function.Source§fn has_attachment_points(&self) -> bool
fn has_attachment_points(&self) -> bool
Returns
true if this PdfPageAnnotation supports setting attachment points that
visually associate it with a PdfPageObject.Source§fn bounds(&self) -> Result<PdfRect, PdfiumError>
fn bounds(&self) -> Result<PdfRect, PdfiumError>
Returns the bounding box of this PdfPageAnnotation.
Source§fn set_bounds(&mut self, bounds: PdfRect) -> Result<(), PdfiumError>
fn set_bounds(&mut self, bounds: PdfRect) -> Result<(), PdfiumError>
Sets the bounding box of this PdfPageAnnotation. Read more
Source§fn set_position(
&mut self,
x: PdfPoints,
y: PdfPoints,
) -> Result<(), PdfiumError>
fn set_position( &mut self, x: PdfPoints, y: PdfPoints, ) -> Result<(), PdfiumError>
Sets the bottom right corner of this PdfPageAnnotation to the given values. Read more
Source§fn set_width(&mut self, width: PdfPoints) -> Result<(), PdfiumError>
fn set_width(&mut self, width: PdfPoints) -> Result<(), PdfiumError>
Sets the width of this PdfPageAnnotation to the given value. Read more
Source§fn set_height(&mut self, height: PdfPoints) -> Result<(), PdfiumError>
fn set_height(&mut self, height: PdfPoints) -> Result<(), PdfiumError>
Sets the height of this PdfPageAnnotation to the given value. Read more
Source§fn contents(&self) -> Option<String>
fn contents(&self) -> Option<String>
Returns the text to be displayed for this PdfPageAnnotation, or, if this type of annotation
does not display text, an alternate description of the annotation’s contents in human-readable
form. In either case this text is useful when extracting the document’s contents in support
of accessibility to users with disabilities or for other purposes.
Source§fn set_contents(&mut self, contents: &str) -> Result<(), PdfiumError>
fn set_contents(&mut self, contents: &str) -> Result<(), PdfiumError>
Sets the text to be displayed for this PdfPageAnnotation, or, if this type of annotation
does not display text, an alternate description of the annotation’s contents in human-readable
form for providing accessibility to users with disabilities or for other purposes.
Source§fn creator(&self) -> Option<String>
fn creator(&self) -> Option<String>
Returns the name of the creator of this PdfPageAnnotation, if any.
Source§fn set_creator(&mut self, creator: &str) -> Result<(), PdfiumError>
fn set_creator(&mut self, creator: &str) -> Result<(), PdfiumError>
Sets the name of the creator of this PdfPageAnnotation.
Source§fn creation_date(&self) -> Option<String>
fn creation_date(&self) -> Option<String>
Returns the date and time when this PdfPageAnnotation was originally created, if any.
Source§fn set_creation_date(&mut self, date: DateTime<Utc>) -> Result<(), PdfiumError>
fn set_creation_date(&mut self, date: DateTime<Utc>) -> Result<(), PdfiumError>
Sets the date and time when this PdfPageAnnotation was originally created.
Source§fn modification_date(&self) -> Option<String>
fn modification_date(&self) -> Option<String>
Returns the date and time when this PdfPageAnnotation was last modified, if any.
Source§fn set_modification_date(
&mut self,
date: DateTime<Utc>,
) -> Result<(), PdfiumError>
fn set_modification_date( &mut self, date: DateTime<Utc>, ) -> Result<(), PdfiumError>
Sets the date and time when this PdfPageAnnotation was last modified.
Source§fn fill_color(&self) -> Result<PdfColor, PdfiumError>
fn fill_color(&self) -> Result<PdfColor, PdfiumError>
Returns the color of any filled paths in this PdfPageAnnotation.
Source§fn set_fill_color(&mut self, fill_color: PdfColor) -> Result<(), PdfiumError>
fn set_fill_color(&mut self, fill_color: PdfColor) -> Result<(), PdfiumError>
Sets the color of any filled paths in this PdfPageAnnotation.
Source§fn stroke_color(&self) -> Result<PdfColor, PdfiumError>
fn stroke_color(&self) -> Result<PdfColor, PdfiumError>
Returns the color of any stroked paths in this PdfPageAnnotation.
Source§fn set_stroke_color(
&mut self,
stroke_color: PdfColor,
) -> Result<(), PdfiumError>
fn set_stroke_color( &mut self, stroke_color: PdfColor, ) -> Result<(), PdfiumError>
Sets the color of any stroked paths in this PdfPageAnnotation.
Source§fn objects(&self) -> &PdfPageAnnotationObjects<'_>
fn objects(&self) -> &PdfPageAnnotationObjects<'_>
Returns an immutable collection of all the page objects in this PdfPageAnnotation. Read more
Source§fn attachment_points(&self) -> &PdfPageAnnotationAttachmentPoints<'_>
fn attachment_points(&self) -> &PdfPageAnnotationAttachmentPoints<'_>
Returns an immutable collection of the attachment points that visually associate
this PdfPageAnnotation with one or more
PdfPageObject objects on this PdfPage. Read moreSource§fn is_invisible_if_unsupported(&self) -> bool
fn is_invisible_if_unsupported(&self) -> bool
Returns
true if this PdfPageAnnotation should not be displayed to the user
if it does not belong to one of the standard annotation types and no annotation
handler is available that supports it.Source§fn set_is_invisible_if_unsupported(
&mut self,
is_invisible: bool,
) -> Result<(), PdfiumError>
fn set_is_invisible_if_unsupported( &mut self, is_invisible: bool, ) -> Result<(), PdfiumError>
Controls whether or not this PdfPageAnnotation should be displayed to the user
if it does not belong to one of the standard annotation types and no annotation
handler is available that supports it.
Returns
true if this PdfPageAnnotation should not be displayed or printed,
nor allowed to interact with the user, regardless of its annotation type or whether
an annotation handler is available that supports it. Read moreControls whether or not this PdfPageAnnotation should be displayed, printed,
and allowed to interact with the user, regardless of its annotation type or whether
an annotation handler is available that supports it. Read more
Source§fn is_printed(&self) -> bool
fn is_printed(&self) -> bool
Source§fn set_is_printed(&mut self, is_printed: bool) -> Result<(), PdfiumError>
fn set_is_printed(&mut self, is_printed: bool) -> Result<(), PdfiumError>
Controls whether or not this PdfPageAnnotation should be printed when the
page is printed. Read more
Source§fn is_zoomable(&self) -> bool
fn is_zoomable(&self) -> bool
Returns
true if the appearance of this PdfPageAnnotation should scale to match
the magnification of the page. If false, the location of the annotation on the
page (defined by the upper-left corner of its annotation rectangle) will remain fixed,
regardless of the page magnification. Read moreSource§fn set_is_zoomable(&mut self, is_zoomable: bool) -> Result<(), PdfiumError>
fn set_is_zoomable(&mut self, is_zoomable: bool) -> Result<(), PdfiumError>
Controls whether or not the appearance of this PdfPageAnnotation should scale to
match the magnification of the page. Read more
Source§fn is_rotatable(&self) -> bool
fn is_rotatable(&self) -> bool
Returns
true if the appearance of this PdfPageAnnotation should rotate to match
the rotation of the page. If false, the upper-left corner of the annotation rectangle
will remain in a fixed location on the page, regardless of the page rotation. Read moreSource§fn set_is_rotatable(&mut self, is_rotatable: bool) -> Result<(), PdfiumError>
fn set_is_rotatable(&mut self, is_rotatable: bool) -> Result<(), PdfiumError>
Controls whether or not the appearance of this PdfPageAnnotation should rotate
to match the rotation of the page. Read more
Source§fn is_printable_but_not_viewable(&self) -> bool
fn is_printable_but_not_viewable(&self) -> bool
Returns
true if this PdfPageAnnotation should not be displayed to, or allowed to
interact with, the user. The annotation may be printed (depending on the setting of
the PdfPageAnnotationCommon::is_printed() flag) but should be considered
hidden for purposes of on-screen display and user interaction. Read moreSource§fn set_is_printable_but_not_viewable(
&mut self,
is_printable_but_not_viewable: bool,
) -> Result<(), PdfiumError>
fn set_is_printable_but_not_viewable( &mut self, is_printable_but_not_viewable: bool, ) -> Result<(), PdfiumError>
Controls whether or not this PdfPageAnnotation should be displayed to, and allowed
to interact with, the user. Whether or not the annotation should be printed is
controlled separately by the PdfPageAnnotationCommon::set_is_printed() function. Read more
Source§fn is_read_only(&self) -> bool
fn is_read_only(&self) -> bool
Returns
true if this PdfPageAnnotation should not be allowed to interact
with the user. The annotation may be displayed or printed (depending on the settings
of the PdfPageAnnotationCommon::is_printed() and PdfPageAnnotationCommon::is_printable_but_not_viewable()
flags) but should not respond to mouse clicks or change its appearance
in response to mouse motions. Read moreSource§fn set_is_read_only(&mut self, is_read_only: bool) -> Result<(), PdfiumError>
fn set_is_read_only(&mut self, is_read_only: bool) -> Result<(), PdfiumError>
Controls whether or not this PdfPageAnnotation should be allowed to interact
with the user. Read more
Source§fn is_locked(&self) -> bool
fn is_locked(&self) -> bool
Returns
true if this PdfPageAnnotation is locked. Locked annotations cannot be
deleted, repositioned, or resized by the user. The content of a locked annotation
may still be editable, depending on the setting of the PdfPageAnnotationCommon::is_editable()
flag.Source§fn set_is_locked(&mut self, is_locked: bool) -> Result<(), PdfiumError>
fn set_is_locked(&mut self, is_locked: bool) -> Result<(), PdfiumError>
Controls whether or not this PdfPageAnnotation is locked. Locked annotations cannot be
deleted, repositioned, or resized by the user. The content of a locked annotation
may still be editable, depending on the setting of the PdfPageAnnotationCommon::set_is_editable()
function.
Source§fn is_editable(&self) -> bool
fn is_editable(&self) -> bool
Returns
true if the contents of this PdfPageAnnotation can be edited by the user.
This setting does not control whether or not the annotation can be deleted,
repositioned, or resized; those properties are controlled by the
PdfPageAnnotationCommon::is_locked() flag.Source§fn set_is_editable(&mut self, is_editable: bool) -> Result<(), PdfiumError>
fn set_is_editable(&mut self, is_editable: bool) -> Result<(), PdfiumError>
Controls whether or not the contents of this PdfPageAnnotation can be edited by the user.
This setting does not control whether or not the annotation can be deleted,
repositioned, or resized; those properties are controlled by the
PdfPageAnnotationCommon::set_is_locked() function.
Source§impl<'a, T> PdfPageAnnotationVariableText<'a> for Twhere
T: PdfPageAnnotationPrivate<'a>,
impl<'a, T> PdfPageAnnotationVariableText<'a> for Twhere
T: PdfPageAnnotationPrivate<'a>,
Source§fn font_size(&self, form: &PdfForm<'_>) -> Result<PdfPoints, PdfiumError>
fn font_size(&self, form: &PdfForm<'_>) -> Result<PdfPoints, PdfiumError>
Returns the size of the text in this annotation. A value of PdfPoints::ZERO
indicates that the font size is determined automatically from the annotation height.
See also the PdfPageAnnotationVariableText::is_font_auto_sized() function.
Source§fn is_font_auto_sized(&self, form: &PdfForm<'_>) -> bool
fn is_font_auto_sized(&self, form: &PdfForm<'_>) -> bool
Returns
true if the font size for this annotation is determined automatically
from the annotation height.Source§fn font_color(&self, form: &PdfForm<'_>) -> Result<PdfColor, PdfiumError>
fn font_color(&self, form: &PdfForm<'_>) -> Result<PdfColor, PdfiumError>
Returns the color of the text in this annotation.
Source§fn justification(
&self,
) -> Result<PdfPageAnnotationVariableTextJustification, PdfiumError>
fn justification( &self, ) -> Result<PdfPageAnnotationVariableTextJustification, PdfiumError>
Returns the form of justification that should be used when displaying the text
assigned to this annotation.