Optionalproperties: Partial<Poppler.Page.ConstructorProps>Internal$signalsCompile-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.
Static$gtypeRead-OnlylabelThe label of the page or null. See also poppler_page_get_label()
SignalconnectSignalconnect_SignalemitFinds text in page with the default options (Poppler.FindFlags.DEFAULT) and
returns a GLib.List of rectangles for each occurrence of the text on the page.
The coordinates are in PDF points.
the text to search for (UTF-8 encoded)
a GLib.List of Poppler.Rectangle,
Finds text in page with the given Poppler.FindFlags options and
returns a GLib.List of rectangles for each occurrence of the text on the page.
The coordinates are in PDF points.
When Poppler.FindFlags.MULTILINE is passed in options, matches may span more than
one line. In this case, the returned list will contain one Poppler.Rectangle
for each part of a match. The function poppler_rectangle_find_get_match_continued()
will return true for all rectangles belonging to the same match, except for
the last one. If a hyphen was ignored at the end of the part of the match,
poppler_rectangle_find_get_ignored_hyphen() will return true for that
rectangle.
Note that currently matches spanning more than two lines are not found. (This limitation may be lifted in a future version.)
Note also that currently finding multi-line matches backwards is not implemented; if you pass Poppler.FindFlags.BACKWARDS and Poppler.FindFlags.MULTILINE together, Poppler.FindFlags.MULTILINE will be ignored.
a newly allocated list of newly allocated Poppler.Rectangle. Free with g_list_free_full() using poppler_rectangle_free().
Returns a list of Poppler.AnnotMapping items that map from a location on
page to a Poppler.Annot. This list must be freed with
poppler_page_free_annot_mapping() when done.
Returns the duration of page
duration in seconds of page or -1.
Returns a list of Poppler.FormFieldMapping items that map from a
location on page to a form field. This list must be freed
with poppler_page_free_form_field_mapping() when done.
Returns a list of Poppler.ImageMapping items that map from a
location on page to an image of the page. This list must be freed
with poppler_page_free_image_mapping() when done.
Returns the index of page
index value of page
Returns the label of page. Note that page labels
and page indices might not coincide.
a new allocated string containing the label of page, or null if page doesn't have a label
Returns a list of Poppler.LinkMapping items that map from a
location on page to a Poppler.Action. This list must be freed
with poppler_page_free_link_mapping() when done.
Returns a region containing the area that would be rendered by
poppler_page_render_selection().
The returned region must be freed with cairo_region_destroy()
scale specified as pixels per point
start and end point of selection as a rectangle
a cairo_region_t
Retrieves the contents of the specified selection as text.
the Poppler.Rectangle including the text
a pointer to the contents of the selection as a string
Returns a region containing the area that would be rendered by
poppler_page_render_selection() as a GLib.List of
Poppler.Rectangle. The returned list must be freed with
poppler_page_selection_region_free().
scale specified as pixels per point
start and end point of selection as a rectangle
Gets the size of page at the current scale and rotation.
Retrieves the text of page.
a pointer to the text of the page as a string
Obtains the attributes of the text as a GLib.List of Poppler.TextAttributes.
This list must be freed with poppler_page_free_text_attributes() when done.
Each list element is a Poppler.TextAttributes struct where start_index and
end_index indicates the range of text (as returned by poppler_page_get_text())
to which text attributes apply.
See also poppler_page_get_text_attributes_for_area()
Obtains the attributes of the text in area as a GLib.List of Poppler.TextAttributes.
This list must be freed with poppler_page_free_text_attributes() when done.
Each list element is a Poppler.TextAttributes struct where start_index and
end_index indicates the range of text (as returned by poppler_page_get_text_for_area())
to which text attributes apply.
Obtains the layout of the text as a list of Poppler.Rectangle
This array must be freed with g_free() when done.
The position in the array represents an offset in the text returned by
poppler_page_get_text()
See also poppler_page_get_text_layout_for_area().
true if the page contains text, false otherwise
Obtains the layout of the text contained in area as a list of Poppler.Rectangle
This array must be freed with g_free() when done.
The position in the array represents an offset in the text returned by
poppler_page_get_text_for_area()
true if the page contains text, false otherwise
Returns true if page has a thumbnail associated with it. It also
fills in width and height with the width and height of the
thumbnail. The values of width and height are not changed if no
appropriate thumbnail exists.
true, if page has a thumbnail associated with it.
Removes annotation annot from page
a Poppler.Annot to remove
Render the page to the given cairo context. This function
is for rendering a page that will be displayed. If you want
to render a page that will be printed use
poppler_page_render_for_printing() instead. Please see the documentation
for that function for the differences between rendering to the screen and
rendering to a printer.
Render the page to the given cairo context for printing with
#POPPLER_PRINT_ALL flags selected. If you want a different set of flags,
use poppler_page_render_full() with printing TRUE and the corresponding
flags.
The difference between poppler_page_render() and this function is that some
things get rendered differently between screens and printers:
Render the page to the given cairo context for printing with the specified options
See the documentation for poppler_page_render_for_printing() for the
differences between rendering to the screen and rendering to a printer.
cairo context to render to
print options
Render the page to the given cairo context, manually selecting which annotations should be displayed.
The printing parameter determines whether a page is rendered for printing
or for displaying it on a screen. See the documentation for
poppler_page_render_for_printing() for the differences between rendering to
the screen and rendering to a printer.
cairo context to render to
cairo context to render to
flags which allow to select which annotations to render
Render the selection specified by selection for page to
the given cairo context. The selection will be rendered, using
glyph_color for the glyphs and background_color for the selection
background.
If non-NULL, old_selection specifies the selection that is already
rendered to cairo, in which case this function will (some day)
only render the changed part of the selection.
cairo context to render to
start and end point of selection as a rectangle
previous selection
color to use for drawing glyphs
color to use for the selection background
Render the selection specified by selection for page to
the given cairo context. The selection will be rendered using
background_color and background_opacity for the selection
background. Glyphs will not be drawn.
If non-NULL, old_selection specifies the selection that is already
rendered to cairo, in which case this function will (some day)
only render the changed part of the selection.
cairo context to render to
start and end point of selection as a rectangle
previous selection
color to use for the selection background
opacity to use for the selection background
Staticfree_Frees a list of Poppler.AnnotMappings allocated by
poppler_page_get_annot_mapping(). It also unreferences the Poppler.Annots
that each mapping contains, so if you want to keep them around, you need to
reference them with g_object_ref().
A list of Poppler.AnnotMappings
Staticfree_Frees a list of Poppler.FormFieldMappings allocated by
poppler_page_get_form_field_mapping().
A list of Poppler.FormFieldMappings
Staticfree_Frees a list of Poppler.ImageMappings allocated by
poppler_page_get_image_mapping().
A list of Poppler.ImageMappings
Staticfree_Frees a list of Poppler.LinkMappings allocated by
poppler_page_get_link_mapping(). It also frees the Poppler.Actions
that each mapping contains, so if you want to keep them around, you need to
copy them with poppler_action_copy().
A list of Poppler.LinkMappings
Staticfree_Frees a list of Poppler.TextAttributess allocated by
poppler_page_get_text_attributes().
A list of Poppler.TextAttributess
Staticselection_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.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to 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.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
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.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
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.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
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.
Handler ID of the handler to be disconnected
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().
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.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
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 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.
The name of the property to get
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
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
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.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
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.:
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]);
the GObject.ParamSpec of a property installed on the class of object.
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.
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().
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.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
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.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
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().
A GLib.Quark, naming the user data pointer
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.
Name of the signal to stop emission of
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.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
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.
Virtualvfunc_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.
Virtualvfunc_Virtualvfunc_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.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_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.
Virtualvfunc_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.
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.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec 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.
Staticinterface_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.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_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
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A Poppler.Document page.
Since 25.06 this type supports g_autoptr