Poppler.AnnotFreeText

Subclasses:

None

Methods

Inherited:

Poppler.AnnotMarkup (14), Poppler.Annot (14), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (doc, rect)
	get_callout_line ()
	get_font_color ()
	get_font_desc ()
	get_quadding ()
	set_font_color (color)
	set_font_desc (font_desc)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Poppler.AnnotFreeText(**kwargs)

Bases:

Poppler.AnnotMarkup

Abstract:

No

classmethod new(doc, rect)

Parameters:

• doc (Poppler.Document) – a Poppler.Document

• rect (Poppler.Rectangle) – a Poppler.Rectangle

Returns:

A newly created Poppler.AnnotFreeText annotation

Return type:

Poppler.Annot

Creates a new Free Text annotation that will be located on rect when added to a page. See Poppler.Page.add_annot(). It initially has no content. Font family, size and color are initially undefined and must be set, see Poppler.AnnotFreeText.set_font_desc() and Poppler.AnnotFreeText.set_font_color().

get_callout_line()

Returns:

a new allocated Poppler.AnnotCalloutLine if the annot has a callout line, None in other case. It must be freed with GLib.free() when done.

Return type:

Poppler.AnnotCalloutLine

Retrieves a Poppler.AnnotCalloutLine of four or six numbers specifying a callout line attached to the self.

get_font_color()

Returns:

a copy of the font’s Poppler.Color.

Return type:

Poppler.Color

Gets the font color.

New in version 24.12.0.

get_font_desc()

Returns:

a copy of the annotation font description, or None if there is no font description set.

Return type:

Poppler.FontDescription or None

Gets the font description (i.e. font family name, style, weight, stretch and size).

New in version 24.12.0.

get_quadding()

Returns:

Poppler.AnnotFreeTextQuadding of self.

Return type:

Poppler.AnnotFreeTextQuadding

Retrieves the justification of the text of self.

set_font_color(color)

Parameters:

color (Poppler.Color) – a Poppler.Color

Sets the font color.

New in version 24.12.0.

set_font_desc(font_desc)

Parameters:

font_desc (Poppler.FontDescription) – a Poppler.FontDescription

Sets the font description (i.e. font family name, style, weight, stretch and size).

New in version 24.12.0.