Gjsify LogoGjsify Logo

Hierarchy

  • IndexIter

Index

Constructors

  • Returns the root #PopplerIndexIter for document, or %NULL. 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 #POPPLER_ACTION_GOTO_DEST or a #POPPLER_ACTION_URI.

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

    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); }

    Parameters

    Returns IndexIter

Properties

name: string

Methods

  • free(): void
  • is_open(): boolean
  • 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 boolean

  • next(): boolean
  • Sets iter to point to the next action at the current level, if valid. See poppler_index_iter_new() for more information.

    Returns boolean

  • Returns the root #PopplerIndexIter for document, or %NULL. 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 #POPPLER_ACTION_GOTO_DEST or a #POPPLER_ACTION_URI.

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

    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); }

    Parameters

    Returns IndexIter

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method