Poppler.SigningData¶

Fields¶

None

Methods¶

class	`new` ()
	`copy` ()
	`free` ()
	`get_background_color` ()
	`get_border_color` ()
	`get_border_width` ()
	`get_certificate_info` ()
	`get_destination_filename` ()
	`get_document_owner_password` ()
	`get_document_user_password` ()
	`get_field_partial_name` ()
	`get_font_color` ()
	`get_font_size` ()
	`get_image_path` ()
	`get_left_font_size` ()
	`get_location` ()
	`get_page` ()
	`get_password` ()
	`get_reason` ()
	`get_signature_rectangle` ()
	`get_signature_text` ()
	`get_signature_text_left` ()
	`set_background_color` (background_color)
	`set_border_color` (border_color)
	`set_border_width` (border_width)
	`set_certificate_info` (certificate_info)
	`set_destination_filename` (filename)
	`set_document_owner_password` (document_owner_password)
	`set_document_user_password` (document_user_password)
	`set_field_partial_name` (field_partial_name)
	`set_font_color` (font_color)
	`set_font_size` (font_size)
	`set_image_path` (image_path)
	`set_left_font_size` (font_size)
	`set_location` (location)
	`set_page` (page)
	`set_password` (password)
	`set_reason` (reason)
	`set_signature_rectangle` (signature_rect)
	`set_signature_text` (signature_text)
	`set_signature_text_left` (signature_text_left)

Details¶

class Poppler.SigningData¶

classmethod new()¶

Returns:: a new Poppler.SigningData. It must be freed with Poppler.SigningData.free() when done.
Return type:: Poppler.SigningData

Creates a new Poppler.SigningData with default content.

New in version 23.07.0.

copy()¶

Returns:: a new Poppler.SigningData structure identical to self
Return type:: Poppler.SigningData

Copies self, creating an identical Poppler.SigningData.

New in version 23.07.0.

free()¶: Frees self

New in version 23.07.0.

get_background_color()¶

Returns:: a Poppler.Color
Return type:: Poppler.Color

Get signature background color.

New in version 23.07.0.

get_border_color()¶

Returns:: a Poppler.Color
Return type:: Poppler.Color

Get signature border color.

New in version 23.07.0.

get_border_width()¶

Returns:: border width
Return type:: float

Get signature border width.

New in version 23.07.0.

get_certificate_info()¶

Returns:: a Poppler.CertificateInfo
Return type:: Poppler.CertificateInfo

Get certification information.

New in version 23.07.0.

get_destination_filename()¶

Returns:: destination filename
Return type:: str

Get destination file name.

New in version 23.07.0.

get_document_owner_password()¶

Returns:: document owner password (for encrypted files)
Return type:: str

Get document owner password.

New in version 23.07.0.

get_document_user_password()¶

Returns:: document user password (for encrypted files)
Return type:: str

Get document user password.

New in version 23.07.0.

get_field_partial_name()¶

Returns:: field partial name
Return type:: str

Get field partial name.

New in version 23.07.0.

get_font_color()¶

Returns:: a Poppler.Color
Return type:: Poppler.Color

Get signature font color.

New in version 23.07.0.

get_font_size()¶

Returns:: font size
Return type:: float

Get signature font size.

New in version 23.07.0.

get_image_path()¶

Returns:: image path
Return type:: str

Get image path.

New in version 23.07.0.

get_left_font_size()¶

Returns:: left font size
Return type:: float

Get signature left font size.

New in version 23.07.0.

get_location()¶

Returns:: location
Return type:: str

Get location.

New in version 23.07.0.

get_page()¶

Returns:: page number
Return type:: int

Get page.

New in version 23.07.0.

get_password()¶

Returns:: password
Return type:: str

Get signing key password.

New in version 23.07.0.

get_reason()¶

Returns:: reason
Return type:: str

Get reason.

New in version 23.07.0.

get_signature_rectangle()¶

Returns:: a Poppler.Rectangle
Return type:: Poppler.Rectangle

Get signature rectangle.

New in version 23.07.0.

get_signature_text()¶

Returns:: signature text
Return type:: str

Get signature text.

New in version 23.07.0.

get_signature_text_left()¶

Returns:: signature text left
Return type:: str

Get signature text left.

New in version 23.07.0.

set_background_color(background_color)¶

Parameters:: background_color (Poppler.Color) – a Poppler.Color to be used for signature background

Set signature background color.

New in version 23.07.0.

set_border_color(border_color)¶

Parameters:: border_color (Poppler.Color) – a Poppler.Color to be used for signature border

Set signature border color.

New in version 23.07.0.

set_border_width(border_width)¶

Parameters:: border_width (float) – border width

Set signature border width.

New in version 23.07.0.

set_certificate_info(certificate_info)¶

Parameters:: certificate_info (Poppler.CertificateInfo) – a Poppler.CertificateInfo

Set certification information.

New in version 23.07.0.

set_destination_filename(filename)¶

Parameters:: filename (str) – destination filename

Set destination file name.

New in version 23.07.0.

set_document_owner_password(document_owner_password)¶

Parameters:: document_owner_password (str) – document owner password

Set document owner password (for encrypted files).

New in version 23.07.0.

set_document_user_password(document_user_password)¶

Parameters:: document_user_password (str) – document user password

Set document user password (for encrypted files).

New in version 23.07.0.

set_field_partial_name(field_partial_name)¶

Parameters:: field_partial_name (str) – a field partial name

Set field partial name (existing field id or a new one) where signature is placed.

New in version 23.07.0.

set_font_color(font_color)¶

Parameters:: font_color (Poppler.Color) – a Poppler.Color to be used as signature font color

Set signature font color.

New in version 23.07.0.

set_font_size(font_size)¶

Parameters:: font_size (float) – signature font size

Set signature font size (>0).

New in version 23.07.0.

set_image_path(image_path)¶

Parameters:: image_path (str) – signature image path

Set signature background (watermark) image path.

New in version 23.07.0.

set_left_font_size(font_size)¶

Parameters:: font_size (float) – signature font size

Set signature left font size (> 0).

New in version 23.07.0.

set_location(location)¶

Parameters:: location (str) – a location

Set signature location (e.g. “At my desk”).

New in version 23.07.0.

set_page(page)¶

Parameters:: page (int) – a page number

Set page (>=0).

New in version 23.07.0.

set_password(password)¶

Parameters:: password (str) – a password

Set password for the signing key.

New in version 23.07.0.

set_reason(reason)¶

Parameters:: reason (str) – a reason

Set reason for signature (e.g. I’m approver).

New in version 23.07.0.

set_signature_rectangle(signature_rect)¶

Parameters:: signature_rect (Poppler.Rectangle) – a Poppler.Rectangle where signature should be shown

Set signature rectangle.

New in version 23.07.0.

set_signature_text(signature_text)¶

Parameters:: signature_text (str) – text to show as main signature

Set signature text.

New in version 23.07.0.

set_signature_text_left(signature_text_left)¶

Parameters:: signature_text_left (str) – text to show as small left signature

Set small signature text on the left hand.

New in version 23.07.0.