/// /// /// /// /// /// /** * Type Definitions for Gjs (https://gjs.guide/) * * These type definitions are automatically generated, do not edit them by hand. * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir * * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ... */ declare module 'gi://Poppler?version=0.18' { // Module dependencies import type cairo from 'cairo'; import type GObject from 'gi://GObject?version=2.0'; import type GLib from 'gi://GLib?version=2.0'; import type Gio from 'gi://Gio?version=2.0'; import type GModule from 'gi://GModule?version=2.0'; export namespace Poppler { /** * Poppler-0.18 */ /** * Layer actions */ /** * Layer actions */ export namespace ActionLayerAction { export const $gtype: GObject.GType; } enum ActionLayerAction { /** * set layer visibility on */ ON, /** * set layer visibility off */ OFF, /** * reverse the layer visibility state */ TOGGLE, } /** * Movie operations */ /** * Movie operations */ export namespace ActionMovieOperation { export const $gtype: GObject.GType; } enum ActionMovieOperation { /** * play movie */ PLAY, /** * pause playing movie */ PAUSE, /** * resume paused movie */ RESUME, /** * stop playing movie */ STOP, } /** * Action types */ /** * Action types */ export namespace ActionType { export const $gtype: GObject.GType; } enum ActionType { /** * unknown action */ UNKNOWN, /** * no action specified */ NONE, /** * go to destination */ GOTO_DEST, /** * go to destination in another document */ GOTO_REMOTE, /** * launch app (or open document) */ LAUNCH, /** * URI */ URI, /** * predefined action */ NAMED, /** * play movies. Since 0.14 */ MOVIE, /** * play multimedia content. Since 0.14 */ RENDITION, /** * state of layer. Since 0.14 */ OCG_STATE, /** * Javascript. Since 0.18 */ JAVASCRIPT, /** * resets form. Since 0.90 */ RESET_FORM, } /** * Form field additional action types to be passed to `poppler_form_field_get_additional_action` */ /** * Form field additional action types to be passed to `poppler_form_field_get_additional_action` */ export namespace AdditionalActionType { export const $gtype: GObject.GType; } enum AdditionalActionType { /** * The action to be performed when the user modifies the field. */ FIELD_MODIFIED, /** * The action to be performed before the field is formatted to * display its value. */ FORMAT_FIELD, /** * The action to be performed when the field value changes. */ VALIDATE_FIELD, /** * The action to be performed when the field needs to be * recalculated. */ CALCULATE_FIELD, } export namespace AnnotExternalDataType { export const $gtype: GObject.GType; } enum AnnotExternalDataType { '3D', UNKNOWN, } export namespace AnnotFreeTextQuadding { export const $gtype: GObject.GType; } enum AnnotFreeTextQuadding { LEFT_JUSTIFIED, CENTERED, RIGHT_JUSTIFIED, } export namespace AnnotMarkupReplyType { export const $gtype: GObject.GType; } enum AnnotMarkupReplyType { R, GROUP, } export namespace AnnotStampIcon { export const $gtype: GObject.GType; } enum AnnotStampIcon { UNKNOWN, APPROVED, AS_IS, CONFIDENTIAL, FINAL, EXPERIMENTAL, EXPIRED, NOT_APPROVED, NOT_FOR_PUBLIC_RELEASE, SOLD, DEPARTMENTAL, FOR_COMMENT, FOR_PUBLIC_RELEASE, TOP_SECRET, NONE, } export namespace AnnotTextState { export const $gtype: GObject.GType; } enum AnnotTextState { MARKED, UNMARKED, ACCEPTED, REJECTED, CANCELLED, COMPLETED, NONE, UNKNOWN, } export namespace AnnotType { export const $gtype: GObject.GType; } enum AnnotType { UNKNOWN, TEXT, LINK, FREE_TEXT, LINE, SQUARE, CIRCLE, POLYGON, POLY_LINE, HIGHLIGHT, UNDERLINE, SQUIGGLY, STRIKE_OUT, STAMP, CARET, INK, POPUP, FILE_ATTACHMENT, SOUND, MOVIE, WIDGET, SCREEN, PRINTER_MARK, TRAP_NET, WATERMARK, '3D', } /** * Backend codes returned by poppler_get_backend(). */ /** * Backend codes returned by poppler_get_backend(). */ export namespace Backend { export const $gtype: GObject.GType; } enum Backend { /** * Unknown backend */ UNKNOWN, /** * Splash backend */ SPLASH, /** * Cairo backend */ CAIRO, } /** * Signature certificate verification results */ /** * Signature certificate verification results */ export namespace CertificateStatus { export const $gtype: GObject.GType; } enum CertificateStatus { /** * certificate is considered trusted */ TRUSTED, /** * the issuer of this certificate has been marked as untrusted by the user */ UNTRUSTED_ISSUER, /** * this certificate trust chain has not finished in a trusted root certificate */ UNKNOWN_ISSUER, /** * certificate was revoked by the issuing certificate authority */ REVOKED, /** * signing time is outside the validity bounds of this certificate */ EXPIRED, /** * failed to verify certificate */ GENERIC_ERROR, /** * certificate not yet verified */ NOT_VERIFIED, } /** * Destination types */ /** * Destination types */ export namespace DestType { export const $gtype: GObject.GType; } enum DestType { /** * unknown destination */ UNKNOWN, /** * 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 */ XYZ, /** * go to page with its contents magnified just * enough to fit the entire page within the window both horizontally and * vertically */ FIT, /** * 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 */ FITH, /** * 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 */ FITV, /** * 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 */ FITR, /** * go to page with its contents magnified just enough to fit * its bounding box entirely within the window both horizontally and vertically */ FITB, /** * 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 */ FITBH, /** * 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 */ FITBV, /** * got to page specified by a name. See poppler_document_find_dest() */ NAMED, } /** * Error codes returned by #PopplerDocument */ class Error extends GLib.Error { static $gtype: GObject.GType; // Static fields /** * Generic error when a document operation fails */ static INVALID: number; /** * Document is encrypted */ static ENCRYPTED: number; /** * File could not be opened for writing when saving document */ static OPEN_FILE: number; /** * Failed to read the document catalog */ static BAD_CATALOG: number; /** * Document is damaged */ static DAMAGED: number; static SIGNING: number; // Constructors constructor(options: { message: string; code: number }); _init(...args: any[]): void; // Static methods static quark(): GLib.Quark; } /** * Font types */ /** * Font types */ export namespace FontType { export const $gtype: GObject.GType; } enum FontType { /** * unknown font type */ UNKNOWN, /** * Type 1 font type */ TYPE1, /** * Type 1 font type embedded in Compact Font Format (CFF) font program */ TYPE1C, /** * Type 1 font type embedded in OpenType font program */ TYPE1COT, /** * A font type that is defined with PDF graphics operators */ TYPE3, /** * TrueType font type */ TRUETYPE, /** * TrueType font type embedded in OpenType font program */ TRUETYPEOT, /** * CIDFont type based on Type 1 font technology */ CID_TYPE0, /** * CIDFont type based on Type 1 font technology embedded in CFF font program */ CID_TYPE0C, /** * CIDFont type based on Type 1 font technology embedded in OpenType font program */ CID_TYPE0COT, /** * CIDFont type based on TrueType font technology */ CID_TYPE2, /** * CIDFont type based on TrueType font technology embedded in OpenType font program */ CID_TYPE2OT, } export namespace FormButtonType { export const $gtype: GObject.GType; } enum FormButtonType { PUSH, CHECK, RADIO, } export namespace FormChoiceType { export const $gtype: GObject.GType; } enum FormChoiceType { COMBO, LIST, } export namespace FormFieldType { export const $gtype: GObject.GType; } enum FormFieldType { UNKNOWN, BUTTON, TEXT, CHOICE, SIGNATURE, } export namespace FormTextType { export const $gtype: GObject.GType; } enum FormTextType { NORMAL, MULTILINE, FILE_SELECT, } /** * Play mode enum values. */ /** * Play mode enum values. */ export namespace MoviePlayMode { export const $gtype: GObject.GType; } enum MoviePlayMode { /** * the movie should be played once and controls should be closed at the end. */ ONCE, /** * the movie should be played once, but controls should be left open. */ OPEN, /** * the movie should be played in loop, until manually stopped. */ REPEAT, /** * the movie should be played forward and backward, forward and backward, * and so forth, until manually stopped. */ PALINDROME, } /** * PDF Subtype Conformance */ /** * PDF Subtype Conformance */ export namespace PDFConformance { export const $gtype: GObject.GType; } enum PDFConformance { /** * Null */ UNSET, /** * Level A (accessible) conformance (PDF/A) */ A, /** * Level B (basic) conformance (PDF/A) */ B, /** * Level G (external graphical content) (PDF/X) */ G, /** * Level N (external ICC Profile) (PDF/X) */ N, /** * Level P (ICC Profile) (PDF/X) */ P, /** * Level PG (conjunction of P and G) (PDF/X) */ PG, /** * Level U (Unicode) conformance (PDF/A) */ U, /** * No conformance level available */ NONE, } /** * PDF Subtype Part */ /** * PDF Subtype Part */ class PDFPart { static $gtype: GObject.GType; // Static fields /** * Null */ static UNSET: number; /** * 1 */ static '1': number; /** * 2 */ static '2': number; /** * 3 */ static '3': number; /** * 4 */ static '4': number; /** * 5 */ static '5': number; /** * 6 */ static '6': number; /** * 7 */ static '7': number; /** * 8 */ static '8': number; /** * No part available */ static NONE: number; // Constructors _init(...args: any[]): void; } /** * PDF Subtype */ /** * PDF Subtype */ export namespace PDFSubtype { export const $gtype: GObject.GType; } enum PDFSubtype { /** * Null */ UNSET, /** * ISO 19005 - Document management -- Electronic document file format for long-term preservation (PDF/A) */ PDF_A, /** * ISO 24517 - Document management -- Engineering document format using PDF (PDF/E) */ PDF_E, /** * ISO 14289 - Document management applications -- Electronic document file format enhancement for accessibility (PDF/UA) */ PDF_UA, /** * ISO 16612 - Graphic technology -- Variable data exchange (PDF/VT) */ PDF_VT, /** * ISO 15930 - Graphic technology -- Prepress digital data exchange (PDF/X) */ PDF_X, /** * Not compliant with the above standards */ NONE, } /** * Page layout types */ /** * Page layout types */ export namespace PageLayout { export const $gtype: GObject.GType; } enum PageLayout { /** * no specific layout set */ UNSET, /** * one page at a time */ SINGLE_PAGE, /** * pages in one column */ ONE_COLUMN, /** * pages in two columns with odd numbered pages on the left */ TWO_COLUMN_LEFT, /** * pages in two columns with odd numbered pages on the right */ TWO_COLUMN_RIGHT, /** * two pages at a time with odd numbered pages on the left */ TWO_PAGE_LEFT, /** * two pages at a time with odd numbered pages on the right */ TWO_PAGE_RIGHT, } /** * Page modes */ /** * Page modes */ export namespace PageMode { export const $gtype: GObject.GType; } enum PageMode { /** * no specific mode set */ UNSET, /** * neither document outline nor thumbnails visible */ NONE, /** * document outline visible */ USE_OUTLINES, /** * thumbnails visible */ USE_THUMBS, /** * full-screen mode */ FULL_SCREEN, /** * layers panel visible */ USE_OC, /** * attachments panel visible */ USE_ATTACHMENTS, } /** * Page transition alignment types for #POPPLER_PAGE_TRANSITION_SPLIT * and #POPPLER_PAGE_TRANSITION_BLINDS transition types */ /** * Page transition alignment types for #POPPLER_PAGE_TRANSITION_SPLIT * and #POPPLER_PAGE_TRANSITION_BLINDS transition types */ export namespace PageTransitionAlignment { export const $gtype: GObject.GType; } enum PageTransitionAlignment { /** * horizontal dimension */ HORIZONTAL, /** * vertical dimension */ VERTICAL, } /** * Page transition direction types for #POPPLER_PAGE_TRANSITION_SPLIT, * #POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY transition types */ /** * Page transition direction types for #POPPLER_PAGE_TRANSITION_SPLIT, * #POPPLER_PAGE_TRANSITION_BOX and #POPPLER_PAGE_TRANSITION_FLY transition types */ export namespace PageTransitionDirection { export const $gtype: GObject.GType; } enum PageTransitionDirection { /** * inward from the edges of the page */ INWARD, /** * outward from the center of the page */ OUTWARD, } /** * Page transition types */ /** * Page transition types */ export namespace PageTransitionType { export const $gtype: GObject.GType; } enum PageTransitionType { /** * the new page replace the old one */ REPLACE, /** * two lines sweep across the screen, revealing the new page */ SPLIT, /** * multiple lines, evenly spaced across the screen, synchronously * sweep in the same direction to reveal the new page */ BLINDS, /** * a rectangular box sweeps inward from the edges of the page or * outward from the center revealing the new page */ BOX, /** * a single line sweeps across the screen from one edge to the other * revealing the new page */ WIPE, /** * the old page dissolves gradually to reveal the new one */ DISSOLVE, /** * similar to #POPPLER_PAGE_TRANSITION_DISSOLVE, except that the effect * sweeps across the page in a wide band moving from one side of the screen to the other */ GLITTER, /** * changes are flown out or in to or from a location that is offscreen */ FLY, /** * the old page slides off the screen while the new page slides in */ PUSH, /** * the new page slides on to the screen covering the old page */ COVER, /** * the old page slides off the screen uncovering the new page */ UNCOVER, /** * the new page gradually becomes visible through the old one */ FADE, } /** * Duplex viewer preference */ /** * Duplex viewer preference */ export namespace PrintDuplex { export const $gtype: GObject.GType; } enum PrintDuplex { /** * No preference on duplex printing */ NONE, /** * Print single-sided */ SIMPLEX, /** * Duplex and flip on the short edge of the sheet */ DUPLEX_FLIP_SHORT_EDGE, /** * Duplex and flip on the long edge of the sheet */ DUPLEX_FLIP_LONG_EDGE, } /** * PrintScaling viewer preference */ /** * PrintScaling viewer preference */ export namespace PrintScaling { export const $gtype: GObject.GType; } enum PrintScaling { /** * application's default page scaling */ APP_DEFAULT, /** * no page scaling */ NONE, } /** * Selection styles */ /** * Selection styles */ export namespace SelectionStyle { export const $gtype: GObject.GType; } enum SelectionStyle { /** * glyph is the minimum unit for selection */ GLYPH, /** * word is the minimum unit for selection */ WORD, /** * line is the minimum unit for selection */ LINE, } /** * Signature verification results */ /** * Signature verification results */ export namespace SignatureStatus { export const $gtype: GObject.GType; } enum SignatureStatus { /** * signature is cryptographically valid */ VALID, /** * signature is cryptographically invalid */ INVALID, /** * document content was changed after the signature was applied */ DIGEST_MISMATCH, /** * signature CMS/PKCS7 structure is malformed */ DECODING_ERROR, /** * failed to verify signature */ GENERIC_ERROR, /** * requested signature is not present in the document */ NOT_FOUND, /** * signature not yet verified */ NOT_VERIFIED, } export namespace Stretch { export const $gtype: GObject.GType; } enum Stretch { ULTRA_CONDENSED, EXTRA_CONDENSED, CONDENSED, SEMI_CONDENSED, NORMAL, SEMI_EXPANDED, EXPANDED, EXTRA_EXPANDED, ULTRA_EXPANDED, } export namespace StructureBlockAlign { export const $gtype: GObject.GType; } enum StructureBlockAlign { BEFORE, MIDDLE, AFTER, JUSTIFY, } export namespace StructureBorderStyle { export const $gtype: GObject.GType; } enum StructureBorderStyle { NONE, HIDDEN, DOTTED, DASHED, SOLID, DOUBLE, GROOVE, INSET, OUTSET, } export namespace StructureElementKind { export const $gtype: GObject.GType; } enum StructureElementKind { CONTENT, OBJECT_REFERENCE, DOCUMENT, PART, ARTICLE, SECTION, DIV, SPAN, QUOTE, NOTE, REFERENCE, BIBENTRY, CODE, LINK, ANNOT, BLOCKQUOTE, CAPTION, NONSTRUCT, TOC, TOC_ITEM, INDEX, PRIVATE, PARAGRAPH, HEADING, HEADING_1, HEADING_2, HEADING_3, HEADING_4, HEADING_5, HEADING_6, LIST, LIST_ITEM, LIST_LABEL, LIST_BODY, TABLE, TABLE_ROW, TABLE_HEADING, TABLE_DATA, TABLE_HEADER, TABLE_FOOTER, TABLE_BODY, RUBY, RUBY_BASE_TEXT, RUBY_ANNOT_TEXT, RUBY_PUNCTUATION, WARICHU, WARICHU_TEXT, WARICHU_PUNCTUATION, FIGURE, FORMULA, FORM, } export namespace StructureFormRole { export const $gtype: GObject.GType; } enum StructureFormRole { UNDEFINED, RADIO_BUTTON, PUSH_BUTTON, TEXT_VALUE, CHECKBOX, } export namespace StructureFormState { export const $gtype: GObject.GType; } enum StructureFormState { ON, OFF, NEUTRAL, } class StructureGlyphOrientation { static $gtype: GObject.GType; // Static fields static AUTO: number; static '0': number; static '90': number; static '180': number; static '270': number; // Constructors _init(...args: any[]): void; } export namespace StructureInlineAlign { export const $gtype: GObject.GType; } enum StructureInlineAlign { START, CENTER, END, } export namespace StructureListNumbering { export const $gtype: GObject.GType; } enum StructureListNumbering { NONE, DISC, CIRCLE, SQUARE, DECIMAL, UPPER_ROMAN, LOWER_ROMAN, UPPER_ALPHA, LOWER_ALPHA, } export namespace StructurePlacement { export const $gtype: GObject.GType; } enum StructurePlacement { BLOCK, INLINE, BEFORE, START, END, } export namespace StructureRubyAlign { export const $gtype: GObject.GType; } enum StructureRubyAlign { START, CENTER, END, JUSTIFY, DISTRIBUTE, } export namespace StructureRubyPosition { export const $gtype: GObject.GType; } enum StructureRubyPosition { BEFORE, AFTER, WARICHU, INLINE, } export namespace StructureTableScope { export const $gtype: GObject.GType; } enum StructureTableScope { ROW, COLUMN, BOTH, } export namespace StructureTextAlign { export const $gtype: GObject.GType; } enum StructureTextAlign { START, CENTER, END, JUSTIFY, } export namespace StructureTextDecoration { export const $gtype: GObject.GType; } enum StructureTextDecoration { NONE, UNDERLINE, OVERLINE, LINETHROUGH, } export namespace StructureWritingMode { export const $gtype: GObject.GType; } enum StructureWritingMode { LR_TB, RL_TB, TB_RL, } export namespace Style { export const $gtype: GObject.GType