Top | ![]() |
![]() |
![]() |
![]() |
GBoxed ╰── PopplerSignatureInfo GEnum ├── PopplerAdditionalActionType ├── PopplerCertificateStatus ├── PopplerFormButtonType ├── PopplerFormChoiceType ├── PopplerFormFieldType ├── PopplerFormTextType ╰── PopplerSignatureStatus GFlags ╰── PopplerSignatureValidationFlags GObject ╰── PopplerFormField
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] |
user_data |
the data to pass to callback function. |
[closure] |
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()
.
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
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
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
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: 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