Struct pdfium_render::page_object_text::PdfPageTextObject

pub struct PdfPageTextObject<'a> { /* private fields */ }

A single PdfPageObject of type PdfPageObjectType::Text. The page object defines a single piece of formatted text.

Page objects can be created either attached to a PdfPage (in which case the page object’s memory is owned by the containing page) or detached from any page (in which case the page object’s memory is owned by the object). Page objects are not rendered until they are attached to a page; page objects that are never attached to a page will be lost when they fall out of scope.

The simplest way to create a page text object that is immediately attached to a page is to call the PdfPageObjects::create_text_object() function.

Creating a detached page text object offers more scope for customization, but you must add the object to a containing PdfPage manually. To create a detached page text object, use the PdfPageTextObject::new() function. The detached page text object can later be attached to a page by using the PdfPageObjects::add_text_object() function.

Implementations

impl<'a> PdfPageTextObject<'a>

pub fn new(
    document: &PdfDocument<'a>,
    text: impl ToString,
    font: &PdfFont<'_>,
    font_size: PdfPoints
) -> Result<Self, PdfiumError>

Creates a new PdfPageTextObject from the given arguments. The returned page object will not be rendered until it is added to a PdfPage using the PdfPageObjects::add_text_object() function.

A single space will be used if the given text is empty, in order to avoid unexpected behaviour from Pdfium when dealing with empty strings.

pub fn render_mode(&self) -> PdfPageTextRenderMode

Returns the text rendering mode for the text contained within this PdfPageTextObject.

pub fn scaled_font_size(&self) -> PdfPoints

Returns the effective size of the text when rendered, taking into account both the font size specified in this text object as well as any vertical scale factor applied to the text object’s transformation matrix.

To retrieve only the specified font size, ignoring any vertical scaling, use the PdfPageTextObject::unscaled_font_size() function.

pub fn unscaled_font_size(&self) -> PdfPoints

Returns the font size of the text specified in this PdfPageTextObject.

Note that the effective size of the text when rendered may differ from the font size if a scaling factor has been applied to this text object’s transformation matrix. To retrieve the effective font size, taking vertical scaling into account, use the PdfPageTextObject::scaled_font_size() function.

pub fn font(&self) -> PdfFont<'_>

Returns the PdfFont used to render the text contained within this PdfPageTextObject.

pub fn text(&self) -> String

Returns the text contained within this PdfPageTextObject.

Text retrieval in Pdfium is handled by the PdfPageText object owned by the PdfPage containing this PdfPageTextObject. If this text object has not been attached to a page then text retrieval will be unavailable and an empty string will be returned.

When retrieving the text from many PdfPageTextObject objects (for instance, as part of a loop or an iterator), it may be faster to open the PdfPageText object once and keep it open while processing the text objects, like so:

let text_page = page.text()?; // Opens the text page once.

for object in <some object iterator> {
    let object_text = text_page.for_object(object)?;
}

The PdfPageText object will be closed when the binding to it (text_page in the example above) falls out of scope.

pub fn set_text(&mut self, text: impl ToString) -> Result<(), PdfiumError>

Sets the text contained within this PdfPageTextObject, replacing any existing text.

A single space will be used if the given text is empty, in order to avoid unexpected behaviour from Pdfium when dealing with an empty string.

pub fn set_render_mode(
    &mut self,
    render_mode: PdfPageTextRenderMode
) -> Result<(), PdfiumError>

Sets the text rendering mode for the text contained within this PdfPageTextObject.

pub fn chars(
    &self,
    text: &'a PdfPageText<'a>
) -> Result<PdfPageTextChars<'a>, PdfiumError>

Returns a collection of the characters contained within this PdfPageTextObject, using character retrieval functionality provided by the given PdfPageText object.

pub fn has_descenders(&self, text: &PdfPageText<'_>) -> Result<bool, PdfiumError>

Returns true if any of the characters contained within this PdfPageTextObject have a glyph shape that descends below the font baseline.

Character retrieval functionality is provided by the given PdfPageText object.

pub fn descent(&self, text: &PdfPageText<'_>) -> Result<PdfPoints, PdfiumError>

Returns the descent of this PdfPageTextObject. The descent is the maximum distance below the baseline reached by any glyph in any of the characters contained in this text object, expressed as a negative points value.

Character retrieval and bounds measurement is provided by the given PdfPageText object.

Trait Implementations

impl<'a> From<PdfPageTextObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageTextObject<'a>) -> Self

Converts to this type from the input type.