Top |
GBoxed ├── PopplerCertificateInfo ╰── PopplerSignatureInfo GEnum ├── PopplerAdditionalActionType ├── PopplerCertificateStatus ├── PopplerFormButtonType ├── PopplerFormChoiceType ├── PopplerFormFieldType ├── PopplerFormTextType ╰── PopplerSignatureStatus GFlags ╰── PopplerSignatureValidationFlags GObject ╰── PopplerFormField
GDateTime *
poppler_certificate_info_get_expiration_time
(const PopplerCertificateInfo *certificate_info
);
Get certificate expiration time
Since: 23.08.0
GDateTime *
poppler_certificate_info_get_issuance_time
(const PopplerCertificateInfo *certificate_info
);
Get certificate issuance time
Since: 23.08.0
const char *
poppler_certificate_info_get_issuer_common_name
(const PopplerCertificateInfo *certificate_info
);
Get certificate issuer common name
Since: 23.08.0
const char *
poppler_certificate_info_get_issuer_email
(const PopplerCertificateInfo *certificate_info
);
Get certificate issuer email
Since: 23.08.0
const char *
poppler_certificate_info_get_issuer_organization
(const PopplerCertificateInfo *certificate_info
);
Get certificate issuer organization
Since: 23.08.0
const char *
poppler_certificate_info_get_subject_common_name
(const PopplerCertificateInfo *certificate_info
);
Get certificate subject common name
Since: 23.07.0
const char *
poppler_certificate_info_get_subject_email
(const PopplerCertificateInfo *certificate_info
);
Get certificate subject email
Since: 23.08.0
const char *
poppler_certificate_info_get_subject_organization
(const PopplerCertificateInfo *certificate_info
);
Get certificate subject organization
Since: 23.08.0
PopplerFormButtonType
poppler_form_field_button_get_button_type
(PopplerFormField *field
);
Gets the button type of field
gboolean
poppler_form_field_button_get_state (PopplerFormField *field
);
Queries a PopplerFormField and returns its current state. Returns TRUE
if
field
is pressed in and FALSE
if it is raised.
void poppler_form_field_button_set_state (PopplerFormField *field
,gboolean state
);
Sets the status of field
. Set to TRUE
if you want the PopplerFormField
to be 'pressed in', and FALSE
to raise it.
gboolean
poppler_form_field_choice_can_select_multiple
(PopplerFormField *field
);
Checks whether field
allows multiple choices to be selected
gboolean
poppler_form_field_choice_commit_on_change
(PopplerFormField *field
);
gboolean
poppler_form_field_choice_do_spell_check
(PopplerFormField *field
);
Checks whether spell checking should be done for the contents of field
PopplerFormChoiceType
poppler_form_field_choice_get_choice_type
(PopplerFormField *field
);
Gets the choice type of field
gchar * poppler_form_field_choice_get_item (PopplerFormField *field
,gint index
);
Returns the contents of the item on field
at the given index
gint
poppler_form_field_choice_get_n_items (PopplerFormField *field
);
Returns the number of items on field
gchar *
poppler_form_field_choice_get_text (PopplerFormField *field
);
Retrieves the contents of field
.
gboolean
poppler_form_field_choice_is_editable (PopplerFormField *field
);
Checks whether field
is editable
gboolean poppler_form_field_choice_is_item_selected (PopplerFormField *field
,gint index
);
Checks whether the item at the given index on field
is currently selected
void poppler_form_field_choice_select_item (PopplerFormField *field
,gint index
);
Selects the item at the given index on field
void poppler_form_field_choice_set_text (PopplerFormField *field
,const gchar *text
);
Sets the text in field
to the given value, replacing the current contents
void poppler_form_field_choice_toggle_item (PopplerFormField *field
,gint index
);
Changes the state of the item at the given index
void
poppler_form_field_choice_unselect_all
(PopplerFormField *field
);
Unselects all the items on field
PopplerAction *
poppler_form_field_get_action (PopplerFormField *field
);
Retrieves the action (PopplerAction) that shall be
performed when field
is activated, or NULL
the action to perform. The returned
object is owned by field
and should not be freed.
[transfer none]
Since: 0.18
PopplerAction * poppler_form_field_get_additional_action (PopplerFormField *field
,PopplerAdditionalActionType type
);
Retrieves the action (PopplerAction) that shall be performed when
an additional action is triggered on field
, or NULL
.
the action to perform. The returned
object is owned by field
and should not be freed.
[transfer none]
Since: 0.72
gchar *
poppler_form_field_get_alternate_ui_name
(PopplerFormField *field
);
Gets the alternate ui name of field
. This name is also commonly
used by pdf producers/readers to show it as a tooltip when field
area
is hovered by a pointing device (eg. mouse).
Since: 0.88
PopplerFormFieldType
poppler_form_field_get_field_type (PopplerFormField *field
);
Gets the type of field
gdouble
poppler_form_field_get_font_size (PopplerFormField *field
);
Gets the font size of field
WARNING: This function always returns 0. Contact the poppler mailing list if you're interested in implementing it properly
gint
poppler_form_field_get_id (PopplerFormField *field
);
Gets the id of field
gchar *
poppler_form_field_get_mapping_name (PopplerFormField *field
);
Gets the mapping name of field
that is used when
exporting interactive form field data from the document
Since: 0.16
gchar *
poppler_form_field_get_name (PopplerFormField *field
);
Gets the fully qualified name of field
. It's constructed by concatenating
the partial field names of the field and all of its ancestors.
Since: 0.16
gchar *
poppler_form_field_get_partial_name (PopplerFormField *field
);
Gets the partial name of field
.
Since: 0.16
gboolean
poppler_form_field_is_read_only (PopplerFormField *field
);
Checks whether field
is read only
void poppler_form_field_signature_validate_async (PopplerFormField *field
,PopplerSignatureValidationFlags flags
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously validates the cryptographic signature contained in signature_field
.
field |
a PopplerFormField that represents a signature annotation |
|
flags |
PopplerSignatureValidationFlags flags influencing process of validation of the field signature |
|
cancellable |
optional GCancellable object. |
[nullable] |
callback |
a GAsyncReadyCallback to call when the signature is validated. |
[scope async][closure user_data] |
user_data |
the data to pass to callback function |
Since: 21.12.0
PopplerSignatureInfo * poppler_form_field_signature_validate_finish (PopplerFormField *field
,GAsyncResult *result
,GError **error
);
Finishes validation of the cryptographic signature contained in signature_field
.
See poppler_form_field_signature_validate_async()
.
field |
a PopplerFormField that represents a signature annotation |
|
result |
a GAsyncResult |
|
error |
a GError |
a PopplerSignatureInfo structure containing signature metadata and validation status
Free the returned structure with poppler_signature_info_free()
.
[transfer full]
Since: 21.12.0
PopplerSignatureInfo * poppler_form_field_signature_validate_sync (PopplerFormField *field
,PopplerSignatureValidationFlags flags
,GCancellable *cancellable
,GError **error
);
Synchronously validates the cryptographic signature contained in signature_field
.
field |
a PopplerFormField that represents a signature annotation |
|
flags |
PopplerSignatureValidationFlags flags influencing process of validation of the field signature |
|
cancellable |
optional GCancellable object. |
[nullable] |
error |
a GError |
a PopplerSignatureInfo structure containing signature metadata and validation status
Free the returned structure with poppler_signature_info_free()
.
[transfer full]
Since: 21.12.0
gboolean
poppler_form_field_text_do_scroll (PopplerFormField *field
);
gboolean
poppler_form_field_text_do_spell_check
(PopplerFormField *field
);
Checks whether spell checking should be done for the contents of field
gint
poppler_form_field_text_get_max_len (PopplerFormField *field
);
Retrieves the maximum allowed length of the text in field
gchar *
poppler_form_field_text_get_text (PopplerFormField *field
);
Retrieves the contents of field
.
PopplerFormTextType
poppler_form_field_text_get_text_type (PopplerFormField *field
);
Gets the text type of field
.
gboolean
poppler_form_field_text_is_password (PopplerFormField *field
);
Checks whether content of field
is a password and it must be hidden
gboolean
poppler_form_field_text_is_rich_text (PopplerFormField *field
);
Checks whether the contents of field
are rich text
void poppler_form_field_text_set_text (PopplerFormField *field
,const gchar *text
);
Sets the text in field
to the given value, replacing the current contents.
PopplerSignatureInfo *
poppler_signature_info_copy (const PopplerSignatureInfo *siginfo
);
Copies siginfo
, creating an identical PopplerSignatureInfo.
siginfo |
a PopplerSignatureInfo structure containing signature metadata and validation status |
Since: 21.12.0
void
poppler_signature_info_free (PopplerSignatureInfo *siginfo
);
Frees siginfo
siginfo |
a PopplerSignatureInfo structure containing signature metadata and validation status |
Since: 21.12.0
PopplerCertificateInfo *
poppler_signature_info_get_certificate_info
(const PopplerSignatureInfo *siginfo
);
Returns PopplerCertificateInfo for given PopplerSignatureInfo.
Since: 23.08.0
PopplerCertificateStatus
poppler_signature_info_get_certificate_status
(const PopplerSignatureInfo *siginfo
);
Returns status of the certificate for given PopplerSignatureInfo.
Since: 21.12.0
PopplerSignatureStatus
poppler_signature_info_get_signature_status
(const PopplerSignatureInfo *siginfo
);
Returns status of the signature for given PopplerSignatureInfo.
Since: 21.12.0
const gchar *
poppler_signature_info_get_signer_name
(const PopplerSignatureInfo *siginfo
);
Returns name of signer for given PopplerSignatureInfo.
Since: 21.12.0
GDateTime *
poppler_signature_info_get_local_signing_time
(const PopplerSignatureInfo *siginfo
);
Returns local time of signing as GDateTime. This does not contain information about time zone since it has not been preserved during conversion. Do not modify returned value since it is internal to PopplerSignatureInfo.
Since: 21.12.0
PopplerSigningData *
poppler_signing_data_new (void
);
Creates a new PopplerSigningData with default content.
Since: 23.07.0
PopplerSigningData *
poppler_signing_data_copy (const PopplerSigningData *signing_data
);
Copies signing_data
, creating an identical PopplerSigningData.
Since: 23.07.0
void
poppler_signing_data_free (PopplerSigningData *signing_data
);
Frees signing_data
Since: 23.07.0
void poppler_signing_data_set_destination_filename (PopplerSigningData *signing_data
,const gchar *filename
);
Set destination file name.
signing_data |
a PopplerSigningData structure containing signing data |
|
filename |
destination filename |
Since: 23.07.0
void poppler_signing_data_set_certificate_info (PopplerSigningData *signing_data
,const PopplerCertificateInfo *certificate_info
);
Set certification information.
Since: 23.07.0
void poppler_signing_data_set_page (PopplerSigningData *signing_data
,int page
);
Set page (>=0).
Since: 23.07.0
void poppler_signing_data_set_signature_text (PopplerSigningData *signing_data
,const gchar *signature_text
);
Set signature text.
signing_data |
a PopplerSigningData structure containing signing data |
|
signature_text |
text to show as main signature |
Since: 23.07.0
void poppler_signing_data_set_signature_text_left (PopplerSigningData *signing_data
,const gchar *signature_text_left
);
Set small signature text on the left hand.
signing_data |
a PopplerSigningData structure containing signing data |
|
signature_text_left |
text to show as small left signature |
Since: 23.07.0
void poppler_signing_data_set_signature_rectangle (PopplerSigningData *signing_data
,const PopplerRectangle *signature_rect
);
Set signature rectangle.
signing_data |
a PopplerSigningData structure containing signing data |
|
signature_rect |
a PopplerRectangle where signature should be shown |
Since: 23.07.0
void poppler_signing_data_set_font_color (PopplerSigningData *signing_data
,const PopplerColor *font_color
);
Set signature font color.
signing_data |
a PopplerSigningData structure containing signing data |
|
font_color |
a PopplerColor to be used as signature font color |
Since: 23.07.0
void poppler_signing_data_set_font_size (PopplerSigningData *signing_data
,gdouble font_size
);
Set signature font size (>0).
signing_data |
a PopplerSigningData structure containing signing data |
|
font_size |
signature font size |
Since: 23.07.0
void poppler_signing_data_set_left_font_size (PopplerSigningData *signing_data
,gdouble font_size
);
Set signature left font size (> 0).
signing_data |
a PopplerSigningData structure containing signing data |
|
font_size |
signature font size |
Since: 23.07.0
void poppler_signing_data_set_border_color (PopplerSigningData *signing_data
,const PopplerColor *border_color
);
Set signature border color.
signing_data |
a PopplerSigningData structure containing signing data |
|
border_color |
a PopplerColor to be used for signature border |
Since: 23.07.0
void poppler_signing_data_set_border_width (PopplerSigningData *signing_data
,gdouble border_width
);
Set signature border width.
signing_data |
a PopplerSigningData structure containing signing data |
|
border_width |
border width |
Since: 23.07.0
void poppler_signing_data_set_background_color (PopplerSigningData *signing_data
,const PopplerColor *background_color
);
Set signature background color.
signing_data |
a PopplerSigningData structure containing signing data |
|
background_color |
a PopplerColor to be used for signature background |
Since: 23.07.0
void poppler_signing_data_set_field_partial_name (PopplerSigningData *signing_data
,const gchar *field_partial_name
);
Set field partial name (existing field id or a new one) where signature is placed.
signing_data |
a PopplerSigningData structure containing signing data |
|
field_partial_name |
a field partial name |
Since: 23.07.0
void poppler_signing_data_set_reason (PopplerSigningData *signing_data
,const gchar *reason
);
Set reason for signature (e.g. I'm approver).
Since: 23.07.0
void poppler_signing_data_set_location (PopplerSigningData *signing_data
,const gchar *location
);
Set signature location (e.g. "At my desk").
Since: 23.07.0
void poppler_signing_data_set_image_path (PopplerSigningData *signing_data
,const gchar *image_path
);
Set signature background (watermark) image path.
signing_data |
a PopplerSigningData structure containing signing data |
|
image_path |
signature image path |
Since: 23.07.0
void poppler_signing_data_set_password (PopplerSigningData *signing_data
,const gchar *password
);
Set password for the signing key.
Since: 23.07.0
void poppler_signing_data_set_document_owner_password (PopplerSigningData *signing_data
,const gchar *document_owner_password
);
Set document owner password (for encrypted files).
signing_data |
a PopplerSigningData structure containing signing data |
|
document_owner_password |
document owner password |
Since: 23.07.0
void poppler_signing_data_set_document_user_password (PopplerSigningData *signing_data
,const gchar *document_user_password
);
Set document user password (for encrypted files).
signing_data |
a PopplerSigningData structure containing signing data |
|
document_user_password |
document user password |
Since: 23.07.0
const gchar *
poppler_signing_data_get_destination_filename
(const PopplerSigningData *signing_data
);
Get destination file name.
Since: 23.07.0
const PopplerCertificateInfo *
poppler_signing_data_get_certificate_info
(const PopplerSigningData *signing_data
);
Get certification information.
Since: 23.07.0
int
poppler_signing_data_get_page (const PopplerSigningData *signing_data
);
Get page.
Since: 23.07.0
const gchar *
poppler_signing_data_get_signature_text
(const PopplerSigningData *signing_data
);
Get signature text.
Since: 23.07.0
const gchar *
poppler_signing_data_get_signature_text_left
(const PopplerSigningData *signing_data
);
Get signature text left.
Since: 23.07.0
const PopplerRectangle *
poppler_signing_data_get_signature_rectangle
(const PopplerSigningData *signing_data
);
Get signature rectangle.
Since: 23.07.0
const PopplerColor *
poppler_signing_data_get_font_color (const PopplerSigningData *signing_data
);
Get signature font color.
Since: 23.07.0
gdouble
poppler_signing_data_get_font_size (const PopplerSigningData *signing_data
);
Get signature font size.
Since: 23.07.0
gdouble
poppler_signing_data_get_left_font_size
(const PopplerSigningData *signing_data
);
Get signature left font size.
Since: 23.07.0
const PopplerColor *
poppler_signing_data_get_border_color (const PopplerSigningData *signing_data
);
Get signature border color.
Since: 23.07.0
gdouble
poppler_signing_data_get_border_width (const PopplerSigningData *signing_data
);
Get signature border width.
Since: 23.07.0
const PopplerColor *
poppler_signing_data_get_background_color
(const PopplerSigningData *signing_data
);
Get signature background color.
Since: 23.07.0
const gchar *
poppler_signing_data_get_field_partial_name
(const PopplerSigningData *signing_data
);
Get field partial name.
Since: 23.07.0
const gchar *
poppler_signing_data_get_reason (const PopplerSigningData *signing_data
);
Get reason.
Since: 23.07.0
const gchar *
poppler_signing_data_get_location (const PopplerSigningData *signing_data
);
Get location.
Since: 23.07.0
const gchar *
poppler_signing_data_get_image_path (const PopplerSigningData *signing_data
);
Get image path.
Since: 23.07.0
const gchar *
poppler_signing_data_get_password (const PopplerSigningData *signing_data
);
Get signing key password.
Since: 23.07.0
const gchar *
poppler_signing_data_get_document_owner_password
(const PopplerSigningData *signing_data
);
Get document owner password.
Since: 23.07.0
const gchar *
poppler_signing_data_get_document_user_password
(const PopplerSigningData *signing_data
);
Get document user password.
Since: 23.07.0
PopplerCertificateInfo *
poppler_certificate_info_new (void
);
Creates a new PopplerCertificateInfo
a new PopplerCertificateInfo. It must be freed with poppler_certificate_info_free()
when done.
Since: 23.07.0
PopplerCertificateInfo *
poppler_certificate_info_copy (const PopplerCertificateInfo *certificate_info
);
Copies certificate_info
, creating an identical PopplerCertificateInfo.
Since: 23.07.0
void
poppler_set_nss_dir (const char *path
);
Set NSS directory
Since: 23.07.0
void
poppler_set_nss_password_callback (PopplerNssPasswordFunc func
);
A callback which asks for certificate password
Since: 23.07.0
GList *
poppler_get_available_signing_certificates
(void
);
Get all available signing certificate information
void
poppler_certificate_info_free (PopplerCertificateInfo *certificate_info
);
Frees certificate_info
Since: 23.07.0
Form field additional action types to be passed to poppler_form_field_get_additional_action
The action to be performed when the user modifies the field. |
||
The action to be performed before the field is formatted to display its value. |
||
The action to be performed when the field value changes. |
||
The action to be performed when the field needs to be recalculated. |
Since: 0.72
typedef struct _PopplerCertificateInfo PopplerCertificateInfo;
PopplerCertificateInfo contains detailed info about a signing certificate.
Since 24.10 this type supports g_autoptr
Since: 23.07.0
Signature certificate verification results
certificate is considered trusted |
||
the issuer of this certificate has been marked as untrusted by the user |
||
this certificate trust chain has not finished in a trusted root certificate |
||
certificate was revoked by the issuing certificate authority |
||
signing time is outside the validity bounds of this certificate |
||
failed to verify certificate |
||
certificate not yet verified |
Since: 21.12.0
typedef struct _PopplerSignatureInfo PopplerSignatureInfo;
PopplerSignatureInfo contains detailed info about a signature contained in a form field.
Since 24.10 this type supports g_autoptr
Since: 21.12.0
Signature verification results
signature is cryptographically valid |
||
signature is cryptographically invalid |
||
document content was changed after the signature was applied |
||
signature CMS/PKCS7 structure is malformed |
||
failed to verify signature |
||
requested signature is not present in the document |
||
signature not yet verified |
Since: 21.12.0
Signature validation flags
Since: 21.12.0