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_annot_mapping_new ()

PopplerAnnotMapping *
poppler_annot_mapping_new (void);

Creates a new PopplerAnnotMapping

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_form_field_mapping_new ()

PopplerFormFieldMapping *
poppler_form_field_mapping_new (void);

Creates a new PopplerFormFieldMapping

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_image_mapping_new ()

PopplerImageMapping *
poppler_image_mapping_new (void);

Creates a new PopplerImageMapping

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_link_mapping_new ()

PopplerLinkMapping *
poppler_link_mapping_new (void);

Creates a new PopplerLinkMapping

poppler_page_add_annot ()

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

Adds annotation annot to page .

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 occurrence 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 occurrence of the text on the page. The coordinates are in PDF points.

When POPPLER_FIND_MULTILINE is passed in options , matches may span more than one line. In this case, the returned list will contain one PopplerRectangle for each part of a match. The function poppler_rectangle_find_get_match_continued() will return TRUE for all rectangles belonging to the same match, except for the last one. If a hyphen was ignored at the end of the part of the match, poppler_rectangle_find_get_ignored_hyphen() will return TRUE for that rectangle.

Note that currently matches spanning more than two lines are not found. (This limitation may be lifted in a future version.)

Note also that currently finding multi-line matches backwards is not implemented; if you pass POPPLER_FIND_BACKWARDS and POPPLER_FIND_MULTILINE together, POPPLER_FIND_MULTILINE will be ignored.

Since: 0.22

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_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_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_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_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_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_get_bounding_box ()

gboolean
poppler_page_get_bounding_box (PopplerPage *page,
                               PopplerRectangle *rect);

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_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_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_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_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_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_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_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_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_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_text ()

char *
poppler_page_get_text (PopplerPage *page);

Retrieves the text of page .

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.

See also poppler_page_get_text_attributes_for_area()

Since: 0.18

poppler_page_get_text_attributes_for_area ()

GList *
poppler_page_get_text_attributes_for_area
                               (PopplerPage *page,
                                PopplerRectangle *area);

Obtains the attributes of the text in area 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_for_area()) to which text attributes apply.

Since: 0.26

poppler_page_get_text_for_area ()

char *
poppler_page_get_text_for_area (PopplerPage *page,
                                PopplerRectangle *area);

Retrieves the text of page contained in area .

Since: 0.26

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()

See also poppler_page_get_text_layout_for_area().

Since: 0.16

poppler_page_get_text_layout_for_area ()

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

Obtains the layout of the text contained in area 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_for_area()

Since: 0.26

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_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_transition ()

PopplerPageTransition *
poppler_page_get_transition (PopplerPage *page);

Returns the transition effect of page

poppler_page_remove_annot ()

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

Removes annotation annot from page

Since: 0.22

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. Please see the documentation for that function for the differences between rendering to the screen and rendering to a printer.

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 with POPPLER_PRINT_ALL flags selected. If you want a different set of flags, use poppler_page_render_for_printing_with_options().

The difference between poppler_page_render() and this function is that some things get rendered differently between screens and printers:

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

See the documentation for poppler_page_render_for_printing() for the differences between rendering to the screen and rendering to a printer.

Since: 0.16

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_render_to_ps ()

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

Render the page on a postscript file

poppler_page_selection_region_free ()

void
poppler_page_selection_region_free (GList *region);

Frees region

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_page_transition_new ()

PopplerPageTransition *
poppler_page_transition_new (void);

Creates a new PopplerPageTransition

poppler_point_copy ()

PopplerPoint *
poppler_point_copy (PopplerPoint *point);

Creates a copy of point . The copy must be freed with poppler_point_free() after use.

Since: 0.26

poppler_point_free ()

void
poppler_point_free (PopplerPoint *point);

Frees the memory used by point

Since: 0.26

poppler_point_new ()

PopplerPoint *
poppler_point_new (void);

Creates a new PopplerPoint. It must be freed with poppler_point_free() after use.

Since: 0.26

poppler_quadrilateral_copy ()

PopplerQuadrilateral *
poppler_quadrilateral_copy (PopplerQuadrilateral *quad);

Creates a copy of quad . The copy must be freed with poppler_quadrilateral_free() after use.

Since: 0.26

poppler_quadrilateral_free ()

void
poppler_quadrilateral_free (PopplerQuadrilateral *quad);

Frees the memory used by quad

Since: 0.26

poppler_quadrilateral_new ()

PopplerQuadrilateral *
poppler_quadrilateral_new (void);

Creates a new PopplerQuadrilateral. It must be freed with poppler_quadrilateral_free() after use.

Since: 0.26

poppler_rectangle_copy ()

PopplerRectangle *
poppler_rectangle_copy (PopplerRectangle *rectangle);

Creates a copy of rectangle .

Note that you must only use this function on an allocated PopplerRectangle, as returned by poppler_rectangle_new(), poppler_rectangle_copy(), or the list elements returned from poppler_page_find_text() or poppler_page_find_text_with_options().

poppler_rectangle_find_get_match_continued ()

gboolean
poppler_rectangle_find_get_match_continued
                               (const PopplerRectangle *rectangle);

When using poppler_page_find_text_with_options() with the POPPLER_FIND_MULTILINE flag, a match may span more than one line and thus consist of more than one rectangle. Every rectangle belonging to the same match will return TRUE from this function, except for the last rectangle, where this function will return FALSE.

Note that you must only call this function on a PopplerRectangle returned in the list from poppler_page_find_text() or poppler_page_find_text_with_options().

Since: 21.05.0

poppler_rectangle_find_get_ignored_hyphen ()

gboolean
poppler_rectangle_find_get_ignored_hyphen
                               (const PopplerRectangle *rectangle);

When using poppler_page_find_text_with_options() with the POPPLER_FIND_MULTILINE flag, a match may span more than one line, and may have been formed by ignoring a hyphen at the end of the line. When this happens at the end of the line corresponding to rectangle , this function returns TRUE (and then poppler_rectangle_find_get_match_continued() will also return TRUE); otherwise it returns FALSE.

Note that you must only call this function on a PopplerRectangle returned in the list from poppler_page_find_text() or poppler_page_find_text_with_options().

Since: 21.05.0

poppler_rectangle_free ()

void
poppler_rectangle_free (PopplerRectangle *rectangle);

Frees the given PopplerRectangle.

Note that you must only use this function on an allocated PopplerRectangle, as returned by poppler_rectangle_new(), poppler_rectangle_copy(), or the list elements returned from poppler_page_find_text() or poppler_page_find_text_with_options().

poppler_rectangle_new ()

PopplerRectangle *
poppler_rectangle_new (void);

Creates a new PopplerRectangle

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

poppler_text_attributes_new ()

PopplerTextAttributes *
poppler_text_attributes_new (void);

Creates a new PopplerTextAttributes

Since: 0.18

PopplerAnnotMapping

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

A PopplerAnnotMapping structure represents the location of annot on the page

enum PopplerFindFlags

Flags using while searching text in a page

Since: 0.22

PopplerFormFieldMapping

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

A PopplerFormFieldMapping structure represents the location of field on the page

PopplerImageMapping

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

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

PopplerLinkMapping

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

A PopplerLinkMapping structure represents the location of action on the page

PopplerPage

typedef struct _PopplerPage PopplerPage;

PopplerPageTransition

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

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

enum PopplerPageTransitionAlignment

Page transition alignment types for POPPLER_PAGE_TRANSITION_SPLIT and POPPLER_PAGE_TRANSITION_BLINDS transition types

enum PopplerPageTransitionDirection

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

enum PopplerPageTransitionType

Page transition types

PopplerPoint

typedef struct {
    gdouble x;
    gdouble y;
} PopplerPoint;

A PopplerPoint is used to describe a location point on a page

enum PopplerPrintFlags

Printing flags

Since: 0.16

PopplerQuadrilateral

typedef struct {
    PopplerPoint p1;
    PopplerPoint p2;
    PopplerPoint p3;
    PopplerPoint p4;
} PopplerQuadrilateral;

A PopplerQuadrilateral is used to describe rectangle-like polygon with arbitrary inclination on a page.

Since: 0.26

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

enum 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

The “label” property

  “label”                    char *

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

Owner: PopplerPage

Flags: Read

Default value: NULL