Class (GI Class)

Poppler-0.18 ▶ Poppler ▶ Document

A poppler document.

Since 25.06 this type supports g_autoptr

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

$signals $gtype

Accessors

author creation_date creation_datetime creationDate creationDatetime creator format format_major format_minor formatMajor formatMinor keywords linearized metadata mod_date mod_datetime modDate modDatetime page_layout page_mode pageLayout pageMode permissions print_duplex print_n_copies print_scaling printDuplex printNCopies printScaling producer subject subtype subtype_conformance subtype_part subtype_string subtypeConformance subtypePart subtypeString title viewer_preferences viewerPreferences

Methods

_init connect connect_after create_dests_tree emit find_dest get_attachments get_author get_creation_date get_creation_date_time get_creator get_form_field get_id get_keywords get_metadata get_modification_date get_modification_date_time get_n_attachments get_n_pages get_n_signatures get_page get_page_by_label get_page_layout get_page_mode get_pdf_conformance get_pdf_part get_pdf_subtype get_pdf_subtype_string get_pdf_version get_pdf_version_string get_permissions get_print_duplex get_print_n_copies get_print_page_ranges get_print_scaling get_producer get_signature_fields get_subject get_title has_attachments has_javascript is_linearized reset_form save save_a_copy save_to_fd set_author set_creation_date set_creation_date_time set_creator set_keywords set_modification_date set_modification_date_time set_producer set_subject set_title sign sign_finish new_from_bytes new_from_data new_from_fd new_from_file new_from_gfile new_from_stream

Methods - Inherited from GObject

bind_property bind_property_full block_signal_handler disconnect force_floating freeze_notify get_data get_property get_qdata getv is_floating notify notify_by_pspec ref ref_sink run_dispose set set_data set_property steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_property vfunc_notify vfunc_set_property watch_closure _classInit compat_control find_property install_properties install_property interface_find_property interface_install_property interface_list_properties list_properties newv override_property

Constructors

Properties

$signals: Poppler.Document.SignalSignatures

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<Poppler.Document>

Accessors

  • get creation_date(): number

    The date the document was created as seconds since the Epoch, or -1

    Returns number

    since 20.09.0: This will overflow in 2038. Use creation-datetime instead.

  • set creation_date(val: number): void

    Parameters

    • val: number

    Returns void

  • get creationDate(): number

    The date the document was created as seconds since the Epoch, or -1

    Returns number

    since 20.09.0: This will overflow in 2038. Use creation-datetime instead.

  • set creationDate(val: number): void

    Parameters

    • val: number

    Returns void

  • get mod_date(): number

    The date the document was most recently modified as seconds since the Epoch, or -1

    Returns number

    since 20.09.0: This will overflow in 2038. Use mod-datetime instead.

  • set mod_date(val: number): void

    Parameters

    • val: number

    Returns void

  • get modDate(): number

    The date the document was most recently modified as seconds since the Epoch, or -1

    Returns number

    since 20.09.0: This will overflow in 2038. Use mod-datetime instead.

  • set modDate(val: number): void

    Parameters

    • val: number

    Returns void

Read-Onlypage_layout

Read-Onlypage_mode

Methods

_init

  • Creates a balanced binary tree of all named destinations in document

    The tree key is strings in the form returned by poppler_named_dest_to_bytestring() which constains a destination name. The tree value is the Poppler.Dest which contains a named destination. The return value must be freed with g_tree_destroy().

    Returns GLib.Tree

    the GLib.Tree, or null

  • Creates a Poppler.Dest for the named destination link_name in document.

    Note that named destinations are bytestrings, not string. That means that unless link_name was returned by a poppler function (e.g. is Poppler.Dest.named_dest), it needs to be converted to string using poppler_named_dest_from_bytestring() before being passed to this function.

    The returned value must be freed with poppler_dest_free().

    Parameters

    • link_name: string

      a named destination

    Returns Dest

    a new Poppler.Dest destination, or null if link_name is not a destination.

  • Returns the author of the document

    Returns string

    a new allocated string containing the author of document, or null

  • Returns the date the document was created as seconds since the Epoch

    Returns number

    the date the document was created, or -1

  • Returns the creator of the document. If the document was converted from another format, the creator is the name of the product that created the original document from which it was converted.

    Returns string

    a new allocated string containing the creator of document, or null

  • Returns the PDF file identifier represented as two byte string arrays of size 32. permanent_id is the permanent identifier that is built based on the file contents at the time it was originally created, so that this identifer never changes. update_id is the update identifier that is built based on the file contents at the time it was last updated.

    Note that returned strings are not null-terminated, they have a fixed size of 32 bytes.

    Returns [boolean, string, string]

    true if the document contains an id, false otherwise

  • Returns the keywords associated to the document

    Returns string

    a new allocated string containing keywords associated to document, or null

  • Returns the XML metadata string of the document

    Returns string

    a new allocated string containing the XML metadata, or null

  • Returns the date the document was most recently modified as seconds since the Epoch

    Returns number

    the date the document was most recently modified, or -1

  • Returns the number of attachments in a loaded document. See also poppler_document_get_attachments()

    Returns number

    Number of attachments

  • Returns how many digital signatures document contains. PDF digital signatures ensure that the content hash not been altered since last edit and that it was produced by someone the user can trust

    Returns number

    The number of signatures found in the document

get_page

get_page_by_label

  • get_page_by_label(label: string): Poppler.Page

    Returns the Poppler.Page reference by label. This object is owned by the caller. label is a human-readable string representation of the page number, and can be document specific. Typically, it is a value such as "iii" or "3".

    By default, "1" refers to the first page.

    Parameters

    • label: string

      a page label

    Returns Poppler.Page

    The Poppler.Page referenced by label

get_page_layout

get_page_mode

  • Returns the PDF subtype version of document as a string.

    Returns string

    a newly allocated string containing the PDF subtype version of document, or null

  • Updates values referenced by major_version & minor_version with the major and minor PDF versions of document.

    Returns [number, number]

  • Returns the PDF version of document as a string (e.g. PDF-1.6)

    Returns string

    a new allocated string containing the PDF version of document, or null

  • Returns the suggested number of copies to be printed. This preference should be applied only if returned value is greater than 1 since value 1 usually means that the document does not specify it.

    Returns number

    Number of copies

get_print_page_ranges

  • Returns the producer of the document. If the document was converted from another format, the producer is the name of the product that converted it to PDF

    Returns string

    a new allocated string containing the producer of document, or null

  • Returns the subject of the document

    Returns string

    a new allocated string containing the subject of document, or null

  • Returns whether document is linearized or not. Linearization of PDF enables efficient incremental access of the PDF file in a network environment.

    Returns boolean

    true if document is linearized, false otherwise

  • Resets the form fields specified by fields if exclude_fields is FALSE. Resets all others if exclude_fields is TRUE. All form fields are reset regardless of the exclude_fields flag if fields is empty.

    Parameters

    • fields: string[]

      list of fields to reset

    • exclude_fields: boolean

      whether to reset all fields except those in fields

    Returns void

  • Saves document. Any change made in the document such as form fields filled, annotations added or modified will be saved. If error is set, false will be returned. Possible errors include those in the #G_FILE_ERROR domain.

    Parameters

    • uri: string

      uri of file to save

    Returns boolean

    true, if the document was successfully saved

  • Saves a copy of the original document. Any change made in the document such as form fields filled by the user will not be saved. If error is set, false will be returned. Possible errors include those in the #G_FILE_ERROR domain.

    Parameters

    • uri: string

      uri of file to save

    Returns boolean

    true, if the document was successfully saved

  • Saves document. Any change made in the document such as form fields filled, annotations added or modified will be saved if include_changes is true, or discarded i include_changes is false.

    Note that this function takes ownership of fd; you must not operate on it again, nor close it.

    If error is set, false will be returned. Possible errors include those in the #G_FILE_ERROR domain.

    Parameters

    • fd: number

      a valid file descriptor open for writing

    • include_changes: boolean

      whether to include user changes (e.g. form fills)

    Returns boolean

    true, if the document was successfully saved

  • Sets the document's author. If author is null, Author entry is removed from the document's Info dictionary.

    Parameters

    • author: string

      A new author

    Returns void

  • Sets the document's creation date. If creation_date is -1, CreationDate entry is removed from the document's Info dictionary.

    Parameters

    • creation_date: number

      A new creation date

    Returns void

  • Sets the document's creator. If creator is null, Creator entry is removed from the document's Info dictionary.

    Parameters

    • creator: string

      A new creator

    Returns void

  • Sets the document's keywords. If keywords is null, Keywords entry is removed from the document's Info dictionary.

    Parameters

    • keywords: string

      New keywords

    Returns void

  • Sets the document's modification date. If modification_date is -1, ModDate entry is removed from the document's Info dictionary.

    Parameters

    • modification_date: number

      A new modification date

    Returns void

  • Sets the document's producer. If producer is null, Producer entry is removed from the document's Info dictionary.

    Parameters

    • producer: string

      A new producer

    Returns void

  • Sets the document's subject. If subject is null, Subject entry is removed from the document's Info dictionary.

    Parameters

    • subject: string

      A new subject

    Returns void

  • Sets the document's title. If title is null, Title entry is removed from the document's Info dictionary.

    Parameters

    • title: string

      A new title

    Returns void

Methods - Inherited from GObject

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
      {
        PROP_FOO = 1,
        PROP_LAST
      } MyObjectProperty;

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
        properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                                 0, 100,
                                                 50,
                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
        g_object_class_install_property (gobject_class,
                                         PROP_FOO,
                                         properties[PROP_FOO]);
      }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject     *object,
                             const gchar *new_string)
    {
      // the quark, naming the object data
      GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
      // retrieve the old string list
      GList *list = g_object_steal_qdata (object, quark_string_list);

      // prepend new string
      list = g_list_prepend (list, g_strdup (new_string));
      // this changed 'list', so we need to set it again
      g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
      GList *node, *list = data;

      for (node = list; node; node = node->next)
        g_free (node->data);
      g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Static_classInit

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures