fs_obsolete.h

Go to the documentation of this file.

#ifndef _FSCRT_OBSOLETE_H_
#define _FSCRT_OBSOLETE_H_

#ifdef __cplusplus
extern "C" {
#endif


#ifndef _FSPDF_DEF_HANDLER_ACTION_
#define _FSPDF_DEF_HANDLER_ACTION_

typedef struct _FSPDF_ACTION_HANDLER
{
        FS_LPVOID       clientData;

        FS_RESULT       (*Release)(FS_LPVOID clientData);

        FS_RESULT       (*InvalidateRect)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 pageIndex, FSCRT_RECTF* pdfRect);

        FS_RESULT       (*GetCurrentPageIndex)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32* pageIndex);
 
        FS_RESULT       (*SetCurrentPageIndex)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 pageIndex);

        FS_RESULT       (*GetRotation)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_INT32 pageIndex, FS_INT32* rotation);
         
        FS_RESULT       (*ExecuteNamedAction)(FS_LPVOID clientData, FSCRT_DOCUMENT document, const FSCRT_BSTR* namedAction);

        FS_RESULT       (*SetChangeMark)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL changeMark);

        FS_RESULT       (*GetChangeMark)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL* changeMark);
        
        FS_RESULT       (*GetOpenedDocs)(FS_LPVOID clientData, FSCRT_DOCUMENT* docs, FS_INT32* count);
        
        FS_RESULT       (*Alert)(FS_LPVOID clientData, const FSCRT_BSTR* msg, const FSCRT_BSTR* title, FS_INT32 type, FS_INT32 icon, FS_INT32* retCode);
        
        FS_RESULT       (*Beep)(FS_LPVOID clientData, FS_INT32 type);
        
        FS_RESULT       (*Response)(FS_LPVOID clientData, const FSCRT_BSTR* question, const FSCRT_BSTR* title, const FSCRT_BSTR* defaultValue, 
                                                        const FSCRT_BSTR* label, FS_BOOL isPassword, FSCRT_BSTR* response);
        
        FS_RESULT       (*GetFilePath)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FSCRT_BSTR* filePath);
        
        FS_RESULT       (*Mail)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL bUI, const FSCRT_BSTR* To, 
                                            const FSCRT_BSTR* Subject, const FSCRT_BSTR* CC, const FSCRT_BSTR* BCC, const FSCRT_BSTR* Msg); 

        FS_RESULT       (*Print)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_BOOL isUI, FS_INT32 start, FS_INT32 end, FS_BOOL isSilent ,
                                             FS_BOOL isShrinkToFit, FS_BOOL isPrintAsImage, FS_BOOL isReverse, FS_BOOL isAnnotations);

        FS_RESULT       (*SubmitForm)(FS_LPVOID clientData, FSCRT_DOCUMENT document, FS_LPVOID formData, FS_DWORD length, const FSCRT_BSTR* URL);
        
        FS_RESULT       (*LaunchURL)(FS_LPVOID clientData, const FSCRT_BSTR* URL); 

        FS_RESULT       (*BrowseFile)(FS_LPVOID clientData, FSCRT_BSTR* filePath);

        FS_RESULT       (*GetLanguage)(FS_LPVOID clientData, FS_INT32* language);

        /*
         * @brief       Optional callback function to get identity properties of the current user.
         *
         * @param[in]   clientData                      The user-supplied data.
         * @param[out]  identityProperties      Pointer to a ::FSPDF_IDENTITYPROPERTIES structure that receives the identity properties.
         *
         * @return      ::FSCRT_ERRCODE_SUCCESS for success.<br>
         *                      For more error codes, please refer to macro definitions {@link FSCRT_ERRCODE_SUCCESS FSCRT_ERRCODE_XXX}.
         */
        FS_RESULT       (*GetIdentityProperties)(FS_LPVOID clientData, FSPDF_IDENTITYPROPERTIES* identityProperties);

        FS_RESULT       (*PopupMenu)(FS_LPVOID clientData, const FSPDF_MENULIST* menus, FS_INT32 count, FSCRT_BSTR* seletedMenu);
} FSPDF_ACTION_HANDLER;

#endif /* _FSPDF_DEF_HANDLER_ACTION_ */

FS_RESULT       FSPDF_Doc_SetActionHandler(FSCRT_DOCUMENT document, FSPDF_ACTION_HANDLER* actionHandler);

#ifndef _FSPDF_DEF_STRUCTURE_ENUMPAGESIZEHANDLER_
#define _FSPDF_DEF_STRUCTURE_ENUMPAGESIZEHANDLER_

typedef struct _FSPDF_ENUMPAGESIZEHANDLER
{
        FS_LPVOID       clientData;

        /*
         * @brief       Enumerate page size of a PDF page.
         *
         * @details     Foxit SDK calls this function to enumerate page size for each page, and the application can get page size quickly 
         *                      from the parameter <i>pageWidth</i> and <i>pageHeight</i>, with <i>pageIndex</i> in this callback function.<br>
         *                      Application is not suggested to call any API of Foxit SDK inside this callback function since it may reduce the speed of enumerating all page size.
         *
         * @param[in]   clientData              Pointer to user-defined data.
         * @param[in]   pageIndex               Index of a PDF page. starting from 0.
         * @param[in]   pageWidth               Width of a PDF page.
         * @param[in]   pageHeight              Height of a PDF page.
         *
         * @return      ::FSCRT_ERRCODE_SUCCESS for success.<br>
         *                      ::FSCRT_ERRCODE_UNRECOVERABLE if function finds an unrecoverable error internally.<br>
         *                      For more error codes, please refer to macro definitions {@link FSCRT_ERRCODE_SUCCESS FSCRT_ERRCODE_XXX}.
         */
        FS_RESULT       (*EnumPageSize)(FS_LPVOID clientData, FS_INT32 pageIndex, FS_FLOAT pageWidth, FS_FLOAT pageHeight);
}FSPDF_ENUMPAGESIZEHANDLER;

#endif //_FSPDF_DEF_STRUCTURE_ENUMPAGESIZEHANDLER_

FS_RESULT FSPDF_Doc_EnumAllPageSize(FSCRT_DOCUMENT document, FSPDF_ENUMPAGESIZEHANDLER* enumHandler);

#ifndef _FSPDF_DEF_MACRO_TEXTDIRECTION_
#define _FSPDF_DEF_MACRO_TEXTDIRECTION_

#define FSPDF_TEXTDIRECTION_LEFT                -1

#define FSPDF_TEXTDIRECTION_RIGHT               1

#define FSPDF_TEXTDIRECTION_UP                  -2

#define FSPDF_TEXTDIRECTION_DOWN                2

#endif /* _FSPDF_DEF_MACRO_TEXTDIRECTION_ */

FS_RESULT       FSPDF_TextPage_GetNextCharIndexByDirection(FSPDF_TEXTPAGE textPage, FS_INT32 curIndex, FS_INT32 direction, FS_INT32* nextIndex);

#ifndef FSPDF_RENDERCONTEXTFLAG_LIMITEDIMAGECACHE

#define FSPDF_RENDERCONTEXTFLAG_LIMITEDIMAGECACHE               0x0010
#endif


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

#endif /* _FSCRT_APP_R_H_ */