Struct poppler::IndexIter

pub struct IndexIter { /* private fields */ }

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl IndexIter

pub fn as_ptr(&self) -> *mut PopplerIndexIter

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut PopplerIndexIter) -> &Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut( ptr: &mut *mut PopplerIndexIter, ) -> &mut Self

Borrows the underlying C value mutably.

impl IndexIter

pub fn new(document: &Document) -> IndexIter

Returns the root IndexIter for document, or None. This must be freed with poppler_index_iter_free().

Certain documents have an index associated with them. This index can be used to help the user navigate the document, and is similar to a table of contents. Each node in the index will contain a PopplerAction that can be displayed to the user — typically a ActionType::GotoDest or a ActionType::Uri.

Here is a simple example of some code that walks the full index:

<informalexample>``<programlisting> static void walk_index (PopplerIndexIter iter) { do { / Get the action and do something with it */ PopplerIndexIter *child = poppler_index_iter_get_child (iter); if (child) walk_index (child); poppler_index_iter_free (child); } while (poppler_index_iter_next (iter)); } … { iter = poppler_index_iter_new (document); walk_index (iter); poppler_index_iter_free (iter); } </programlisting>``</informalexample>

document

a Document

Returns

a new IndexIter

pub fn child(&mut self) -> Option<IndexIter>

Returns a newly created child of self, or None if the iter has no child. See new() for more information on this function.

Returns

a new IndexIter

pub fn is_open(&mut self) -> bool

Returns whether this node should be expanded by default to the user. The document can provide a hint as to how the document’s index should be expanded initially.

Returns

true, if the document wants self to be expanded

pub fn next(&mut self) -> bool

Sets self to point to the next action at the current level, if valid. See new() for more information.

Returns

true, if self was set to the next action

Trait Implementations

impl Clone for IndexIter

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for IndexIter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<IndexIter> for Value

fn from(o: IndexIter) -> Self

Converts to this type from the input type.

impl HasParamSpec for IndexIter

type ParamSpec = ParamSpecBoxed

type SetValue = IndexIter

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, IndexIter>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IndexIter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for IndexIter

fn cmp(&self, other: &IndexIter) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for IndexIter

fn eq(&self, other: &IndexIter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IndexIter

fn partial_cmp(&self, other: &IndexIter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for IndexIter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IndexIter

impl StructuralPartialEq for IndexIter