Module: Poppler

Extended by:
GLib::Deprecatable
Defined in:
lib/poppler/page.rb,
lib/poppler.rb,
lib/poppler/color.rb,
lib/poppler/loader.rb,
lib/poppler/version.rb,
lib/poppler/document.rb,
lib/poppler/rectangle.rb,
lib/poppler/deprecated.rb,
lib/poppler/index-iter.rb,
lib/poppler/image-mapping.rb,
lib/poppler/annot-callout-line.rb

Overview

Copyright (C) 2017 Ruby-GNOME2 Project Team

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Defined Under Namespace

Modules: ActionLayerAction, ActionMovieOperation, ActionType, AdditionalActionType, AnnotExternalDataType, AnnotFlag, AnnotFreeTextQuadding, AnnotMarkupReplyType, AnnotStampIcon, AnnotTextState, AnnotType, Backend, CertificateStatus, DestType, Error, FindFlags, FontType, FormButtonType, FormChoiceType, FormFieldType, FormTextType, MoviePlayMode, PDFConformance, PDFPart, PDFSubtype, PageLayout, PageMode, PageTransitionAlignment, PageTransitionDirection, PageTransitionType, Permissions, PrintDuplex, PrintFlags, PrintScaling, SelectionStyle, SignatureStatus, SignatureValidationFlags, StructureBlockAlign, StructureBorderStyle, StructureElementKind, StructureFormRole, StructureFormState, StructureGetTextFlags, StructureGlyphOrientation, StructureInlineAlign, StructureListNumbering, StructurePlacement, StructureRubyAlign, StructureRubyPosition, StructureTableScope, StructureTextAlign, StructureTextDecoration, StructureWritingMode, Version, ViewerPreferences Classes: Annot, AnnotCalloutLine, AnnotCircle, AnnotFileAttachment, AnnotFreeText, AnnotLine, AnnotMapping, AnnotMarkup, AnnotMovie, AnnotScreen, AnnotSquare, AnnotStamp, AnnotText, AnnotTextMarkup, Attachment, Color, Document, FontInfo, FormField, ImageMapping, IndexIter, Layer, Loader, Media, Movie, PSFile, Page, Rectangle, StructureElement

Constant Summary collapse

ANNOT_TEXT_ICON_CIRCLE = 
Circle
ANNOT_TEXT_ICON_COMMENT = 
Comment
ANNOT_TEXT_ICON_CROSS = 
Cross
ANNOT_TEXT_ICON_HELP = 
Help
ANNOT_TEXT_ICON_INSERT = 
Insert
ANNOT_TEXT_ICON_KEY = 
Key
ANNOT_TEXT_ICON_NEW_PARAGRAPH = 
NewParagraph
ANNOT_TEXT_ICON_NOTE = 
Note
ANNOT_TEXT_ICON_PARAGRAPH = 
Paragraph
HAS_CAIRO =

Defined if poppler was compiled with cairo support.

1
MAJOR_VERSION =

The major version number of the poppler header files (e.g. in poppler version 0.1.2 this is 0.)

24
MICRO_VERSION =

The micro version number of the poppler header files (e.g. in poppler version 0.1.2 this is 2.)

0
MINOR_VERSION =

The major version number of the poppler header files (e.g. in poppler version 0.1.2 this is 1.)

2
LOG_DOMAIN = 
"Poppler"

Instance Method Summary collapse

Instance Method Details

#available_signing_certificates ⇒ GLib::List<Poppler::CertificateInfo>

Get all available signing certificate information

Returns:

  • (GLib::List<Poppler::CertificateInfo>) —

    all available signing certificate information

#backend ⇒ Poppler::Backend

Returns the backend compiled into the poppler library.

Returns:

#date_parse(date, timet) ⇒ Boolean

Parses a PDF format date string and converts it to a #time_t. Returns #FALSE if the parsing fails or the input string is not a valid PDF format date string

Parameters:

  • date (String) —

    string to parse

  • timet (Poppler::time_t) —

    an uninitialized #time_t

Returns:

  • (Boolean) —

    #TRUE, if timet was set

#error_quark ⇒ GLib::Quark

Returns:

  • (GLib::Quark)

#get_certificate_info_by_id(id) ⇒ Poppler::CertificateInfo

Get certificate by nick name

Parameters:

  • id (String)

Returns:

  • (Poppler::CertificateInfo) —

    a Poppler::CertificateInfo or nil if not found

#named_dest_from_bytestring(data, length) ⇒ String

Converts a bytestring into a zero-terminated string suitable to pass to poppler_document_find_dest().

Note that the returned string has no defined encoding and is not suitable for display to the user.

The returned data must be freed using g_free().

Parameters:

  • data (Array<Integer>) —

    the bytestring data

  • length (Integer) —

    the bytestring length

Returns:

  • (String) —

    the named dest

#named_dest_to_bytestring(name, length) ⇒ Array<Integer>

Converts a named dest string (e.g. from Poppler::Dest.named_dest) into a bytestring, inverting the transformation of poppler_named_dest_from_bytestring().

Note that the returned data is not zero terminated and may also contains embedded NUL bytes.

If name is not a valid named dest string, returns nil.

The returned data must be freed using g_free().

Parameters:

  • name (String) —

    the named dest string

  • length (Integer) —

    a location to store the length of the returned bytestring

Returns:

  • (Array<Integer>) —

    a new bytestring, or nil

#nss_dir ⇒ String

Get NSS directory

Returns:

  • (String) —

    nss directroy.

#nss_dir=(path) ⇒ nil

Set NSS directory

Parameters:

  • path (String)

Returns:

  • (nil)

#nss_password_callback=(func) ⇒ nil

A callback which asks for certificate password

Parameters:

  • func (Poppler::NssPasswordFunc) —

    a Poppler::NssPasswordFunc that represents a signature annotation

Returns:

  • (nil)

#version ⇒ String

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

Returns:

  • (String) —

    the version of poppler.