pub struct PdfPageSquareAnnotation<'a> { /* private fields */ }Expand description
A single PdfPageAnnotation of type PdfPageAnnotationType::Square.
Auto Trait Implementations§
impl<'a> Freeze for PdfPageSquareAnnotation<'a>
impl<'a> !RefUnwindSafe for PdfPageSquareAnnotation<'a>
impl<'a> !Send for PdfPageSquareAnnotation<'a>
impl<'a> !Sync for PdfPageSquareAnnotation<'a>
impl<'a> Unpin for PdfPageSquareAnnotation<'a>
impl<'a> !UnwindSafe for PdfPageSquareAnnotation<'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§impl<'a, T> PdfPageAnnotationVariableText<'a> for Twhere
T: PdfPageAnnotationPrivate<'a>,
impl<'a, T> PdfPageAnnotationVariableText<'a> for Twhere
T: PdfPageAnnotationPrivate<'a>,
Source§fn get_font_size(&self, form: &PdfForm<'_>) -> Result<PdfPoints, PdfiumError>
fn get_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 get_font_color(&self, form: &PdfForm<'_>) -> Result<PdfColor, PdfiumError>
fn get_font_color(&self, form: &PdfForm<'_>) -> Result<PdfColor, PdfiumError>
Returns the color of the text in this annotation.