fpdf_form_r.h

Go to the documentation of this file.

#ifndef _FSPDF_FORM_R_H_
#define _FSPDF_FORM_R_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************/
/* Definitions for PDF form                                                    */
/*******************************************************************************/
#ifndef _FSPDF_DEF_HANDLE_FORM_
#define _FSPDF_DEF_HANDLE_FORM_

FSCRT_DEFINEHANDLE(FSPDF_FORM);

#endif /* _FSPDF_DEF_HANDLE_FORM_ */

#ifndef _FSPDF_DEF_HANDLE_FORMCONTROL_
#define _FSPDF_DEF_HANDLE_FORMCONTROL_

FSCRT_DEFINEHANDLE(FSPDF_FORMCONTROL);

#endif /* _FSPDF_DEF_HANDLE_FORMCONTROL_ */

#ifndef _FSPDF_DEF_MACRO_FORMFIELDTYPE_
#define _FSPDF_DEF_MACRO_FORMFIELDTYPE_

#define FSPDF_FORMFIELDTYPE_UNKNOWN                     0       
#define FSPDF_FORMFIELDTYPE_PUSHBUTTON          1       
#define FSPDF_FORMFIELDTYPE_CHECKBOX            2       
#define FSPDF_FORMFIELDTYPE_RADIOBUTTON         3       
#define FSPDF_FORMFIELDTYPE_COMBOBOX            4       
#define FSPDF_FORMFIELDTYPE_LISTBOX                     5       
#define FSPDF_FORMFIELDTYPE_TEXTFIELD           6       
#define FSPDF_FORMFIELDTYPE_UNSPECIFIED         FSPDF_FORMFIELDTYPE_UNKNOWN     
#endif /* _FSPDF_DEF_MACRO_FORMFIELDTYPE_ */

#ifndef _FSPDF_DEF_MACRO_FORMFIELDFLAG_
#define _FSPDF_DEF_MACRO_FORMFIELDFLAG_

#define FSPDF_FORMFIELDFLAG_READONLY            0x001   
#define FSPDF_FORMFIELDFLAG_REQUIRED            0x002   
#define FSPDF_FORMFIELDFLAG_NOEXPORT            0x004   
#define FSPDF_FORMFIELDFLAG_BUTTON_NOTOGGLETOOF                 0x100

#define FSPDF_FORMFIELDFLAG_BUTTON_RADIOSINUNISON               0x200

#define FSPDF_FORMFIELDFLAG_TEXT_MULTILINE                              0x100

#define FSPDF_FORMFIELDFLAG_TEXT_PASSWORD                               0x200

#define FSPDF_FORMFIELDFLAG_TEXT_DONOTSCROLL                    0x400

#define FSPDF_FORMFIELDFLAG_TEXT_COMB                                   0x800

#define FSPDF_FORMFIELDFLAG_COMBO_EDIT                          0x100

#define FSPDF_FORMFIELDFLAG_CHOICE_MULTISELECT                  0x100

#endif /* _FSPDF_DEF_MACRO_FORMFIELDFLAG_ */

/*******************************************************************************/
/* Form                                                                        */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_HasForm(FSCRT_DOCUMENT document, FS_BOOL* hasForm);

FS_RESULT       FSPDF_Form_Load(FSCRT_DOCUMENT pdfDoc, FSPDF_FORM* form);

FS_RESULT       FSPDF_Form_Release(FSPDF_FORM form);

FS_RESULT       FSPDF_Form_GetDocument(FSPDF_FORM form, FSCRT_DOCUMENT* document);

FS_RESULT       FSPDF_Form_CountFields(FSPDF_FORM form, const FSCRT_BSTR* filter, FS_INT32* count);

FS_RESULT       FSPDF_Form_GetField(FSPDF_FORM form, const FSCRT_BSTR* filter, FS_INT32 index, FSCRT_BSTR* fieldName, FS_INT32* fieldType);

FS_RESULT       FSPDF_Form_GetControlAtPos(FSPDF_FORM form, FSCRT_PAGE page, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, 
                                                                           FS_INT32 typeFilter, FSPDF_FORMCONTROL* formControl);

FS_RESULT       FSPDF_Form_GetControlAtDevicePos(FSPDF_FORM form, FSCRT_PAGE page, const FSCRT_MATRIX* matrix, 
                                                                                         FS_INT32 x, FS_INT32 y, FS_FLOAT tolerance, 
                                                                                         FS_INT32 typeFilter, FSPDF_FORMCONTROL* formControl);

FS_RESULT       FSPDF_Form_GetDefaultAppearance(FSPDF_FORM form, FSPDF_DEFAULTAPPEARANCE* defAppearance);

FS_RESULT       FSPDF_Form_GetAlignment(FSPDF_FORM form, FS_INT32* alignment);

FS_RESULT       FSPDF_Form_NeedConstructAppearances(FSPDF_FORM form, FS_BOOL* needConstruct);

FS_RESULT       FSPDF_Form_ValidateFieldName(FSPDF_FORM form, const FSCRT_BSTR* newFieldName, FS_INT32 fieldType, FS_BOOL* validate);

FS_RESULT       FSPDF_Form_GetFieldsInCalculationOrder(FSPDF_FORM form, FSCRT_BSTR* fieldNames, FS_DWORD* count);

/*******************************************************************************/
/* Form field trigger actions                                                  */
/*******************************************************************************/
FS_RESULT       FSPDF_FormField_CountActions(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32 trigger, FS_INT32* count);

FS_RESULT       FSPDF_FormField_GetAction(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32 trigger, FS_INT32 index, FSPDF_ACTIONDATA* actionData);

/*******************************************************************************/
/* Form field                                                                  */
/*******************************************************************************/
#ifndef _FSPDF_DEF_STRUCTURE_CHOICEOPTION_
#define _FSPDF_DEF_STRUCTURE_CHOICEOPTION_

typedef struct _FSPDF_CHOICEOPTION
{
        FSCRT_BSTR              optionValue;
        FSCRT_BSTR              optionLabel;
        FS_BOOL                 selected;
        FS_BOOL                 defaultSelected;
} FSPDF_CHOICEOPTION;

#endif /* _FSPDF_DEF_STRUCTURE_CHOICEOPTION_ */

FS_RESULT       FSPDF_ChoiceOption_Init(FSPDF_CHOICEOPTION* options);

FS_RESULT       FSPDF_ChoiceOption_Clear(FSPDF_CHOICEOPTION* options);

FS_RESULT       FSPDF_FormField_GetAlignment(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32* alignment);

FS_RESULT       FSPDF_FormField_GetFlags(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_DWORD* flags);

FS_RESULT       FSPDF_FormField_GetType(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32* fieldType);

FS_RESULT       FSPDF_FormField_GetDefaultValue(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSCRT_BSTR* value);

FS_RESULT       FSPDF_FormField_GetValue(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSCRT_BSTR* value);

FS_RESULT       FSPDF_FormField_CountControls(FSPDF_FORM form, FSCRT_PAGE page, const FSCRT_BSTR* fieldName, FS_INT32* count);

FS_RESULT       FSPDF_FormField_GetControl(FSPDF_FORM form, FSCRT_PAGE page, const FSCRT_BSTR* fieldName, FS_INT32 index, FSPDF_FORMCONTROL* formControl);

FS_RESULT       FSPDF_FormField_GetControlIndex(FSPDF_FORM form, const FSPDF_FORMCONTROL formControl, FS_INT32* index);

FS_RESULT       FSPDF_FormField_GetDefaultAppearance(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSPDF_DEFAULTAPPEARANCE* defAppearance);

FS_RESULT       FSPDF_FormField_GetAlternateName(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSCRT_BSTR* alternateName);

FS_RESULT       FSPDF_FormField_GetMappingName(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSCRT_BSTR* mappingName);

FS_RESULT       FSPDF_FormField_GetMaxLen(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32* maxLen);

FS_RESULT       FSPDF_FormField_GetOptions(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSPDF_CHOICEOPTION* options, FS_INT32* count);

FS_RESULT       FSPDF_FormField_GetTopVisibleIndex(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32* index);

/*******************************************************************************/
/* Form control                                                                */
/*******************************************************************************/
FS_RESULT       FSPDF_FormControl_GetWidgetAnnot(FSPDF_FORMCONTROL formControl, FSCRT_ANNOT* widgetAnnot);

FS_RESULT       FSPDF_FormControl_GetFieldName(FSPDF_FORMCONTROL formControl, FSCRT_BSTR* fieldName);

FS_RESULT       FSPDF_FormControl_GetExportValue(FSPDF_FORMCONTROL formControl, FSCRT_BSTR* exportValue);

FS_RESULT       FSPDF_FormControl_IsChecked(FSPDF_FORMCONTROL formControl, FS_BOOL* checked);

FS_RESULT       FSPDF_FormControl_IsDefaultChecked(FSPDF_FORMCONTROL formControl, FS_BOOL* checked);

FS_RESULT       FSPDF_RenderContext_StartFormControls(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, const FSPDF_FORMCONTROL* formControls, FS_INT32 count, FSCRT_PROGRESS* renderProgress);

FS_RESULT       FSPDF_RenderContext_StartPageFormControls(FSPDF_RENDERCONTEXT pdfRenderContext, FSCRT_RENDERER renderer, 
                                                                                                          FSCRT_PAGE page, FSCRT_PROGRESS* renderProgress);

#ifdef __cplusplus
};
#endif
 /* group FPDFFORM */

#endif /* _FSPDF_FORM_R_H_ */