Struct pdfium_render::bookmark::PdfBookmark

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

Implementations

impl<'a> PdfBookmark<'a>

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

Returns the title of this PdfBookmark, if any.

pub fn action(&self) -> Option<PdfAction<'a>>

Returns the PdfAction associated with this PdfBookmark, if any.

The action indicates the behaviour that will occur when the user interacts with the bookmark in a PDF viewer. For most bookmarks, this will be a local navigation action of type PdfActionType::GoToDestinationInSameDocument, but the PDF file format supports a variety of other actions.

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

Returns this PdfBookmark object’s direct parent, if available.

pub fn first_child(&self) -> Option<PdfBookmark<'a>>

Returns the first child PdfBookmark of this PdfBookmark in the containing PdfDocument, if any.

pub fn next_sibling(&self) -> Option<PdfBookmark<'a>>

Returns the next PdfBookmark at the same tree level as this PdfBookmark in the containing PdfDocument, if any.

pub fn iter_siblings(&self) -> PdfBookmarksIterator<'a>

Returns an iterator over all PdfBookmark sibling nodes of this PdfBookmark.

pub fn iter_direct_children(&self) -> PdfBookmarksIterator<'a>

Returns an iterator over all PdfBookmark child nodes of this PdfBookmark. Only direct children of this PdfBookmark will be traversed by the iterator; grandchildren, great-grandchildren and other descendant nodes will be ignored. To visit all child nodes, including children of children, use PdfBookmark::iter_all_descendants().

pub fn iter_all_descendants(&self) -> PdfBookmarksIterator<'a>

Returns an iterator over all PdfBookmark child nodes of this PdfBookmark, including any children of those nodes. To visit only direct children of this PdfBookmark, use [PdfBookMark::iter_direct_children()].