pub struct PdfPageXObjectFormObject<'a> { /* private fields */ }Expand description
A single PdfPageObject of type PdfPageObjectType::XObjectForm. The page object contains a
content stream that itself may consist of multiple other page objects. When this page object
is rendered, it renders all its constituent page objects, effectively serving as a template or
stamping object.
Despite the page object name including “form”, this page object type bears no relation to an interactive form containing form fields.
Implementations§
Source§impl<'a> PdfPageXObjectFormObject<'a>
impl<'a> PdfPageXObjectFormObject<'a>
Sourcepub fn len(&self) -> PdfPageObjectIndex
pub fn len(&self) -> PdfPageObjectIndex
Returns the total number of child page objects in this PdfPageXObjectFormObject.
Sourcepub fn as_range(&self) -> Range<PdfPageObjectIndex>
pub fn as_range(&self) -> Range<PdfPageObjectIndex>
Returns a Range from 0..(number of objects) for the child page objects in
this PdfPageXObjectFormObject.
Sourcepub fn as_range_inclusive(&self) -> RangeInclusive<PdfPageObjectIndex>
pub fn as_range_inclusive(&self) -> RangeInclusive<PdfPageObjectIndex>
Returns an inclusive Range from 0..=(number of objects - 1) for the child page objects
in this PdfPageXObjectFormObject.
Sourcepub fn get(
&self,
index: PdfPageObjectIndex,
) -> Result<PdfPageObject<'a>, PdfiumError>
pub fn get( &self, index: PdfPageObjectIndex, ) -> Result<PdfPageObject<'a>, PdfiumError>
Returns a single child PdfPageObject from this PdfPageXObjectFormObject.
Sourcepub fn first(&self) -> Result<PdfPageObject<'a>, PdfiumError>
pub fn first(&self) -> Result<PdfPageObject<'a>, PdfiumError>
Returns the first child PdfPageObject in this PdfPageXObjectFormObject.
Sourcepub fn last(&self) -> Result<PdfPageObject<'a>, PdfiumError>
pub fn last(&self) -> Result<PdfPageObject<'a>, PdfiumError>
Returns the last child PdfPageObject in this PdfPageXObjectFormObject.
Sourcepub fn iter(&'a self) -> PdfPageObjectsIterator<'a> ⓘ
pub fn iter(&'a self) -> PdfPageObjectsIterator<'a> ⓘ
Returns an iterator over all the child PdfPageObject objects in this PdfPageXObjectFormObject.
Trait Implementations§
Source§impl<'a> From<PdfPageXObjectFormObject<'a>> for PdfPageObject<'a>
impl<'a> From<PdfPageXObjectFormObject<'a>> for PdfPageObject<'a>
Source§fn from(object: PdfPageXObjectFormObject<'a>) -> Self
fn from(object: PdfPageXObjectFormObject<'a>) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl<'a> Freeze for PdfPageXObjectFormObject<'a>
impl<'a> !RefUnwindSafe for PdfPageXObjectFormObject<'a>
impl<'a> !Send for PdfPageXObjectFormObject<'a>
impl<'a> !Sync for PdfPageXObjectFormObject<'a>
impl<'a> Unpin for PdfPageXObjectFormObject<'a>
impl<'a> !UnwindSafe for PdfPageXObjectFormObject<'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> PdfPageObjectCommon<'a> for Twhere
T: PdfPageObjectPrivate<'a>,
impl<'a, T> PdfPageObjectCommon<'a> for Twhere
T: PdfPageObjectPrivate<'a>,
Source§fn has_transparency(&self) -> bool
fn has_transparency(&self) -> bool
Returns
true if this PdfPageObject contains transparency.Source§fn bounds(&self) -> Result<PdfRect, PdfiumError>
fn bounds(&self) -> Result<PdfRect, PdfiumError>
Returns the bounding box of this PdfPageObject. Read more
Source§fn transform_from(
&mut self,
other: &PdfPageObject<'_>,
) -> Result<(), PdfiumError>
fn transform_from( &mut self, other: &PdfPageObject<'_>, ) -> Result<(), PdfiumError>
Transforms this PdfPageObject by applying the transformation matrix read from the given PdfPageObject. Read more
Source§fn set_blend_mode(
&mut self,
blend_mode: PdfPageObjectBlendMode,
) -> Result<(), PdfiumError>
fn set_blend_mode( &mut self, blend_mode: PdfPageObjectBlendMode, ) -> Result<(), PdfiumError>
Sets the blend mode that will be applied when painting this PdfPageObject. Read more
Source§fn fill_color(&self) -> Result<PdfColor, PdfiumError>
fn fill_color(&self) -> Result<PdfColor, PdfiumError>
Returns the color of any filled paths in this PdfPageObject.
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 PdfPageObject.
Source§fn stroke_color(&self) -> Result<PdfColor, PdfiumError>
fn stroke_color(&self) -> Result<PdfColor, PdfiumError>
Returns the color of any stroked paths in this PdfPageObject.
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 PdfPageObject. Read more
Source§fn stroke_width(&self) -> Result<PdfPoints, PdfiumError>
fn stroke_width(&self) -> Result<PdfPoints, PdfiumError>
Returns the width of any stroked lines in this PdfPageObject.
Source§fn set_stroke_width(
&mut self,
stroke_width: PdfPoints,
) -> Result<(), PdfiumError>
fn set_stroke_width( &mut self, stroke_width: PdfPoints, ) -> Result<(), PdfiumError>
Sets the width of any stroked lines in this PdfPageObject. Read more
Source§fn line_join(&self) -> Result<PdfPageObjectLineJoin, PdfiumError>
fn line_join(&self) -> Result<PdfPageObjectLineJoin, PdfiumError>
Returns the line join style that will be used when painting stroked path segments
in this PdfPageObject.
Source§fn set_line_join(
&mut self,
line_join: PdfPageObjectLineJoin,
) -> Result<(), PdfiumError>
fn set_line_join( &mut self, line_join: PdfPageObjectLineJoin, ) -> Result<(), PdfiumError>
Sets the line join style that will be used when painting stroked path segments
in this PdfPageObject.
Source§fn line_cap(&self) -> Result<PdfPageObjectLineCap, PdfiumError>
fn line_cap(&self) -> Result<PdfPageObjectLineCap, PdfiumError>
Returns the line cap style that will be used when painting stroked path segments
in this PdfPageObject.
Source§fn set_line_cap(
&mut self,
line_cap: PdfPageObjectLineCap,
) -> Result<(), PdfiumError>
fn set_line_cap( &mut self, line_cap: PdfPageObjectLineCap, ) -> Result<(), PdfiumError>
Sets the line cap style that will be used when painting stroked path segments
in this PdfPageObject.
Source§fn dash_phase(&self) -> Result<PdfPoints, PdfiumError>
fn dash_phase(&self) -> Result<PdfPoints, PdfiumError>
Returns the line dash phase that will be used when painting stroked path segments
in this PdfPageObject. Read more
Source§fn set_dash_phase(&mut self, dash_phase: PdfPoints) -> Result<(), PdfiumError>
fn set_dash_phase(&mut self, dash_phase: PdfPoints) -> Result<(), PdfiumError>
Sets the line dash phase that will be used when painting stroked path segments
in this PdfPageObject. Read more
Source§fn dash_array(&self) -> Result<Vec<PdfPoints>, PdfiumError>
fn dash_array(&self) -> Result<Vec<PdfPoints>, PdfiumError>
Returns the line dash array that will be used when painting stroked path segments
in this PdfPageObject. Read more
Source§fn set_dash_array(
&mut self,
array: &[PdfPoints],
phase: PdfPoints,
) -> Result<(), PdfiumError>
fn set_dash_array( &mut self, array: &[PdfPoints], phase: PdfPoints, ) -> Result<(), PdfiumError>
Sets the line dash array that will be used when painting stroked path segments
in this PdfPageObject. Read more
Source§fn is_copyable(&self) -> bool
fn is_copyable(&self) -> bool
Returns
true if this PdfPageObject can be successfully copied by calling its
try_copy() function. Read moreSource§fn try_copy<'b>(
&self,
document: &'b PdfDocument<'b>,
) -> Result<PdfPageObject<'b>, PdfiumError>
fn try_copy<'b>( &self, document: &'b PdfDocument<'b>, ) -> Result<PdfPageObject<'b>, PdfiumError>
Attempts to copy this PdfPageObject by creating a new page object and copying across
all the properties of this PdfPageObject to the new page object. Read more
Source§fn width(&self) -> Result<PdfPoints, PdfiumError>
fn width(&self) -> Result<PdfPoints, PdfiumError>
Returns the width of this PdfPageObject.
Source§fn height(&self) -> Result<PdfPoints, PdfiumError>
fn height(&self) -> Result<PdfPoints, PdfiumError>
Returns the height of this PdfPageObject.
Source§fn is_inside_rect(&self, rect: &PdfRect) -> bool
fn is_inside_rect(&self, rect: &PdfRect) -> bool
Returns
true if the bounds of this PdfPageObject lie entirely within the given rectangle.Source§fn does_overlap_rect(&self, rect: &PdfRect) -> bool
fn does_overlap_rect(&self, rect: &PdfRect) -> bool
Returns
true if the bounds of this PdfPageObject lie at least partially within
the given rectangle.Source§impl<'a, T> PdfPageObjectsCommon<'a> for Twhere
T: PdfPageObjectsPrivate<'a>,
impl<'a, T> PdfPageObjectsCommon<'a> for Twhere
T: PdfPageObjectsPrivate<'a>,
Source§fn get(&self, index: usize) -> Result<PdfPageObject<'a>, PdfiumError>
fn get(&self, index: usize) -> Result<PdfPageObject<'a>, PdfiumError>
Returns a single PdfPageObject from this page objects collection.
Source§fn iter(&'a self) -> PdfPageObjectsIterator<'a> ⓘ
fn iter(&'a self) -> PdfPageObjectsIterator<'a> ⓘ
Returns an iterator over all the PdfPageObject objects in this page objects collection.
Source§fn add_object(
&mut self,
object: PdfPageObject<'a>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn add_object( &mut self, object: PdfPageObject<'a>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Adds the given PdfPageObject to this page objects collection. The object’s
memory ownership will be transferred to the
PdfPage containing this page objects
collection, and the updated page object will be returned. Read moreSource§fn create_text_object(
&mut self,
x: PdfPoints,
y: PdfPoints,
text: impl ToString,
font: impl ToPdfFontToken,
font_size: PdfPoints,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_text_object( &mut self, x: PdfPoints, y: PdfPoints, text: impl ToString, font: impl ToPdfFontToken, font_size: PdfPoints, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPageTextObject at the given x and y page co-ordinates
from the given arguments and adds it to this page objects collection,
returning the text object wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn create_path_object_line(
&mut self,
x1: PdfPoints,
y1: PdfPoints,
x2: PdfPoints,
y2: PdfPoints,
stroke_color: PdfColor,
stroke_width: PdfPoints,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_line( &mut self, x1: PdfPoints, y1: PdfPoints, x2: PdfPoints, y2: PdfPoints, stroke_color: PdfColor, stroke_width: PdfPoints, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject for the given line, with the given
stroke settings applied. The new path object will be added to this page objects collection
and then returned, wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn create_path_object_bezier(
&mut self,
x1: PdfPoints,
y1: PdfPoints,
x2: PdfPoints,
y2: PdfPoints,
control1_x: PdfPoints,
control1_y: PdfPoints,
control2_x: PdfPoints,
control2_y: PdfPoints,
stroke_color: PdfColor,
stroke_width: PdfPoints,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_bezier( &mut self, x1: PdfPoints, y1: PdfPoints, x2: PdfPoints, y2: PdfPoints, control1_x: PdfPoints, control1_y: PdfPoints, control2_x: PdfPoints, control2_y: PdfPoints, stroke_color: PdfColor, stroke_width: PdfPoints, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject for the given cubic Bézier curve, with the given
stroke settings applied. The new path object will be added to this page objects collection
and then returned, wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn create_path_object_rect(
&mut self,
rect: PdfRect,
stroke_color: Option<PdfColor>,
stroke_width: Option<PdfPoints>,
fill_color: Option<PdfColor>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_rect( &mut self, rect: PdfRect, stroke_color: Option<PdfColor>, stroke_width: Option<PdfPoints>, fill_color: Option<PdfColor>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject for the given rectangle, with the given
fill and stroke settings applied. Both the stroke color and the stroke width must be
provided for the rectangle to be stroked. The new path object will be added to
this page objects collection and then returned, wrapped inside a generic
PdfPageObject wrapper. Read more
Source§fn create_path_object_circle(
&mut self,
rect: PdfRect,
stroke_color: Option<PdfColor>,
stroke_width: Option<PdfPoints>,
fill_color: Option<PdfColor>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_circle( &mut self, rect: PdfRect, stroke_color: Option<PdfColor>, stroke_width: Option<PdfPoints>, fill_color: Option<PdfColor>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject. The new path will be created with a circle that fills
the given rectangle, with the given fill and stroke settings applied. Both the stroke color
and the stroke width must be provided for the circle to be stroked. The new path object
will be added to this page objects collection and then returned, wrapped inside a generic
PdfPageObject wrapper. Read more
Source§fn create_path_object_circle_at(
&mut self,
center_x: PdfPoints,
center_y: PdfPoints,
radius: PdfPoints,
stroke_color: Option<PdfColor>,
stroke_width: Option<PdfPoints>,
fill_color: Option<PdfColor>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_circle_at( &mut self, center_x: PdfPoints, center_y: PdfPoints, radius: PdfPoints, stroke_color: Option<PdfColor>, stroke_width: Option<PdfPoints>, fill_color: Option<PdfColor>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject. The new path will be created with a circle centered
at the given coordinates, with the given radius, and with the given fill and stroke settings
applied. Both the stroke color and the stroke width must be provided for the circle to be
stroked. The new path object will be added to this page objects collection and then
returned, wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn create_path_object_ellipse(
&mut self,
rect: PdfRect,
stroke_color: Option<PdfColor>,
stroke_width: Option<PdfPoints>,
fill_color: Option<PdfColor>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_ellipse( &mut self, rect: PdfRect, stroke_color: Option<PdfColor>, stroke_width: Option<PdfPoints>, fill_color: Option<PdfColor>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject. The new path will be created with an ellipse that fills
the given rectangle, with the given fill and stroke settings applied. Both the stroke color
and the stroke width must be provided for the ellipse to be stroked. The new path object
will be added to this page objects collection and then returned, wrapped inside a generic
PdfPageObject wrapper. Read more
Source§fn create_path_object_ellipse_at(
&mut self,
center_x: PdfPoints,
center_y: PdfPoints,
x_radius: PdfPoints,
y_radius: PdfPoints,
stroke_color: Option<PdfColor>,
stroke_width: Option<PdfPoints>,
fill_color: Option<PdfColor>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_path_object_ellipse_at( &mut self, center_x: PdfPoints, center_y: PdfPoints, x_radius: PdfPoints, y_radius: PdfPoints, stroke_color: Option<PdfColor>, stroke_width: Option<PdfPoints>, fill_color: Option<PdfColor>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPagePathObject. The new path will be created with an ellipse centered
at the given coordinates, with the given radii, and with the given fill and stroke settings
applied. Both the stroke color and the stroke width must be provided for the ellipse to be
stroked. The new path object will be added to this page objects collection and then
returned, wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn create_image_object(
&mut self,
x: PdfPoints,
y: PdfPoints,
image: &DynamicImage,
width: Option<PdfPoints>,
height: Option<PdfPoints>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn create_image_object( &mut self, x: PdfPoints, y: PdfPoints, image: &DynamicImage, width: Option<PdfPoints>, height: Option<PdfPoints>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Creates a new PdfPageImageObject at the given x and y page co-ordinates
from the given arguments and adds it to this page objects collection,
returning the image object wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn remove_object(
&mut self,
object: PdfPageObject<'a>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn remove_object( &mut self, object: PdfPageObject<'a>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Removes the given PdfPageObject from this page objects collection. The object’s
memory ownership will be removed from the
PdfPage containing this page objects
collection, and the updated page object will be returned. It can be added back to a
page objects collection or dropped, at which point the memory owned by the object will
be freed. Read moreSource§fn remove_object_at_index(
&mut self,
index: usize,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn remove_object_at_index( &mut self, index: usize, ) -> Result<PdfPageObject<'a>, PdfiumError>
Removes the PdfPageObject at the given index from this page objects collection.
The object’s memory ownership will be removed from the
PdfPage containing this page objects
collection, and the updated page object will be returned. It can be added back into a
page objects collection or discarded, at which point the memory owned by the object will
be freed. Read moreSource§fn as_range(&self) -> Range<PdfPageObjectIndex>
fn as_range(&self) -> Range<PdfPageObjectIndex>
Returns a Range from
0..(number of objects) for this page objects collection.Source§fn as_range_inclusive(&self) -> RangeInclusive<PdfPageObjectIndex>
fn as_range_inclusive(&self) -> RangeInclusive<PdfPageObjectIndex>
Returns an inclusive Range from
0..=(number of objects - 1) for this page objects collection.Source§fn first(&self) -> Result<PdfPageObject<'a>, PdfiumError>
fn first(&self) -> Result<PdfPageObject<'a>, PdfiumError>
Returns the first PdfPageObject in this page objects collection.
Source§fn last(&self) -> Result<PdfPageObject<'a>, PdfiumError>
fn last(&self) -> Result<PdfPageObject<'a>, PdfiumError>
Returns the last PdfPageObject in this page objects collection.
Source§fn bounds(&'a self) -> PdfRect
fn bounds(&'a self) -> PdfRect
Returns the smallest bounding box that contains all the PdfPageObject objects in this
page objects collection.
Source§fn add_text_object(
&mut self,
object: PdfPageTextObject<'a>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn add_text_object( &mut self, object: PdfPageTextObject<'a>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Adds the given PdfPageTextObject to this page objects collection,
returning the text object wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn add_path_object(
&mut self,
object: PdfPagePathObject<'a>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn add_path_object( &mut self, object: PdfPagePathObject<'a>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Adds the given PdfPagePathObject to this page objects collection,
returning the path object wrapped inside a generic PdfPageObject wrapper. Read more
Source§fn add_image_object(
&mut self,
object: PdfPageImageObject<'a>,
) -> Result<PdfPageObject<'a>, PdfiumError>
fn add_image_object( &mut self, object: PdfPageImageObject<'a>, ) -> Result<PdfPageObject<'a>, PdfiumError>
Adds the given PdfPageImageObject to this page objects collection,
returning the image object wrapped inside a generic PdfPageObject wrapper. Read more