/usr/include/poppler/glib/poppler-page.h is in libpoppler-glib-dev 0.62.0-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | /* poppler-page.h: glib interface to poppler
* Copyright (C) 2004, Red Hat, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __POPPLER_PAGE_H__
#define __POPPLER_PAGE_H__
#include <glib-object.h>
#include "poppler.h"
#include <cairo.h>
G_BEGIN_DECLS
#define POPPLER_TYPE_PAGE (poppler_page_get_type ())
#define POPPLER_PAGE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), POPPLER_TYPE_PAGE, PopplerPage))
#define POPPLER_IS_PAGE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), POPPLER_TYPE_PAGE))
GType poppler_page_get_type (void) G_GNUC_CONST;
void poppler_page_render (PopplerPage *page,
cairo_t *cairo);
void poppler_page_render_for_printing (PopplerPage *page,
cairo_t *cairo);
void poppler_page_render_for_printing_with_options (PopplerPage *page,
cairo_t *cairo,
PopplerPrintFlags options);
cairo_surface_t *poppler_page_get_thumbnail (PopplerPage *page);
void poppler_page_render_selection (PopplerPage *page,
cairo_t *cairo,
PopplerRectangle *selection,
PopplerRectangle *old_selection,
PopplerSelectionStyle style,
PopplerColor *glyph_color,
PopplerColor *background_color);
void poppler_page_get_size (PopplerPage *page,
double *width,
double *height);
int poppler_page_get_index (PopplerPage *page);
gchar *poppler_page_get_label (PopplerPage *page);
double poppler_page_get_duration (PopplerPage *page);
PopplerPageTransition *poppler_page_get_transition (PopplerPage *page);
gboolean poppler_page_get_thumbnail_size (PopplerPage *page,
int *width,
int *height);
GList *poppler_page_find_text_with_options (PopplerPage *page,
const char *text,
PopplerFindFlags options);
GList *poppler_page_find_text (PopplerPage *page,
const char *text);
void poppler_page_render_to_ps (PopplerPage *page,
PopplerPSFile *ps_file);
char *poppler_page_get_text (PopplerPage *page);
char *poppler_page_get_text_for_area (PopplerPage *page,
PopplerRectangle *area);
char *poppler_page_get_selected_text (PopplerPage *page,
PopplerSelectionStyle style,
PopplerRectangle *selection);
cairo_region_t *poppler_page_get_selected_region (PopplerPage *page,
gdouble scale,
PopplerSelectionStyle style,
PopplerRectangle *selection);
GList *poppler_page_get_selection_region (PopplerPage *page,
gdouble scale,
PopplerSelectionStyle style,
PopplerRectangle *selection);
void poppler_page_selection_region_free(GList *region);
GList *poppler_page_get_link_mapping (PopplerPage *page);
void poppler_page_free_link_mapping (GList *list);
GList *poppler_page_get_image_mapping (PopplerPage *page);
void poppler_page_free_image_mapping (GList *list);
cairo_surface_t *poppler_page_get_image (PopplerPage *page,
gint image_id);
GList *poppler_page_get_form_field_mapping (PopplerPage *page);
void poppler_page_free_form_field_mapping (GList *list);
GList *poppler_page_get_annot_mapping (PopplerPage *page);
void poppler_page_free_annot_mapping (GList *list);
void poppler_page_add_annot (PopplerPage *page,
PopplerAnnot *annot);
void poppler_page_remove_annot (PopplerPage *page,
PopplerAnnot *annot);
void poppler_page_get_crop_box (PopplerPage *page,
PopplerRectangle *rect);
gboolean poppler_page_get_text_layout (PopplerPage *page,
PopplerRectangle **rectangles,
guint *n_rectangles);
gboolean poppler_page_get_text_layout_for_area (PopplerPage *page,
PopplerRectangle *area,
PopplerRectangle **rectangles,
guint *n_rectangles);
GList *poppler_page_get_text_attributes (PopplerPage *page);
void poppler_page_free_text_attributes (GList *list);
GList * poppler_page_get_text_attributes_for_area (PopplerPage *page,
PopplerRectangle *area);
/* A rectangle on a page, with coordinates in PDF points. */
#define POPPLER_TYPE_RECTANGLE (poppler_rectangle_get_type ())
/**
* PopplerRectangle:
* @x1: x coordinate of lower left corner
* @y1: y coordinate of lower left corner
* @x2: x coordinate of upper right corner
* @y2: y coordinate of upper right corner
*
* A #PopplerRectangle is used to describe
* locations on a page and bounding boxes
*/
struct _PopplerRectangle
{
gdouble x1;
gdouble y1;
gdouble x2;
gdouble y2;
};
GType poppler_rectangle_get_type (void) G_GNUC_CONST;
PopplerRectangle *poppler_rectangle_new (void);
PopplerRectangle *poppler_rectangle_copy (PopplerRectangle *rectangle);
void poppler_rectangle_free (PopplerRectangle *rectangle);
/* A point on a page, with coordinates in PDF points. */
#define POPPLER_TYPE_POINT (poppler_point_get_type ())
/**
* PopplerPoint:
* @x: x coordinate
* @y: y coordinate
*
* A #PopplerPoint is used to describe a location point on a page
*/
struct _PopplerPoint
{
gdouble x;
gdouble y;
};
GType poppler_point_get_type (void) G_GNUC_CONST;
PopplerPoint *poppler_point_new (void);
PopplerPoint *poppler_point_copy (PopplerPoint *point);
void poppler_point_free (PopplerPoint *point);
/* PopplerQuadrilateral */
/* A quadrilateral encompasses a word or group of contiguous words in the
* text underlying the annotation. The coordinates for each quadrilateral are
* given in the order x1 y1 x2 y2 x3 y3 x4 y4 specifying the quadrilateral’s four
* vertices in counterclockwise order */
#define POPPLER_TYPE_QUADRILATERAL (poppler_quadrilateral_get_type ())
/**
* PopplerQuadrilateral:
* @p1: a #PopplerPoint with the first vertex coordinates
* @p2: a #PopplerPoint with the second vertex coordinates
* @p3: a #PopplerPoint with the third vertex coordinates
* @p4: a #PopplerPoint with the fourth vertex coordinates
*
* A #PopplerQuadrilateral is used to describe rectangle-like polygon
* with arbitrary inclination on a page.
*
* Since: 0.26
**/
struct _PopplerQuadrilateral
{
PopplerPoint p1;
PopplerPoint p2;
PopplerPoint p3;
PopplerPoint p4;
};
GType poppler_quadrilateral_get_type (void) G_GNUC_CONST;
PopplerQuadrilateral *poppler_quadrilateral_new (void);
PopplerQuadrilateral *poppler_quadrilateral_copy (PopplerQuadrilateral *quad);
void poppler_quadrilateral_free (PopplerQuadrilateral *quad);
/* A color in RGB */
#define POPPLER_TYPE_COLOR (poppler_color_get_type ())
/**
* PopplerColor:
* @red: the red componment of color
* @green: the green component of color
* @blue: the blue component of color
*
* A #PopplerColor describes a RGB color. Color components
* are values between 0 and 65535
*/
struct _PopplerColor
{
guint16 red;
guint16 green;
guint16 blue;
};
GType poppler_color_get_type (void) G_GNUC_CONST;
PopplerColor *poppler_color_new (void);
PopplerColor *poppler_color_copy (PopplerColor *color);
void poppler_color_free (PopplerColor *color);
/* Text attributes. */
#define POPPLER_TYPE_TEXT_ATTRIBUTES (poppler_text_attributes_get_type ())
/**
* PopplerTextAttributes:
* @font_name: font name
* @font_size: font size
* @is_underlined: if text is underlined
* @color: a #PopplerColor, the foreground color
* @start_index: start position this text attributes apply
* @end_index: end position this text text attributes apply
*
* A #PopplerTextAttributes is used to describe text attributes of a range of text
*
* Since: 0.18
*/
struct _PopplerTextAttributes
{
gchar *font_name;
gdouble font_size;
gboolean is_underlined;
PopplerColor color;
gint start_index;
gint end_index;
};
GType poppler_text_attributes_get_type (void) G_GNUC_CONST;
PopplerTextAttributes *poppler_text_attributes_new (void);
PopplerTextAttributes *poppler_text_attributes_copy (PopplerTextAttributes *text_attrs);
void poppler_text_attributes_free (PopplerTextAttributes *text_attrs);
/* Mapping between areas on the current page and PopplerActions */
#define POPPLER_TYPE_LINK_MAPPING (poppler_link_mapping_get_type ())
/**
* PopplerLinkMapping:
* @area: a #PopplerRectangle representing an area of the page
* @action: a #PopplerAction
*
* A #PopplerLinkMapping structure represents the location
* of @action on the page
*/
struct _PopplerLinkMapping
{
PopplerRectangle area;
PopplerAction *action;
};
GType poppler_link_mapping_get_type (void) G_GNUC_CONST;
PopplerLinkMapping *poppler_link_mapping_new (void);
PopplerLinkMapping *poppler_link_mapping_copy (PopplerLinkMapping *mapping);
void poppler_link_mapping_free (PopplerLinkMapping *mapping);
/* Page Transition */
#define POPPLER_TYPE_PAGE_TRANSITION (poppler_page_transition_get_type ())
/**
* PopplerPageTransition:
* @type: the type of transtition
* @alignment: the dimension in which the transition effect shall occur.
* Only for #POPPLER_PAGE_TRANSITION_SPLIT and #POPPLER_PAGE_TRANSITION_BLINDS transition types
* @direction: the direccion of motion for the transition effect.
* Only for #POPPLER_PAGE_TRANSITION_SPLIT, #POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY
* transition types
* @duration: the duration of the transition effect
* @angle: the direction in which the specified transition effect shall moves,
* expressed in degrees counterclockwise starting from a left-to-right direction.
* Only for #POPPLER_PAGE_TRANSITION_WIPE, #POPPLER_PAGE_TRANSITION_GLITTER, #POPPLER_PAGE_TRANSITION_FLY,
* #POPPLER_PAGE_TRANSITION_COVER, #POPPLER_PAGE_TRANSITION_UNCOVER and #POPPLER_PAGE_TRANSITION_PUSH
* transition types
* @scale: the starting or ending scale at which the changes shall be drawn.
* Only for #POPPLER_PAGE_TRANSITION_FLY transition type
* @rectangular: whether the area that will be flown is rectangular and opaque.
* Only for #POPPLER_PAGE_TRANSITION_FLY transition type
*
* A #PopplerPageTransition structures describes a visual transition
* to use when moving between pages during a presentation
*/
struct _PopplerPageTransition
{
PopplerPageTransitionType type;
PopplerPageTransitionAlignment alignment;
PopplerPageTransitionDirection direction;
gint duration;
gint angle;
gdouble scale;
gboolean rectangular;
gdouble duration_real;
};
GType poppler_page_transition_get_type (void) G_GNUC_CONST;
PopplerPageTransition *poppler_page_transition_new (void);
PopplerPageTransition *poppler_page_transition_copy (PopplerPageTransition *transition);
void poppler_page_transition_free (PopplerPageTransition *transition);
/* Mapping between areas on the current page and images */
#define POPPLER_TYPE_IMAGE_MAPPING (poppler_image_mapping_get_type ())
/**
* PopplerImageMapping:
* @area: a #PopplerRectangle representing an area of the page
* @image_id: an image identifier
*
* A #PopplerImageMapping structure represents the location
* of an image on the page
*/
struct _PopplerImageMapping
{
PopplerRectangle area;
gint image_id;
};
GType poppler_image_mapping_get_type (void) G_GNUC_CONST;
PopplerImageMapping *poppler_image_mapping_new (void);
PopplerImageMapping *poppler_image_mapping_copy (PopplerImageMapping *mapping);
void poppler_image_mapping_free (PopplerImageMapping *mapping);
/* Mapping between areas on the current page and form fields */
#define POPPLER_TYPE_FORM_FIELD_MAPPING (poppler_form_field_mapping_get_type ())
/**
* PopplerFormFieldMapping:
* @area: a #PopplerRectangle representing an area of the page
* @field: a #PopplerFormField
*
* A #PopplerFormFieldMapping structure represents the location
* of @field on the page
*/
struct _PopplerFormFieldMapping
{
PopplerRectangle area;
PopplerFormField *field;
};
GType poppler_form_field_mapping_get_type (void) G_GNUC_CONST;
PopplerFormFieldMapping *poppler_form_field_mapping_new (void);
PopplerFormFieldMapping *poppler_form_field_mapping_copy (PopplerFormFieldMapping *mapping);
void poppler_form_field_mapping_free (PopplerFormFieldMapping *mapping);
/* Mapping between areas on the current page and annots */
#define POPPLER_TYPE_ANNOT_MAPPING (poppler_annot_mapping_get_type ())
/**
* PopplerAnnotMapping:
* @area: a #PopplerRectangle representing an area of the page
* @annot: a #PopplerAnnot
*
* A #PopplerAnnotMapping structure represents the location
* of @annot on the page
*/
struct _PopplerAnnotMapping
{
PopplerRectangle area;
PopplerAnnot *annot;
};
GType poppler_annot_mapping_get_type (void) G_GNUC_CONST;
PopplerAnnotMapping *poppler_annot_mapping_new (void);
PopplerAnnotMapping *poppler_annot_mapping_copy (PopplerAnnotMapping *mapping);
void poppler_annot_mapping_free (PopplerAnnotMapping *mapping);
G_END_DECLS
#endif /* __POPPLER_PAGE_H__ */
|