Struct PdfStructElement 

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

A single element in the structure tree of a tagged PDF page.

Structure elements carry semantic information such as element type (paragraph, heading, table cell, etc.), alternative text, actual text, language, and marked content identifiers that associate the element with content on the page.

The element handle is not owned by this struct; it is owned by the parent FPDF_STRUCTTREE and remains valid for as long as that tree is open.

Implementations

impl<'a> PdfStructElement<'a>

pub fn element_type(&self) -> PdfStructElementType

Returns the parsed PdfStructElementType of this element.

pub fn element_type_raw(&self) -> Option<String>

Returns the raw type string (/S entry) of this element, if any.

pub fn title(&self) -> Option<String>

Returns the title (/T entry) of this element, if any.

pub fn alt_text(&self) -> Option<String>

Returns the alternative text (/Alt entry) of this element, if any. This is typically used for accessibility purposes.

pub fn actual_text(&self) -> Option<String>

Returns the actual text (/ActualText entry) of this element, if any.

pub fn id(&self) -> Option<String>

Returns the ID of this element, if any.

pub fn lang(&self) -> Option<String>

Returns the language (IETF BCP 47 code) of this element, if any.

pub fn marked_content_id(&self) -> Option<i32>

Returns the primary marked content ID of this element, or None if no ID exists.

Consider using PdfStructElement::all_marked_content_ids to retrieve all MCIDs, as an element may have more than one.

pub fn marked_content_id_count(&self) -> usize

Returns the count of marked content IDs associated with this element.

pub fn marked_content_id_at_index(&self, index: usize) -> Option<i32>

Returns the marked content ID at the given index, or None if the index is out of bounds or no ID exists at that index.

pub fn all_marked_content_ids(&self) -> Vec<i32>

Returns all marked content IDs associated with this element.

pub fn parent(&self) -> Option<PdfStructElement<'a>>

Returns the parent structure element, or None if this is a root element.

pub fn children_count(&self) -> usize

Returns the number of direct children of this element.

pub fn child_at_index(&self, index: usize) -> Option<PdfStructElement<'a>>

Returns the child element at the given index, or None if the index is out of bounds or the child at that index is not a structure element (e.g. it is a marked-content reference).

pub fn children(&self) -> PdfStructElementChildrenIterator<'a>

Returns an iterator over the direct children of this element.

pub fn attribute_count(&self) -> usize

Returns the number of attributes on this element.

pub fn string_attribute(&self, name: &str) -> Option<String>

Returns the value of a string attribute with the given name, if any.

Trait Implementations

impl<'a> Clone for PdfStructElement<'a>

fn clone(&self) -> PdfStructElement<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.