Poppler.AnnotInk¶

Subclasses:: None

Methods¶

Inherited:: Poppler.AnnotMarkup (14), Poppler.Annot (14), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (doc, rect)
	`get_draw_below` ()
	`get_ink_list` ()
	`set_draw_below` (draw_below)
	`set_ink_list` (ink_list)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Poppler.AnnotInk(**kwargs)¶

Bases:: Poppler.AnnotMarkup
Abstract:: No

New in version 25.06.0.

classmethod new(doc, rect)¶

Parameters:

doc (Poppler.Document) – a Poppler.Document
rect (Poppler.Rectangle) – a Poppler.Rectangle

Returns:

A newly created Poppler.AnnotInk annotation

Return type:

Poppler.Annot

Creates a new ink annotation that will be located on rect when added to a page. See Poppler.Page.add_annot()

New in version 25.06.0.

get_draw_below()¶

Return type:: bool

Returns whether the annotation is drawn below the page content or not.

New in version 25.10.0.

get_ink_list()¶

Returns:: a GLib.SList of Poppler.Path
Return type:: [Poppler.Path]

Each element of the return value is a path.

New in version 25.06.0.

set_draw_below(draw_below)¶

Parameters:: draw_below (bool) – whether the annotation should be drawn below the document content

This is typically used for highlight annotations. Technically, this implies that the annotation is drawn using a multiply blend mode.

New in version 25.10.0.

set_ink_list(ink_list)¶

Parameters:: ink_list ([Poppler.Path]) – a list of Poppler.Path

Each element of ink_list is a path. The annotation must have already been added to a page, otherwise the annotation may be wrongly positioned if the page is rotated or has a cropbox.

This function computes and set the appropriate smallest rectangle area that contains all the points of ink_list. Setting the rectangle afterwards with Poppler.Annot.set_rectangle should not be done to preserve scaling and positioning.

New in version 25.06.0.