poppler

poppler

Synopsis

GQuark              poppler_error_quark                 (void);
#define             POPPLER_ERROR
enum                PopplerError;
enum                PopplerOrientation;
                    PopplerDocument;
                    PopplerIndexIter;
                    PopplerFontsIter;
                    PopplerRectangle;
enum                PopplerSelectionStyle;
enum                PopplerPageTransitionType;
enum                PopplerPageTransitionAlignment;
enum                PopplerPageTransitionDirection;
                    PopplerLinkMapping;
                    PopplerPage;
                    PopplerFontInfo;
                    PopplerPSFile;
enum                PopplerBackend;
PopplerBackend      poppler_get_backend                 (void);
const char *        poppler_get_version                 (void);

Object Hierarchy

  GObject
   +----PopplerDocument
  GObject
   +----PopplerPage

Properties

  "author"                   gchar*                : Read
  "creation-date"            gint                  : Read
  "creator"                  gchar*                : Read
  "format"                   gchar*                : Read
  "format-major"             guint                 : Read
  "format-minor"             guint                 : Read
  "keywords"                 gchar*                : Read
  "linearized"               gchar*                : Read
  "metadata"                 gchar*                : Read
  "mod-date"                 gint                  : Read
  "page-layout"              PopplerPageLayout     : Read
  "page-mode"                PopplerPageMode       : Read
  "permissions"              PopplerPermissions    : Read
  "producer"                 gchar*                : Read
  "subject"                  gchar*                : Read
  "title"                    gchar*                : Read
  "viewer-preferences"       PopplerViewerPreferences  : Read
  "label"                    gchar*                : Read

Description

Details

poppler_error_quark ()

GQuark              poppler_error_quark                 (void);

Returns :


POPPLER_ERROR

#define POPPLER_ERROR poppler_error_quark ()


enum PopplerError

typedef enum
{
  POPPLER_ERROR_INVALID,
  POPPLER_ERROR_ENCRYPTED,
  POPPLER_ERROR_OPEN_FILE,
  POPPLER_ERROR_BAD_CATALOG,
  POPPLER_ERROR_DAMAGED
} PopplerError;


enum PopplerOrientation

typedef enum
{
  POPPLER_ORIENTATION_PORTRAIT,
  POPPLER_ORIENTATION_LANDSCAPE,
  POPPLER_ORIENTATION_UPSIDEDOWN,
  POPPLER_ORIENTATION_SEASCAPE
} PopplerOrientation;


PopplerDocument

typedef struct _PopplerDocument PopplerDocument;


PopplerIndexIter

typedef struct _PopplerIndexIter PopplerIndexIter;


PopplerFontsIter

typedef struct _PopplerFontsIter PopplerFontsIter;


PopplerRectangle

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


enum PopplerSelectionStyle

typedef enum
{
  POPPLER_SELECTION_GLYPH,
  POPPLER_SELECTION_WORD,
  POPPLER_SELECTION_LINE
} PopplerSelectionStyle;


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;


enum PopplerPageTransitionAlignment

typedef enum
{
  POPPLER_PAGE_TRANSITION_HORIZONTAL,
  POPPLER_PAGE_TRANSITION_VERTICAL
} PopplerPageTransitionAlignment;


enum PopplerPageTransitionDirection

typedef enum
{
  POPPLER_PAGE_TRANSITION_INWARD,
  POPPLER_PAGE_TRANSITION_OUTWARD
} PopplerPageTransitionDirection;


PopplerLinkMapping

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


PopplerPage

typedef struct _PopplerPage PopplerPage;


PopplerFontInfo

typedef struct {
  GObject parent_instance;
  PopplerDocument *document;
  FontInfoScanner *scanner;
} PopplerFontInfo;


PopplerPSFile

typedef struct {
  GObject parent_instance;

  PopplerDocument *document;
  PSOutputDev *out;
  char *filename;
  int first_page;
  int last_page;
  double paper_width;
  double paper_height;
  gboolean duplex;
} PopplerPSFile;


enum PopplerBackend

typedef enum
{
  POPPLER_BACKEND_UNKNOWN,
  POPPLER_BACKEND_SPLASH,
  POPPLER_BACKEND_CAIRO
} PopplerBackend;


poppler_get_backend ()

PopplerBackend      poppler_get_backend                 (void);

Returns the backend compiled into the poppler library.

Returns :

The backend used by poppler

poppler_get_version ()

const char *        poppler_get_version                 (void);

Returns the version of poppler in use. This result is not to be freed.

Returns :

the version of poppler.

Property Details

The "author" property

  "author"                   gchar*                : Read

The author of the document.

Default value: NULL


The "creation-date" property

  "creation-date"            gint                  : Read

The date and time the document was created.

Allowed values: >= 0

Default value: 0


The "creator" property

  "creator"                  gchar*                : Read

The software that created the document.

Default value: NULL


The "format" property

  "format"                   gchar*                : Read

The PDF version of the document.

Default value: NULL


The "format-major" property

  "format-major"             guint                 : Read

The PDF major version number of the document.

Default value: 1


The "format-minor" property

  "format-minor"             guint                 : Read

The PDF minor version number of the document.

Default value: 0


The "keywords" property

  "keywords"                 gchar*                : Read

Keywords.

Default value: NULL


The "linearized" property

  "linearized"               gchar*                : Read

Is the document optimized for web viewing?.

Default value: NULL


The "metadata" property

  "metadata"                 gchar*                : Read

Embedded XML metadata.

Default value: NULL


The "mod-date" property

  "mod-date"                 gint                  : Read

The date and time the document was modified.

Allowed values: >= 0

Default value: 0


The "page-layout" property

  "page-layout"              PopplerPageLayout     : Read

Initial Page Layout.

Default value: POPPLER_PAGE_LAYOUT_UNSET


The "page-mode" property

  "page-mode"                PopplerPageMode       : Read

Page Mode.

Default value: POPPLER_PAGE_MODE_UNSET


The "permissions" property

  "permissions"              PopplerPermissions    : Read

Permissions.

Default value: POPPLER_PERMISSIONS_OK_TO_PRINT|POPPLER_PERMISSIONS_OK_TO_MODIFY|POPPLER_PERMISSIONS_OK_TO_COPY|POPPLER_PERMISSIONS_OK_TO_ADD_NOTES|POPPLER_PERMISSIONS_OK_TO_FILL_FORM


The "producer" property

  "producer"                 gchar*                : Read

The software that converted the document.

Default value: NULL


The "subject" property

  "subject"                  gchar*                : Read

Subjects the document touches.

Default value: NULL


The "title" property

  "title"                    gchar*                : Read

The title of the document.

Default value: NULL


The "viewer-preferences" property

  "viewer-preferences"       PopplerViewerPreferences  : Read

Viewer Preferences.


The "label" property

  "label"                    gchar*                : Read

The label of the page.

Default value: NULL