fpdf_form_w.h

Go to the documentation of this file.

#ifndef _FSPDF_FORM_W_H_
#define _FSPDF_FORM_W_H_

#ifdef __cplusplus
extern "C" {
#endif

/*******************************************************************************/
/* Form                                                                        */
/*******************************************************************************/
FS_RESULT       FSPDF_Doc_CreateForm(FSCRT_DOCUMENT document, FSPDF_FORM* form);

FS_RESULT       FSPDF_Form_ExportToFDFDoc(FSPDF_FORM form, FSCRT_DOCUMENT fdfDoc);

FS_RESULT       FSPDF_Form_ImportFromFDFDoc(FSPDF_FORM form, FSCRT_DOCUMENT fdfDoc);

FS_RESULT       FSPDF_Form_ExportToXML(FSPDF_FORM form, FSCRT_FILE xmlFile);

FS_RESULT       FSPDF_Form_ImportFromXML(FSPDF_FORM form, FSCRT_FILE xmlFile);

FS_RESULT       FSPDF_Form_Reset(FSPDF_FORM form, const FSCRT_BSTR* fieldNames, FS_INT32 count, FS_BOOL bInclude);

FS_RESULT       FSPDF_Form_SetDefaultAppearance(FSPDF_FORM form, const FSPDF_DEFAULTAPPEARANCE* defAppearance);

FS_RESULT       FSPDF_Form_SetAlignment(FSPDF_FORM form, FS_INT32 alignment);

FS_RESULT       FSPDF_Form_SetConstructAppearancesFlag(FSPDF_FORM form, FS_BOOL needConstruct);

FS_RESULT       FSPDF_Form_RenameField(FSPDF_FORM form, const FSCRT_BSTR* fieldName, const FSCRT_BSTR* newFieldName);

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

FS_RESULT       FSPDF_Form_AddField(FSPDF_FORM form, FSCRT_PAGE page, const FSCRT_BSTR* fieldName, FS_INT32 fieldType, FSCRT_RECTF *rect, FSPDF_FORMCONTROL* formControl);

FS_RESULT       FSPDF_Form_RemoveField(FSPDF_FORM form, const FSCRT_BSTR* fieldName);

/*******************************************************************************/
/* Form filler                                                                                                                             */
/*******************************************************************************/
#ifndef _FSPDF_DEF_HANDLE_FORMFILLER_
#define _FSPDF_DEF_HANDLE_FORMFILLER_

FSCRT_DEFINEHANDLE(FSPDF_FORMFILLER);

#endif /* _FSPDF_DEF_HANDLE_FORMFILLER_ */


#ifndef _FS_DEF_FORMINTERACTION_WINDOWLESSEXTENT_
#define _FS_DEF_FORMINTERACTION_WINDOWLESSEXTENT_

typedef struct  _FPDF_FORMINTERACTION_WINDOWLESSEXTENT_
{    
     FS_DWORD   lStructSize;
    
     FS_LPVOID  clientData;
        FS_RESULT       (*OutputSelectedRect)(FS_LPVOID clientData,FS_INT32 pageIndex, FSCRT_RECTF* pdfRect);

        FS_RESULT       (*SetCursor)(FS_LPVOID clientData, FS_INT32 nCursorType);

        FS_RESULT       (*SetTimer)(FS_LPVOID clientData, FS_INT32 uElapse, FSCRT_CALLBACK_TIMER lpTimerFunc, FS_INT32* timeID);

        FS_RESULT       (*KillTimer)(FS_LPVOID clientData, FS_INT32 timerID);

        FS_RESULT       (*GotFocusOnControl)(FS_LPVOID clientData, FSPDF_FORMCONTROL control, const FSCRT_BSTR* filedValue);

        FS_RESULT       (*LostFocusOnControl)(FS_LPVOID clientData, FSPDF_FORMCONTROL control, const FSCRT_BSTR* filedValue);
        
} FSPDF_FORMINTERACTION_WINDOWLESS;

#endif /* FPDF_FORMINTERACTION_WINDOWLESS */

FS_RESULT       FSPDF_FormFiller_Begin(FSPDF_FORM form, FSPDF_FORMINTERACTION_WINDOWLESS* windowless, FSPDF_FORMFILLER* filler);

FS_RESULT       FSPDF_FormFiller_TriggerWindowlessEvent(FSPDF_FORMFILLER filler, FSCRT_PAGE page, FSCRT_MATRIX* page2Device, FS_DWORD eventType, FS_LPVOID eventData);

FS_RESULT       FSPDF_FormFiller_SetHighlightColor(FSPDF_FORMFILLER filler, FS_INT32 fieldType, FS_ARGB color);

FS_RESULT       FSPDF_FormFiller_ShowHighlight(FSPDF_FORMFILLER filler, FS_BOOL show);

FS_RESULT FSPDF_FormFiller_End(FSPDF_FORMFILLER filler);

/*******************************************************************************/
/* Form field trigger actions                                                  */
/*******************************************************************************/
FS_RESULT       FSPDF_FormField_SetAction(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA* actionData);

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

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

FS_RESULT       FSPDF_FormField_RemoveAllActions(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32 trigger);

FS_RESULT       FSPDF_FormField_RemoveControl(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSPDF_FORMCONTROL formControl);

FS_RESULT       FSPDF_FormField_ValidateValue(FSPDF_FORM form, const FSCRT_BSTR* fieldName, const FSCRT_BSTR* value, FS_BOOL* isValid);

FS_RESULT       FSPDF_FormField_ValidateKeyStroke(FSPDF_FORM form, const FSCRT_BSTR* fieldName, const FSCRT_BSTR* value, FS_BOOL* isValid);

#ifndef _FSPDF_DEF_STRUCTURE_JAVASCRIPTEVENT_
#define _FSPDF_DEF_STRUCTURE_JAVASCRIPTEVENT_

typedef struct _FSPDF_JAVASCRIPTEVENT
{
        FSCRT_BSTR              strValue;
        FSCRT_BSTR              strChange;
        FS_INT32                nStart;
        FS_INT32                nEnd;
        FS_BOOL                 bWillCommit;
        FS_BOOL                 bRc;
} FSPDF_JAVASCRIPTEVENT;

#endif /* _FSPDF_DEF_STRUCTURE_JAVASCRIPTEVENT_ */

FS_RESULT       FSPDF_FormField_ValidateKeyStrokeEvent(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSPDF_JAVASCRIPTEVENT* jsEvent);

FS_RESULT       FSPDF_FormField_Calculate(FSPDF_FORM form, const FSCRT_BSTR* fieldName);

FS_RESULT       FSPDF_FormField_Format(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_BOOL* isFormated);

/*******************************************************************************/
/* Form field                                                                  */
/*******************************************************************************/
FS_RESULT       FSPDF_FormField_SetAlignment(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FS_INT32 alignment);

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

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

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

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

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

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

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

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

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

/*******************************************************************************/
/* Form control                                                                */
/*******************************************************************************/
FS_RESULT       FSPDF_FormControl_SetExportValue(FSPDF_FORMCONTROL formControl, const FSCRT_BSTR* exportValue);

FS_RESULT       FSPDF_FormControl_SetChecked(FSPDF_FORMCONTROL formControl, FS_BOOL checked);

FS_RESULT       FSPDF_FormControl_SetDefaultChecked(FSPDF_FORMCONTROL formControl, FS_BOOL checked);

FS_RESULT       FSPDF_FormControl_DoJavaScriptAction(FSPDF_FORMCONTROL control, FS_INT32 trigger);

FS_RESULT       FSPDF_FormField_ValidateValueEvent(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSPDF_JAVASCRIPTEVENT* jsEvent);

FS_RESULT       FSPDF_FormField_FormatEvent(FSPDF_FORM form, const FSCRT_BSTR* fieldName, FSPDF_JAVASCRIPTEVENT* jsEvent);

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

#endif /* _FSPDF_FORM_W_H_ */