pdf/form.h

Index

Form

function pdf_keep_widget

pdf_annot *
pdf_keep_widget (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_drop_widget

void
pdf_drop_widget (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_first_widget

pdf_annot *
pdf_first_widget (
        fz_context *ctx,
        pdf_page *page
)

function pdf_next_widget

pdf_annot *
pdf_next_widget (
        fz_context *ctx,
        pdf_annot *previous
)

function pdf_update_widget

int
pdf_update_widget (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_create_signature_widget

pdf_annot *
pdf_create_signature_widget (
        fz_context *ctx,
        pdf_page *page,
        char *name
)

create a new signature widget on the specified page, with the specified name.

The returns pdf_annot reference must be dropped by the caller. This is a change from releases up to an including 1.18, where the returned reference was owned by the page and did not need to be freed by the caller.

function pdf_widget_type

enum pdf_widget_type
pdf_widget_type (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_bound_widget

fz_rect
pdf_bound_widget (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_text_widget_max_len

int
pdf_text_widget_max_len (
        fz_context *ctx,
        pdf_annot *tw
)

get the maximum number of characters permitted in a text widget

function pdf_text_widget_format

int
pdf_text_widget_format (
        fz_context *ctx,
        pdf_annot *tw
)

get the type of content required by a text widget

function pdf_choice_widget_options

int
pdf_choice_widget_options (
        fz_context *ctx,
        pdf_annot *tw,
        int exportval,
        const char *opts[]
)

get the list of options for a list box or combo box.

Returns the number of options and fills in their names within the supplied array. Should first be called with a NULL array to find out how big the array should be. If exportval is true, then the export values will be returned and not the list values if there are export values present.

function pdf_choice_widget_is_multiselect

int
pdf_choice_widget_is_multiselect (
        fz_context *ctx,
        pdf_annot *tw
)

function pdf_choice_widget_value

int
pdf_choice_widget_value (
        fz_context *ctx,
        pdf_annot *tw,
        const char *opts[]
)

get the value of a choice widget.

Returns the number of options currently selected and fills in the supplied array with their strings. Should first be called with NULL as the array to find out how big the array need to be. The filled in elements should not be freed by the caller.

function pdf_choice_widget_set_value

void
pdf_choice_widget_set_value (
        fz_context *ctx,
        pdf_annot *tw,
        int n,
        const char *opts[]
)

set the value of a choice widget.

The caller should pass the number of options selected and an array of their names

function pdf_choice_field_option_count

int
pdf_choice_field_option_count (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_choice_field_option

const char *
pdf_choice_field_option (
        fz_context *ctx,
        pdf_obj *field,
        int exportval,
        int i
)

function pdf_widget_is_signed

int
pdf_widget_is_signed (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_widget_is_readonly

int
pdf_widget_is_readonly (
        fz_context *ctx,
        pdf_annot *widget
)

enum pdf_field_flags

enum pdf_field_flags
{
        /* All fields */
        PDF_FIELD_IS_READ_ONLY = 1,
        PDF_FIELD_IS_REQUIRED = 1 << 1,
        PDF_FIELD_IS_NO_EXPORT = 1 << 2,

        /* Text fields */
        PDF_TX_FIELD_IS_MULTILINE = 1 << 12,
        PDF_TX_FIELD_IS_PASSWORD = 1 << 13,
        PDF_TX_FIELD_IS_FILE_SELECT = 1 << 20,
        PDF_TX_FIELD_IS_DO_NOT_SPELL_CHECK = 1 << 22,
        PDF_TX_FIELD_IS_DO_NOT_SCROLL = 1 << 23,
        PDF_TX_FIELD_IS_COMB = 1 << 24,
        PDF_TX_FIELD_IS_RICH_TEXT = 1 << 25,

        /* Button fields */
        PDF_BTN_FIELD_IS_NO_TOGGLE_TO_OFF = 1 << 14,
        PDF_BTN_FIELD_IS_RADIO = 1 << 15,
        PDF_BTN_FIELD_IS_PUSHBUTTON = 1 << 16,
        PDF_BTN_FIELD_IS_RADIOS_IN_UNISON = 1 << 25,

        /* Choice fields */
        PDF_CH_FIELD_IS_COMBO = 1 << 17,
        PDF_CH_FIELD_IS_EDIT = 1 << 18,
        PDF_CH_FIELD_IS_SORT = 1 << 19,
        PDF_CH_FIELD_IS_MULTI_SELECT = 1 << 21,
        PDF_CH_FIELD_IS_DO_NOT_SPELL_CHECK = 1 << 22,
        PDF_CH_FIELD_IS_COMMIT_ON_SEL_CHANGE = 1 << 25,
}

Field flags

function pdf_calculate_form

void
pdf_calculate_form (
        fz_context *ctx,
        pdf_document *doc
)

function pdf_reset_form

void
pdf_reset_form (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *fields,
        int exclude
)

function pdf_field_type

int
pdf_field_type (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_field_type_string

const char *
pdf_field_type_string (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_field_flags

int
pdf_field_flags (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_load_field_name

char *
pdf_load_field_name (
        fz_context *ctx,
        pdf_obj *field
)

Retrieve the name for a field as a C string that must be freed by the caller.

function pdf_field_value

const char *
pdf_field_value (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_create_field_name

void
pdf_create_field_name (
        fz_context *ctx,
        pdf_document *doc,
        const char *prefix,
        char *buf,
        size_t len
)

function pdf_field_border_style

char *
pdf_field_border_style (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_field_set_border_style

void
pdf_field_set_border_style (
        fz_context *ctx,
        pdf_obj *field,
        const char *text
)

function pdf_field_set_button_caption

void
pdf_field_set_button_caption (
        fz_context *ctx,
        pdf_obj *field,
        const char *text
)

function pdf_field_set_fill_color

void
pdf_field_set_fill_color (
        fz_context *ctx,
        pdf_obj *field,
        pdf_obj *col
)

function pdf_field_set_text_color

void
pdf_field_set_text_color (
        fz_context *ctx,
        pdf_obj *field,
        pdf_obj *col
)

function pdf_field_display

int
pdf_field_display (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_field_set_display

void
pdf_field_set_display (
        fz_context *ctx,
        pdf_obj *field,
        int d
)

function pdf_field_label

const char *
pdf_field_label (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_button_field_on_state

pdf_obj *
pdf_button_field_on_state (
        fz_context *ctx,
        pdf_obj *field
)

function pdf_set_field_value

int
pdf_set_field_value (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field,
        const char *text,
        int ignore_trigger_events
)

function pdf_set_text_field_value

int
pdf_set_text_field_value (
        fz_context *ctx,
        pdf_annot *widget,
        const char *value
)

Update the text of a text widget.

The text is first validated by the Field/Keystroke event processing and accepted only if it passes.

The function returns whether validation passed.

function pdf_set_choice_field_value

int
pdf_set_choice_field_value (
        fz_context *ctx,
        pdf_annot *widget,
        const char *value
)

function pdf_edit_text_field_value

int
pdf_edit_text_field_value (
        fz_context *ctx,
        pdf_annot *widget,
        const char *value,
        const char *change,
        int *selStart,
        int *selEnd,
        char **newvalue
)

struct pdf_pkcs7_distinguished_name

struct pdf_pkcs7_distinguished_name
{
        char *cn;
        char *o;
        char *ou;
        char *email;
        char *c;
}
pdf_pkcs7_distinguished_name

enum pdf_signature_error

enum pdf_signature_error
{
        PDF_SIGNATURE_ERROR_OKAY,
        PDF_SIGNATURE_ERROR_NO_SIGNATURES,
        PDF_SIGNATURE_ERROR_NO_CERTIFICATE,
        PDF_SIGNATURE_ERROR_DIGEST_FAILURE,
        PDF_SIGNATURE_ERROR_SELF_SIGNED,
        PDF_SIGNATURE_ERROR_SELF_SIGNED_IN_CHAIN,
        PDF_SIGNATURE_ERROR_NOT_TRUSTED,
        PDF_SIGNATURE_ERROR_NOT_SIGNED,
        PDF_SIGNATURE_ERROR_UNKNOWN,
}

typedef pdf_pkcs7_keep_signer_fn

typedef pdf_pkcs7_signer *(pdf_pkcs7_keep_signer_fn)(fz_context *ctx, pdf_pkcs7_signer *signer)

Increment the reference count for a signer object

typedef pdf_pkcs7_drop_signer_fn

typedef void (pdf_pkcs7_drop_signer_fn)(fz_context *ctx, pdf_pkcs7_signer *signer)

Drop a reference for a signer object

typedef pdf_pkcs7_get_signing_name_fn

typedef pdf_pkcs7_distinguished_name *(pdf_pkcs7_get_signing_name_fn)(fz_context *ctx, pdf_pkcs7_signer *signer)

Obtain the distinguished name information from a signer object

typedef pdf_pkcs7_max_digest_size_fn

typedef size_t (pdf_pkcs7_max_digest_size_fn)(fz_context *ctx, pdf_pkcs7_signer *signer)

Predict the size of the digest. The actual digest returned by create_digest will be no greater in size

typedef pdf_pkcs7_create_digest_fn

typedef int (pdf_pkcs7_create_digest_fn)(fz_context *ctx, pdf_pkcs7_signer *signer, fz_stream *in, unsigned char *digest, size_t digest_len)

Create a signature based on ranges of bytes drawn from a stream

struct pdf_pkcs7_signer

struct pdf_pkcs7_signer
{
        pdf_pkcs7_keep_signer_fn *keep;
        pdf_pkcs7_drop_signer_fn *drop;
        pdf_pkcs7_get_signing_name_fn *get_signing_name;
        pdf_pkcs7_max_digest_size_fn *max_digest_size;
        pdf_pkcs7_create_digest_fn *create_digest;
}

typedef pdf_pkcs7_drop_verifier_fn

typedef void (pdf_pkcs7_drop_verifier_fn)(fz_context *ctx, pdf_pkcs7_verifier *verifier)

typedef pdf_pkcs7_check_certificate_fn

typedef pdf_signature_error (pdf_pkcs7_check_certificate_fn)(fz_context *ctx, pdf_pkcs7_verifier *verifier, unsigned char *signature, size_t len)

typedef pdf_pkcs7_check_digest_fn

typedef pdf_signature_error (pdf_pkcs7_check_digest_fn)(fz_context *ctx, pdf_pkcs7_verifier *verifier, fz_stream *in, unsigned char *signature, size_t len)

typedef pdf_pkcs7_get_signatory_fn

typedef pdf_pkcs7_distinguished_name *(pdf_pkcs7_get_signatory_fn)(fz_context *ctx, pdf_pkcs7_verifier *verifier, unsigned char *signature, size_t len)

struct pdf_pkcs7_verifier

struct pdf_pkcs7_verifier
{
        pdf_pkcs7_drop_verifier_fn *drop;
        pdf_pkcs7_check_certificate_fn *check_certificate;
        pdf_pkcs7_check_digest_fn *check_digest;
        pdf_pkcs7_get_signatory_fn *get_signatory;
}

function pdf_signature_is_signed

int
pdf_signature_is_signed (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field
)

function pdf_signature_set_value

void
pdf_signature_set_value (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field,
        pdf_pkcs7_signer *signer,
        int64_t stime
)

function pdf_count_signatures

int
pdf_count_signatures (
        fz_context *ctx,
        pdf_document *doc
)

function pdf_signature_error_description

char *
pdf_signature_error_description (
        pdf_signature_error err
)

function pdf_signature_get_signatory

pdf_pkcs7_distinguished_name *
pdf_signature_get_signatory (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier,
        pdf_document *doc,
        pdf_obj *signature
)

function pdf_signature_get_widget_signatory

pdf_pkcs7_distinguished_name *
pdf_signature_get_widget_signatory (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier,
        pdf_annot *widget
)

function pdf_signature_drop_distinguished_name

void
pdf_signature_drop_distinguished_name (
        fz_context *ctx,
        pdf_pkcs7_distinguished_name *name
)

function pdf_signature_format_distinguished_name

char *
pdf_signature_format_distinguished_name (
        fz_context *ctx,
        pdf_pkcs7_distinguished_name *name
)

function pdf_signature_info

char *
pdf_signature_info (
        fz_context *ctx,
        const char *name,
        pdf_pkcs7_distinguished_name *dn,
        const char *reason,
        const char *location,
        int64_t date,
        int include_labels
)

function pdf_signature_appearance_signed

fz_display_list *
pdf_signature_appearance_signed (
        fz_context *ctx,
        fz_rect rect,
        fz_text_language lang,
        fz_image *img,
        const char *left_text,
        const char *right_text,
        int include_logo
)

function pdf_signature_appearance_unsigned

fz_display_list *
pdf_signature_appearance_unsigned (
        fz_context *ctx,
        fz_rect rect,
        fz_text_language lang
)

function pdf_check_digest

pdf_signature_error
pdf_check_digest (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier,
        pdf_document *doc,
        pdf_obj *signature
)

function pdf_check_certificate

pdf_signature_error
pdf_check_certificate (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier,
        pdf_document *doc,
        pdf_obj *signature
)

function pdf_check_widget_digest

pdf_signature_error
pdf_check_widget_digest (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier,
        pdf_annot *widget
)

function pdf_check_widget_certificate

pdf_signature_error
pdf_check_widget_certificate (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier,
        pdf_annot *widget
)

function pdf_clear_signature

void
pdf_clear_signature (
        fz_context *ctx,
        pdf_annot *widget
)

function pdf_sign_signature_with_appearance

void
pdf_sign_signature_with_appearance (
        fz_context *ctx,
        pdf_annot *widget,
        pdf_pkcs7_signer *signer,
        int64_t date,
        fz_display_list *disp_list
)

Sign a signature field, while assigning it an arbitrary appearance determined by a display list. The function pdf_signature_appearance can generate a variety of common signature appearances.

enum pdf_signature_appearance_flags

enum pdf_signature_appearance_flags
{
        PDF_SIGNATURE_SHOW_LABELS = 1,
        PDF_SIGNATURE_SHOW_DN = 2,
        PDF_SIGNATURE_SHOW_DATE = 4,
        PDF_SIGNATURE_SHOW_TEXT_NAME = 8,
        PDF_SIGNATURE_SHOW_GRAPHIC_NAME = 16,
        PDF_SIGNATURE_SHOW_LOGO = 32,
}

macro PDF_SIGNATURE_DEFAULT_APPEARANCE

#define PDF_SIGNATURE_DEFAULT_APPEARANCE ( \
        PDF_SIGNATURE_SHOW_LABELS | \
        PDF_SIGNATURE_SHOW_DN | \
        PDF_SIGNATURE_SHOW_DATE | \
        PDF_SIGNATURE_SHOW_TEXT_NAME | \
        PDF_SIGNATURE_SHOW_GRAPHIC_NAME | \
        PDF_SIGNATURE_SHOW_LOGO )

function pdf_sign_signature

void
pdf_sign_signature (
        fz_context *ctx,
        pdf_annot *widget,
        pdf_pkcs7_signer *signer,
        int appearance_flags,
        fz_image *graphic,
        const char *reason,
        const char *location
)

Sign a signature field, while assigning it a default appearance.

function pdf_preview_signature_as_display_list

fz_display_list *
pdf_preview_signature_as_display_list (
        fz_context *ctx,
        float w,
        float h,
        fz_text_language lang,
        pdf_pkcs7_signer *signer,
        int appearance_flags,
        fz_image *graphic,
        const char *reason,
        const char *location
)

Create a preview of the default signature appearance.

function pdf_preview_signature_as_pixmap

fz_pixmap *
pdf_preview_signature_as_pixmap (
        fz_context *ctx,
        int w,
        int h,
        fz_text_language lang,
        pdf_pkcs7_signer *signer,
        int appearance_flags,
        fz_image *graphic,
        const char *reason,
        const char *location
)

function pdf_drop_signer

void
pdf_drop_signer (
        fz_context *ctx,
        pdf_pkcs7_signer *signer
)

function pdf_drop_verifier

void
pdf_drop_verifier (
        fz_context *ctx,
        pdf_pkcs7_verifier *verifier
)

function pdf_field_reset

void
pdf_field_reset (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field
)

function pdf_lookup_field

pdf_obj *
pdf_lookup_field (
        fz_context *ctx,
        pdf_obj *form,
        const char *name
)

struct pdf_keystroke_event

struct pdf_keystroke_event
{
        const char *value;
        const char *change;
        int selStart, selEnd;
        int willCommit;
        char *newChange;
        char *newValue;
}

Form text field editing events:

function pdf_field_event_keystroke

int
pdf_field_event_keystroke (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field,
        pdf_keystroke_event *evt
)

function pdf_field_event_validate

int
pdf_field_event_validate (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field,
        const char *value,
        char **newvalue
)

function pdf_field_event_calculate

void
pdf_field_event_calculate (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field
)

function pdf_field_event_format

char *
pdf_field_event_format (
        fz_context *ctx,
        pdf_document *doc,
        pdf_obj *field
)

function pdf_annot_field_event_keystroke

int
pdf_annot_field_event_keystroke (
        fz_context *ctx,
        pdf_document *doc,
        pdf_annot *annot,
        pdf_keystroke_event *evt
)

function pdf_document_event_will_close

void
pdf_document_event_will_close (
        fz_context *ctx,
        pdf_document *doc
)

Call these to trigger actions from various UI events:

function pdf_document_event_will_save

void
pdf_document_event_will_save (
        fz_context *ctx,
        pdf_document *doc
)

function pdf_document_event_did_save

void
pdf_document_event_did_save (
        fz_context *ctx,
        pdf_document *doc
)

function pdf_document_event_will_print

void
pdf_document_event_will_print (
        fz_context *ctx,
        pdf_document *doc
)

function pdf_document_event_did_print

void
pdf_document_event_did_print (
        fz_context *ctx,
        pdf_document *doc
)

function pdf_page_event_open

void
pdf_page_event_open (
        fz_context *ctx,
        pdf_page *page
)

function pdf_page_event_close

void
pdf_page_event_close (
        fz_context *ctx,
        pdf_page *page
)

function pdf_annot_event_enter

void
pdf_annot_event_enter (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_exit

void
pdf_annot_event_exit (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_down

void
pdf_annot_event_down (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_up

void
pdf_annot_event_up (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_focus

void
pdf_annot_event_focus (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_blur

void
pdf_annot_event_blur (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_page_open

void
pdf_annot_event_page_open (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_page_close

void
pdf_annot_event_page_close (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_page_visible

void
pdf_annot_event_page_visible (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_annot_event_page_invisible

void
pdf_annot_event_page_invisible (
        fz_context *ctx,
        pdf_annot *annot
)

function pdf_bake_document

void
pdf_bake_document (
        fz_context *ctx,
        pdf_document *doc,
        int bake_annots,
        int bake_widgets
)

Bake appearances of annotations and/or widgets into static page content, and remove the corresponding interactive PDF objects.