The date the document was created as seconds since the Epoch, or -1
The #GDateTime the document was created.
The creator of the document. See also poppler_document_get_creator()
The PDF version as string. See also poppler_document_get_pdf_version_string()
The PDF major version number. See also poppler_document_get_pdf_version()
The PDF minor version number. See also poppler_document_get_pdf_version()
The keywords associated to the document
Whether document is linearized. See also poppler_document_is_linearized()
Document metadata in XML format, or %NULL
The date the document was most recently modified as seconds since the Epoch, or -1
The #GDateTime the document was most recently modified.
The page layout that should be used when the document is opened
The mode that should be used when the document is opened
Flags specifying which operations are permitted when the document is opened
Suggested number of copies to be printed for this document
The producer of the document. See also poppler_document_get_producer()
The subject of the document
Document PDF subtype type
Document PDF subtype conformance
Document PDF subtype part
Document PDF subtype. See also poppler_document_get_pdf_subtype_string()
The document's title or %NULL
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 instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_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
#GBinding 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 can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
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.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Creates a #PopplerDest 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
#PopplerDest.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().
a named destination
This function is intended for #GObject 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().
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::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 a #GList containing #PopplerAttachments. These attachments are unowned, and must be unreffed, and the list must be freed with g_list_free().
Returns the author of the document
Returns the date the document was created as seconds since the Epoch
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.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
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 the keywords associated to the document
Returns the XML metadata string of the document
Returns the date the document was most recently modified as seconds since the Epoch
Returns the number of attachments in a loaded document. See also poppler_document_get_attachments()
Returns the number of pages in a loaded document.
Returns the #PopplerPage 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.
a page label
Returns the page layout that should be used when the document is opened
Returns a #PopplerPageMode representing how the document should be initially displayed when opened.
Returns the conformance level of the document as #PopplerPDFConformance.
Returns the part of the conforming standard that the document adheres to
as a #PopplerPDFSubtype.
Returns the subtype of document as a #PopplerPDFSubtype.
Returns the PDF subtype version of document as a string.
Returns the PDF version of document as a string (e.g. PDF-1.6)
Returns the flags specifying which operations are permitted when the document is opened.
Returns the duplex mode value suggested for printing by author of the document. Value POPPLER_PRINT_DUPLEX_NONE means that the document does not specify this preference.
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 the print scaling value suggested by author of the document.
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
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns the subject of the document
Returns the document's title
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.
the names of each property to get
the values of each property to get
Returns %TRUE of document has any attachments.
Returns whether document has any javascript in it.
Checks whether object has a [floating][floating-ref] reference.
Returns whether document is linearized or not. Linearization of PDF
enables efficient incremental access of the PDF file in a network environment.
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.
the name of a property installed on the class of object.
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.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
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]);
the #GParamSpec of a property installed on the class of 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().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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.
uri of file to save
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.
uri of file to save
Sets the document's author. If author is %NULL, Author
entry is removed from the document's Info dictionary.
A new author
Sets the document's creation date. If creation_date is -1, CreationDate
entry is removed from the document's Info dictionary.
A new creation date
Sets the document's creator. If creator is %NULL, Creator
entry is removed from the document's Info dictionary.
A new creator
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 #GQuark 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 #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets the document's keywords. If keywords is %NULL,
Keywords entry is removed from the document's Info dictionary.
New keywords
Sets the document's modification date. If modification_date is -1, ModDate
entry is removed from the document's Info dictionary.
A new modification date
Sets the document's producer. If producer is %NULL,
Producer entry is removed from the document's Info dictionary.
A new producer
Sets a property on an object.
the name of the property to set
the value
Sets the document's subject. If subject is %NULL, Subject
entry is removed from the document's Info dictionary.
A new subject
Sets the document's title. If title is %NULL, Title entry
is removed from the document's Info dictionary.
A new title
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
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().
A #GQuark, naming the user data pointer
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::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.
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 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 instance. Use g_clear_object() for this.
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.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
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 #GParamSpec, 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
#GTypeInfo.) 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.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new #PopplerDocument from bytes. The returned document
will hold a reference to bytes.
On error, %NULL is returned, with error set. Possible errors include
those in the #POPPLER_ERROR and #G_FILE_ERROR domains.
a #GBytes
password to unlock the file with, or %NULL
Creates a new #PopplerDocument. If %NULL is returned, then error will be
set. Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
domains.
Note that data must remain valid for as long as the returned document exists.
Prefer using poppler_document_new_from_bytes().
the pdf data
password to unlock the file with, or %NULL
Creates a new #PopplerDocument reading the PDF contents from file.
Possible errors include those in the #POPPLER_ERROR and #G_FILE_ERROR
domains.
a #GFile to load
password to unlock the file with, or %NULL
a #GCancellable, or %NULL
Creates a new #PopplerDocument reading the PDF contents from stream.
Note that the given #GInputStream must be seekable or %G_IO_ERROR_NOT_SUPPORTED
will be returned.
Possible errors include those in the #POPPLER_ERROR, #G_FILE_ERROR
and #G_IO_ERROR domains.
a #GInputStream to read from
the stream length, or -1 if not known
password to unlock the file with, or %NULL
a #GCancellable, or %NULL
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
The author of the document