PopplerPage

typedef struct _PopplerPage PopplerPage;

PopplerRectangle

typedef struct {
  gdouble x1;
  gdouble y1;
  gdouble x2;
  gdouble y2;
} PopplerRectangle;

A PopplerRectangle is used to describe locations on a page and bounding boxes

PopplerPageTransition

typedef struct {
  PopplerPageTransitionType type;
  PopplerPageTransitionAlignment alignment;
  PopplerPageTransitionDirection direction;
  gint duration;
  gint angle;
  gdouble scale;
  gboolean rectangular;
} PopplerPageTransition;

A PopplerPageTransition structures describes a visual transition to use when moving between pages during a presentation

PopplerLinkMapping

typedef struct {
  PopplerRectangle area;
  PopplerAction *action;
} PopplerLinkMapping;

A PopplerLinkMapping structure represents the location of action on the page

PopplerImageMapping

typedef struct {
  PopplerRectangle area;
  gint image_id;	
} PopplerImageMapping;

A PopplerImageMapping structure represents the location of an image on the page

PopplerFormFieldMapping

typedef struct {
  PopplerRectangle area;
  PopplerFormField *field;
} PopplerFormFieldMapping;

A PopplerFormFieldMapping structure represents the location of field on the page

PopplerAnnotMapping

typedef struct {
  PopplerRectangle area;
  PopplerAnnot *annot;
} PopplerAnnotMapping;

A PopplerAnnotMapping structure represents the location of annot on the page

enum PopplerPageTransitionType

typedef enum {
  POPPLER_PAGE_TRANSITION_REPLACE,
  POPPLER_PAGE_TRANSITION_SPLIT,
  POPPLER_PAGE_TRANSITION_BLINDS,
  POPPLER_PAGE_TRANSITION_BOX,
  POPPLER_PAGE_TRANSITION_WIPE,
  POPPLER_PAGE_TRANSITION_DISSOLVE,
  POPPLER_PAGE_TRANSITION_GLITTER,
  POPPLER_PAGE_TRANSITION_FLY,
  POPPLER_PAGE_TRANSITION_PUSH,
  POPPLER_PAGE_TRANSITION_COVER,
  POPPLER_PAGE_TRANSITION_UNCOVER,
  POPPLER_PAGE_TRANSITION_FADE
} PopplerPageTransitionType;

Page transition types

enum PopplerPageTransitionAlignment

typedef enum {
  POPPLER_PAGE_TRANSITION_HORIZONTAL,
  POPPLER_PAGE_TRANSITION_VERTICAL
} PopplerPageTransitionAlignment;

Page transition alignment types for POPPLER_PAGE_TRANSITION_SPLIT and POPPLER_PAGE_TRANSITION_BLINDS transition types

enum PopplerPageTransitionDirection

typedef enum {
  POPPLER_PAGE_TRANSITION_INWARD,
  POPPLER_PAGE_TRANSITION_OUTWARD
} PopplerPageTransitionDirection;

Page transition direction types for POPPLER_PAGE_TRANSITION_SPLIT, POPPLER_PAGE_TRANSITION_BOX and POPPLER_PAGE_TRANSITION_FLY transition types

enum PopplerSelectionStyle

typedef enum {
  POPPLER_SELECTION_GLYPH,
  POPPLER_SELECTION_WORD,
  POPPLER_SELECTION_LINE
} PopplerSelectionStyle;

Selection styles

PopplerTextAttributes

typedef struct {
  gchar *font_name;
  gdouble font_size;
  gboolean is_underlined;
  PopplerColor color;

  gint start_index;
  gint end_index;
} PopplerTextAttributes;

A PopplerTextAttributes is used to describe text attributes of a range of text

Since 0.18

poppler_page_get_index ()

int                 poppler_page_get_index              (PopplerPage *page);

Returns the index of page

poppler_page_get_label ()

gchar *             poppler_page_get_label              (PopplerPage *page);

Returns the label of page. Note that page labels and page indices might not coincide.

Since 0.16

poppler_page_get_size ()

void                poppler_page_get_size               (PopplerPage *page,
                                                         double *width,
                                                         double *height);

Gets the size of page at the current scale and rotation.

poppler_page_get_crop_box ()

void                poppler_page_get_crop_box           (PopplerPage *page,
                                                         PopplerRectangle *rect);

Retrurns the crop box of page

poppler_page_get_duration ()

double              poppler_page_get_duration           (PopplerPage *page);

Returns the duration of page

poppler_page_get_transition ()

PopplerPageTransition * poppler_page_get_transition     (PopplerPage *page);

Returns the transition effect of page

poppler_page_get_thumbnail_size ()

gboolean            poppler_page_get_thumbnail_size     (PopplerPage *page,
                                                         int *width,
                                                         int *height);

Returns TRUE if page has a thumbnail associated with it. It also fills in width and height with the width and height of the thumbnail. The values of width and height are not changed if no appropriate thumbnail exists.

poppler_page_get_thumbnail ()

cairo_surface_t *   poppler_page_get_thumbnail          (PopplerPage *page);

Get the embedded thumbnail for the specified page. If the document doesn't have an embedded thumbnail for the page, this function returns NULL.

poppler_page_render ()

void                poppler_page_render                 (PopplerPage *page,
                                                         cairo_t *cairo);

Render the page to the given cairo context. This function is for rendering a page that will be displayed. If you want to render a page that will be printed use poppler_page_render_for_printing() instead

poppler_page_render_for_printing ()

void                poppler_page_render_for_printing    (PopplerPage *page,
                                                         cairo_t *cairo);

Render the page to the given cairo context for printing.

poppler_page_render_for_printing_with_options ()

void                poppler_page_render_for_printing_with_options
                                                        (PopplerPage *page,
                                                         cairo_t *cairo,
                                                         PopplerPrintFlags options);

Render the page to the given cairo context for printing with the specified options

Since 0.16

poppler_page_render_to_ps ()

void                poppler_page_render_to_ps           (PopplerPage *page,
                                                         PopplerPSFile *ps_file);

Render the page on a postscript file

poppler_page_render_selection ()

void                poppler_page_render_selection       (PopplerPage *page,
                                                         cairo_t *cairo,
                                                         PopplerRectangle *selection,
                                                         PopplerRectangle *old_selection,
                                                         PopplerSelectionStyle style,
                                                         PopplerColor *glyph_color,
                                                         PopplerColor *background_color);

Render the selection specified by selection for page to the given cairo context. The selection will be rendered, using glyph_color for the glyphs and background_color for the selection background.

If non-NULL, old_selection specifies the selection that is already rendered to cairo, in which case this function will (some day) only render the changed part of the selection.

poppler_page_get_selected_region ()

cairo_region_t *    poppler_page_get_selected_region    (PopplerPage *page,
                                                         gdouble scale,
                                                         PopplerSelectionStyle style,
                                                         PopplerRectangle *selection);

Returns a region containing the area that would be rendered by poppler_page_render_selection(). The returned region must be freed with cairo_region_destroy()

Since 0.16

poppler_page_get_selection_region ()

GList *             poppler_page_get_selection_region   (PopplerPage *page,
                                                         gdouble scale,
                                                         PopplerSelectionStyle style,
                                                         PopplerRectangle *selection);

Returns a region containing the area that would be rendered by poppler_page_render_selection() as a GList of PopplerRectangle. The returned list must be freed with poppler_page_selection_region_free().

poppler_page_selection_region_free ()

void                poppler_page_selection_region_free  (GList *region);

Frees region

poppler_page_get_selected_text ()

char *              poppler_page_get_selected_text      (PopplerPage *page,
                                                         PopplerSelectionStyle style,
                                                         PopplerRectangle *selection);

Retrieves the contents of the specified selection as text.

Since 0.16

poppler_page_find_text ()

GList *             poppler_page_find_text              (PopplerPage *page,
                                                         const char *text);

Finds text in page with the default options (POPPLER_FIND_DEFAULT) and returns a GList of rectangles for each occurance of the text on the page. The coordinates are in PDF points.

poppler_page_find_text_with_options ()

GList *             poppler_page_find_text_with_options (PopplerPage *page,
                                                         const char *text,
                                                         PopplerFindFlags options);

Finds text in page with the given PopplerFindFlags options and returns a GList of rectangles for each occurance of the text on the page. The coordinates are in PDF points.

Since 0.22

poppler_page_get_text ()

char *              poppler_page_get_text               (PopplerPage *page);

Retrieves the text of page.

Since 0.16

poppler_page_get_text_layout ()

gboolean            poppler_page_get_text_layout        (PopplerPage *page,
                                                         PopplerRectangle **rectangles,
                                                         guint *n_rectangles);

Obtains the layout of the text as a list of PopplerRectangle This array must be freed with g_free() when done.

The position in the array represents an offset in the text returned by poppler_page_get_text()

Since 0.16

poppler_page_get_text_attributes ()

GList *             poppler_page_get_text_attributes    (PopplerPage *page);

Obtains the attributes of the text as a GList of PopplerTextAttributes. This list must be freed with poppler_page_free_text_attributes() when done.

Each list element is a PopplerTextAttributes struct where start_index and end_index indicates the range of text (as returned by poppler_page_get_text()) to which text attributes apply.

Since 0.18

poppler_page_free_text_attributes ()

void                poppler_page_free_text_attributes   (GList *list);

Frees a list of PopplerTextAttributess allocated by poppler_page_get_text_attributes().

Since 0.18

poppler_page_get_link_mapping ()

GList *             poppler_page_get_link_mapping       (PopplerPage *page);

Returns a list of PopplerLinkMapping items that map from a location on page to a PopplerAction. This list must be freed with poppler_page_free_link_mapping() when done.

poppler_page_free_link_mapping ()

void                poppler_page_free_link_mapping      (GList *list);

Frees a list of PopplerLinkMappings allocated by poppler_page_get_link_mapping(). It also frees the PopplerActions that each mapping contains, so if you want to keep them around, you need to copy them with poppler_action_copy().

poppler_page_get_image_mapping ()

GList *             poppler_page_get_image_mapping      (PopplerPage *page);

Returns a list of PopplerImageMapping items that map from a location on page to an image of the page. This list must be freed with poppler_page_free_image_mapping() when done.

poppler_page_get_image ()

cairo_surface_t *   poppler_page_get_image              (PopplerPage *page,
                                                         gint image_id);

Returns a cairo surface for the image of the page

poppler_page_free_image_mapping ()

void                poppler_page_free_image_mapping     (GList *list);

Frees a list of PopplerImageMappings allocated by poppler_page_get_image_mapping().

poppler_page_get_form_field_mapping ()

GList *             poppler_page_get_form_field_mapping (PopplerPage *page);

Returns a list of PopplerFormFieldMapping items that map from a location on page to a form field. This list must be freed with poppler_page_free_form_field_mapping() when done.

poppler_page_free_form_field_mapping ()

void                poppler_page_free_form_field_mapping
                                                        (GList *list);

Frees a list of PopplerFormFieldMappings allocated by poppler_page_get_form_field_mapping().

poppler_page_get_annot_mapping ()

GList *             poppler_page_get_annot_mapping      (PopplerPage *page);

Returns a list of PopplerAnnotMapping items that map from a location on page to a PopplerAnnot. This list must be freed with poppler_page_free_annot_mapping() when done.

poppler_page_free_annot_mapping ()

void                poppler_page_free_annot_mapping     (GList *list);

Frees a list of PopplerAnnotMappings allocated by poppler_page_get_annot_mapping(). It also unreferences the PopplerAnnots that each mapping contains, so if you want to keep them around, you need to reference them with g_object_ref().

poppler_page_add_annot ()

void                poppler_page_add_annot              (PopplerPage *page,
                                                         PopplerAnnot *annot);

Adds annotation annot to page.

Since 0.16

poppler_page_remove_annot ()

void                poppler_page_remove_annot           (PopplerPage *page,
                                                         PopplerAnnot *annot);

Removes annotation annot from page

Since 0.22

poppler_rectangle_new ()

PopplerRectangle *  poppler_rectangle_new               (void);

Creates a new PopplerRectangle

poppler_rectangle_copy ()

PopplerRectangle *  poppler_rectangle_copy              (PopplerRectangle *rectangle);

Creates a copy of rectangle

poppler_rectangle_free ()

void                poppler_rectangle_free              (PopplerRectangle *rectangle);

Frees the given PopplerRectangle

poppler_page_transition_new ()

PopplerPageTransition * poppler_page_transition_new     (void);

Creates a new PopplerPageTransition

poppler_page_transition_copy ()

PopplerPageTransition * poppler_page_transition_copy    (PopplerPageTransition *transition);

Creates a copy of transition

poppler_page_transition_free ()

void                poppler_page_transition_free        (PopplerPageTransition *transition);

Frees the given PopplerPageTransition

poppler_link_mapping_new ()

PopplerLinkMapping * poppler_link_mapping_new           (void);

Creates a new PopplerLinkMapping

poppler_link_mapping_copy ()

PopplerLinkMapping * poppler_link_mapping_copy          (PopplerLinkMapping *mapping);

Creates a copy of mapping

poppler_link_mapping_free ()

void                poppler_link_mapping_free           (PopplerLinkMapping *mapping);

Frees the given PopplerLinkMapping

poppler_image_mapping_new ()

PopplerImageMapping * poppler_image_mapping_new         (void);

Creates a new PopplerImageMapping

poppler_image_mapping_copy ()

PopplerImageMapping * poppler_image_mapping_copy        (PopplerImageMapping *mapping);

Creates a copy of mapping

poppler_image_mapping_free ()

void                poppler_image_mapping_free          (PopplerImageMapping *mapping);

Frees the given PopplerImageMapping

poppler_form_field_mapping_new ()

PopplerFormFieldMapping * poppler_form_field_mapping_new
                                                        (void);

Creates a new PopplerFormFieldMapping

poppler_form_field_mapping_copy ()

PopplerFormFieldMapping * poppler_form_field_mapping_copy
                                                        (PopplerFormFieldMapping *mapping);

Creates a copy of mapping

poppler_form_field_mapping_free ()

void                poppler_form_field_mapping_free     (PopplerFormFieldMapping *mapping);

Frees the given PopplerFormFieldMapping

poppler_annot_mapping_new ()

PopplerAnnotMapping * poppler_annot_mapping_new         (void);

Creates a new PopplerAnnotMapping

poppler_annot_mapping_copy ()

PopplerAnnotMapping * poppler_annot_mapping_copy        (PopplerAnnotMapping *mapping);

Creates a copy of mapping

poppler_annot_mapping_free ()

void                poppler_annot_mapping_free          (PopplerAnnotMapping *mapping);

Frees the given PopplerAnnotMapping

poppler_text_attributes_new ()

PopplerTextAttributes * poppler_text_attributes_new     (void);

Creates a new PopplerTextAttributes

Since 0.18

poppler_text_attributes_copy ()

PopplerTextAttributes * poppler_text_attributes_copy    (PopplerTextAttributes *text_attrs);

Creates a copy of text_attrs

Since 0.18

poppler_text_attributes_free ()

void                poppler_text_attributes_free        (PopplerTextAttributes *text_attrs);

Frees the given PopplerTextAttributes

Since 0.18

The "label" property

  "label"                    gchar*                : Read

The label of the page or NULL. See also poppler_page_get_label()

Default value: NULL