Enums

Details

class Poppler.ActionLayerAction(value)

Bases: GObject.GEnum

Layer actions

New in version 0.14.

ON = 0

set layer visibility on

OFF = 1

set layer visibility off

TOGGLE = 2

reverse the layer visibility state

class Poppler.ActionMovieOperation(value)

Bases: GObject.GEnum

Movie operations

New in version 0.14.

PLAY = 0

play movie

PAUSE = 1

pause playing movie

RESUME = 2

resume paused movie

STOP = 3

stop playing movie

class Poppler.ActionType(value)

Bases: GObject.GEnum

Action types

UNKNOWN = 0

unknown action

NONE = 1

no action specified

JAVASCRIPT = 10

Javascript.

New in version 0.18.

RESET_FORM = 11

resets form.

New in version 0.90.

GOTO_DEST = 2

go to destination

GOTO_REMOTE = 3

go to destination in another document

LAUNCH = 4

launch app (or open document)

URI = 5

URI

NAMED = 6

predefined action

MOVIE = 7

play movies.

New in version 0.14.

RENDITION = 8

play multimedia content.

New in version 0.14.

OCG_STATE = 9

state of layer.

New in version 0.14.

class Poppler.AdditionalActionType(value)

Bases: GObject.GEnum

Form field additional action types to be passed to poppler_form_field_get_additional_action

New in version 0.72.

FIELD_MODIFIED = 0

The action to be performed when the user modifies the field.

FORMAT_FIELD = 1

The action to be performed before the field is formatted to display its value.

VALIDATE_FIELD = 2

The action to be performed when the field value changes.

CALCULATE_FIELD = 3

The action to be performed when the field needs to be recalculated.

class Poppler.AnnotExternalDataType(value)

Bases: GObject.GEnum

3D = 0
_3D = 0
UNKNOWN = 1
class Poppler.AnnotFreeTextQuadding(value)

Bases: GObject.GEnum

LEFT_JUSTIFIED = 0
CENTERED = 1
RIGHT_JUSTIFIED = 2
class Poppler.AnnotMarkupReplyType(value)

Bases: GObject.GEnum

R = 0
GROUP = 1
class Poppler.AnnotStampIcon(value)

Bases: GObject.GEnum

UNKNOWN = 0
APPROVED = 1
DEPARTMENTAL = 10
FOR_COMMENT = 11
FOR_PUBLIC_RELEASE = 12
TOP_SECRET = 13
NONE = 14
AS_IS = 2
CONFIDENTIAL = 3
FINAL = 4
EXPERIMENTAL = 5
EXPIRED = 6
NOT_APPROVED = 7
NOT_FOR_PUBLIC_RELEASE = 8
SOLD = 9
class Poppler.AnnotTextState(value)

Bases: GObject.GEnum

MARKED = 0
UNMARKED = 1
ACCEPTED = 2
REJECTED = 3
CANCELLED = 4
COMPLETED = 5
NONE = 6
UNKNOWN = 7
class Poppler.AnnotType(value)

Bases: GObject.GEnum

UNKNOWN = 0
TEXT = 1
UNDERLINE = 10
SQUIGGLY = 11
STRIKE_OUT = 12
STAMP = 13
CARET = 14
INK = 15
POPUP = 16
FILE_ATTACHMENT = 17
SOUND = 18
MOVIE = 19
WIDGET = 20
SCREEN = 21
PRINTER_MARK = 22
TRAP_NET = 23
WATERMARK = 24
3D = 25
_3D = 25
FREE_TEXT = 3
LINE = 4
SQUARE = 5
CIRCLE = 6
POLYGON = 7
POLY_LINE = 8
HIGHLIGHT = 9
class Poppler.Backend(value)

Bases: GObject.GEnum

Backend codes returned by Poppler.get_backend().

UNKNOWN = 0

Unknown backend

SPLASH = 1

Splash backend

CAIRO = 2

Cairo backend

class Poppler.CertificateStatus(value)

Bases: GObject.GEnum

Signature certificate verification results

New in version 21.12.0.

TRUSTED = 0

certificate is considered trusted

UNTRUSTED_ISSUER = 1

the issuer of this certificate has been marked as untrusted by the user

UNKNOWN_ISSUER = 2

this certificate trust chain has not finished in a trusted root certificate

REVOKED = 3

certificate was revoked by the issuing certificate authority

EXPIRED = 4

signing time is outside the validity bounds of this certificate

GENERIC_ERROR = 5

failed to verify certificate

NOT_VERIFIED = 6

certificate not yet verified

class Poppler.DestType(value)

Bases: GObject.GEnum

Destination types

UNKNOWN = 0

unknown destination

XYZ = 1

go to page with coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom

FIT = 2

go to page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically

FITH = 3

go to page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window

FITV = 4

go to page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window

FITR = 5

go to page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically

FITB = 6

go to page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically

FITBH = 7

go to page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window

FITBV = 8

go to page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window

NAMED = 9

got to page specified by a name. See Poppler.Document.find_dest()

class Poppler.Error(value)

Bases: GObject.GEnum

Error codes returned by Poppler.Document

classmethod quark()
Return type:

int

INVALID = 0

Generic error when a document operation fails

ENCRYPTED = 1

Document is encrypted

OPEN_FILE = 2

File could not be opened for writing when saving document

BAD_CATALOG = 3

Failed to read the document catalog

DAMAGED = 4

Document is damaged

SIGNING = 5
class Poppler.FontType(value)

Bases: GObject.GEnum

Font types

UNKNOWN = 0

unknown font type

TYPE1 = 1

Type 1 font type

CID_TYPE2 = 10

CIDFont type based on TrueType font technology

CID_TYPE2OT = 11

CIDFont type based on TrueType font technology embedded in OpenType font program

TYPE1C = 2

Type 1 font type embedded in Compact Font Format (CFF) font program

TYPE1COT = 3

Type 1 font type embedded in OpenType font program

TYPE3 = 4

A font type that is defined with PDF graphics operators

TRUETYPE = 5

TrueType font type

TRUETYPEOT = 6

TrueType font type embedded in OpenType font program

CID_TYPE0 = 7

CIDFont type based on Type 1 font technology

CID_TYPE0C = 8

CIDFont type based on Type 1 font technology embedded in CFF font program

CID_TYPE0COT = 9

CIDFont type based on Type 1 font technology embedded in OpenType font program

class Poppler.FormButtonType(value)

Bases: GObject.GEnum

PUSH = 0
CHECK = 1
RADIO = 2
class Poppler.FormChoiceType(value)

Bases: GObject.GEnum

COMBO = 0
LIST = 1
class Poppler.FormFieldType(value)

Bases: GObject.GEnum

UNKNOWN = 0
BUTTON = 1
TEXT = 2
CHOICE = 3
SIGNATURE = 4
class Poppler.FormTextType(value)

Bases: GObject.GEnum

NORMAL = 0
MULTILINE = 1
FILE_SELECT = 2
class Poppler.MoviePlayMode(value)

Bases: GObject.GEnum

Play mode enum values.

New in version 0.54.

ONCE = 0

the movie should be played once and controls should be closed at the end.

OPEN = 1

the movie should be played once, but controls should be left open.

REPEAT = 2

the movie should be played in loop, until manually stopped.

PALINDROME = 3

the movie should be played forward and backward, forward and backward, and so forth, until manually stopped.

class Poppler.PDFConformance(value)

Bases: GObject.GEnum

PDF Subtype Conformance

New in version 0.70.

UNSET = 0

Null

A = 1

Level A (accessible) conformance (PDF/A)

B = 2

Level B (basic) conformance (PDF/A)

G = 3

Level G (external graphical content) (PDF/X)

N = 4

Level N (external ICC Profile) (PDF/X)

P = 5

Level P (ICC Profile) (PDF/X)

PG = 6

Level PG (conjunction of P and G) (PDF/X)

U = 7

Level U (Unicode) conformance (PDF/A)

NONE = 8

No conformance level available

class Poppler.PDFPart(value)

Bases: GObject.GEnum

PDF Subtype Part

New in version 0.70.

UNSET = 0

Null

1 = 1
_1 = 1

1

2 = 2
_2 = 2

2

3 = 3
_3 = 3

3

4 = 4
_4 = 4

4

5 = 5
_5 = 5

5

6 = 6
_6 = 6

6

7 = 7
_7 = 7

7

8 = 8
_8 = 8

8

NONE = 9

No part available

class Poppler.PDFSubtype(value)

Bases: GObject.GEnum

PDF Subtype

New in version 0.70.

UNSET = 0

Null

PDF_A = 1

ISO 19005 - Document management – Electronic document file format for long-term preservation (PDF/A)

PDF_E = 2

ISO 24517 - Document management – Engineering document format using PDF (PDF/E)

PDF_UA = 3

ISO 14289 - Document management applications – Electronic document file format enhancement for accessibility (PDF/UA)

PDF_VT = 4

ISO 16612 - Graphic technology – Variable data exchange (PDF/VT)

PDF_X = 5

ISO 15930 - Graphic technology – Prepress digital data exchange (PDF/X)

NONE = 6

Not compliant with the above standards

class Poppler.PageLayout(value)

Bases: GObject.GEnum

Page layout types

UNSET = 0

no specific layout set

SINGLE_PAGE = 1

one page at a time

ONE_COLUMN = 2

pages in one column

TWO_COLUMN_LEFT = 3

pages in two columns with odd numbered pages on the left

TWO_COLUMN_RIGHT = 4

pages in two columns with odd numbered pages on the right

TWO_PAGE_LEFT = 5

two pages at a time with odd numbered pages on the left

TWO_PAGE_RIGHT = 6

two pages at a time with odd numbered pages on the right

class Poppler.PageMode(value)

Bases: GObject.GEnum

Page modes

UNSET = 0

no specific mode set

NONE = 1

neither document outline nor thumbnails visible

USE_OUTLINES = 2

document outline visible

USE_THUMBS = 3

thumbnails visible

FULL_SCREEN = 4

full-screen mode

USE_OC = 5

layers panel visible

USE_ATTACHMENTS = 6

attachments panel visible

class Poppler.PageTransitionAlignment(value)

Bases: GObject.GEnum

Page transition alignment types for Poppler.PageTransitionType.SPLIT and Poppler.PageTransitionType.BLINDS transition types

HORIZONTAL = 0

horizontal dimension

VERTICAL = 1

vertical dimension

class Poppler.PageTransitionDirection(value)

Bases: GObject.GEnum

Page transition direction types for Poppler.PageTransitionType.SPLIT, Poppler.PageTransitionType.BOX and Poppler.PageTransitionType.FLY transition types

INWARD = 0

inward from the edges of the page

OUTWARD = 1

outward from the center of the page

class Poppler.PageTransitionType(value)

Bases: GObject.GEnum

Page transition types

REPLACE = 0

the new page replace the old one

SPLIT = 1

two lines sweep across the screen, revealing the new page

UNCOVER = 10

the old page slides off the screen uncovering the new page

FADE = 11

the new page gradually becomes visible through the old one

BLINDS = 2

multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the new page

BOX = 3

a rectangular box sweeps inward from the edges of the page or outward from the center revealing the new page

WIPE = 4

a single line sweeps across the screen from one edge to the other revealing the new page

DISSOLVE = 5

the old page dissolves gradually to reveal the new one

GLITTER = 6

similar to Poppler.PageTransitionType.DISSOLVE, except that the effect sweeps across the page in a wide band moving from one side of the screen to the other

FLY = 7

changes are flown out or in to or from a location that is offscreen

PUSH = 8

the old page slides off the screen while the new page slides in

COVER = 9

the new page slides on to the screen covering the old page

class Poppler.PrintDuplex(value)

Bases: GObject.GEnum

Duplex viewer preference

New in version 0.80.

NONE = 0

No preference on duplex printing

SIMPLEX = 1

Print single-sided

DUPLEX_FLIP_SHORT_EDGE = 2

Duplex and flip on the short edge of the sheet

DUPLEX_FLIP_LONG_EDGE = 3

Duplex and flip on the long edge of the sheet

class Poppler.PrintScaling(value)

Bases: GObject.GEnum

PrintScaling viewer preference

New in version 0.73.

APP_DEFAULT = 0

application’s default page scaling

NONE = 1

no page scaling

class Poppler.SelectionStyle(value)

Bases: GObject.GEnum

Selection styles

GLYPH = 0

glyph is the minimum unit for selection

WORD = 1

word is the minimum unit for selection

LINE = 2

line is the minimum unit for selection

class Poppler.SignatureStatus(value)

Bases: GObject.GEnum

Signature verification results

New in version 21.12.0.

VALID = 0

signature is cryptographically valid

INVALID = 1

signature is cryptographically invalid

DIGEST_MISMATCH = 2

document content was changed after the signature was applied

DECODING_ERROR = 3

signature CMS/PKCS7 structure is malformed

GENERIC_ERROR = 4

failed to verify signature

NOT_FOUND = 5

requested signature is not present in the document

NOT_VERIFIED = 6

signature not yet verified

class Poppler.StructureBlockAlign(value)

Bases: GObject.GEnum

BEFORE = 0
MIDDLE = 1
AFTER = 2
JUSTIFY = 3
class Poppler.StructureBorderStyle(value)

Bases: GObject.GEnum

NONE = 0
HIDDEN = 1
DOTTED = 2
DASHED = 3
SOLID = 4
DOUBLE = 5
GROOVE = 6
INSET = 7
OUTSET = 8
class Poppler.StructureElementKind(value)

Bases: GObject.GEnum

CONTENT = 0
OBJECT_REFERENCE = 1
REFERENCE = 10
BIBENTRY = 11
CODE = 12
ANNOT = 14
BLOCKQUOTE = 15
CAPTION = 16
NONSTRUCT = 17
TOC = 18
TOC_ITEM = 19
DOCUMENT = 2
INDEX = 20
PRIVATE = 21
PARAGRAPH = 22
HEADING = 23
HEADING_1 = 24
HEADING_2 = 25
HEADING_3 = 26
HEADING_4 = 27
HEADING_5 = 28
HEADING_6 = 29
PART = 3
LIST = 30
LIST_ITEM = 31
LIST_LABEL = 32
LIST_BODY = 33
TABLE = 34
TABLE_ROW = 35
TABLE_HEADING = 36
TABLE_DATA = 37
TABLE_HEADER = 38
ARTICLE = 4
TABLE_BODY = 40
RUBY = 41
RUBY_BASE_TEXT = 42
RUBY_ANNOT_TEXT = 43
RUBY_PUNCTUATION = 44
WARICHU = 45
WARICHU_TEXT = 46
WARICHU_PUNCTUATION = 47
FIGURE = 48
FORMULA = 49
SECTION = 5
FORM = 50
DIV = 6
SPAN = 7
QUOTE = 8
NOTE = 9
class Poppler.StructureFormRole(value)

Bases: GObject.GEnum

UNDEFINED = 0
RADIO_BUTTON = 1
PUSH_BUTTON = 2
TEXT_VALUE = 3
CHECKBOX = 4
class Poppler.StructureFormState(value)

Bases: GObject.GEnum

ON = 0
OFF = 1
NEUTRAL = 2
class Poppler.StructureGlyphOrientation(value)

Bases: GObject.GEnum

0 = 0
AUTO = 0
_0 = 0
90 = 1
_90 = 1
180 = 2
_180 = 2
270 = 3
_270 = 3
class Poppler.StructureInlineAlign(value)

Bases: GObject.GEnum

START = 0
CENTER = 1
END = 2
class Poppler.StructureListNumbering(value)

Bases: GObject.GEnum

NONE = 0
DISC = 1
CIRCLE = 2
SQUARE = 3
DECIMAL = 4
UPPER_ROMAN = 5
LOWER_ROMAN = 6
UPPER_ALPHA = 7
LOWER_ALPHA = 8
class Poppler.StructurePlacement(value)

Bases: GObject.GEnum

BLOCK = 0
INLINE = 1
BEFORE = 2
START = 3
END = 4
class Poppler.StructureRubyAlign(value)

Bases: GObject.GEnum

START = 0
CENTER = 1
END = 2
JUSTIFY = 3
DISTRIBUTE = 4
class Poppler.StructureRubyPosition(value)

Bases: GObject.GEnum

BEFORE = 0
AFTER = 1
WARICHU = 2
INLINE = 3
class Poppler.StructureTableScope(value)

Bases: GObject.GEnum

ROW = 0
COLUMN = 1
BOTH = 2
class Poppler.StructureTextAlign(value)

Bases: GObject.GEnum

START = 0
CENTER = 1
END = 2
JUSTIFY = 3
class Poppler.StructureTextDecoration(value)

Bases: GObject.GEnum

NONE = 0
UNDERLINE = 1
OVERLINE = 2
LINETHROUGH = 3
class Poppler.StructureWritingMode(value)

Bases: GObject.GEnum

LR_TB = 0
RL_TB = 1
TB_RL = 2