fpdf_textpage_r.h

Go to the documentation of this file.

#ifndef _FSPDF_TEXTPAGE_R_H_
#define _FSPDF_TEXTPAGE_R_H_

#ifdef __cplusplus
extern "C" {
#endif

/********************************************************************************/
/* Base definitions for Text                                                    */
/*                                                                              */
/* Handle definitions, macro definitions, data structure                        */
/********************************************************************************/
#ifndef _FSPDF_DEF_HANDLE_TEXTPAGE_
#define _FSPDF_DEF_HANDLE_TEXTPAGE_

FSCRT_DEFINEHANDLE(FSPDF_TEXTPAGE);

#endif /* _FSPDF_DEF_HANDLE_TEXTPAGE_ */

#ifndef _FSPDF_DEF_HANDLE_TEXTSELECTION_
#define _FSPDF_DEF_HANDLE_TEXTSELECTION_

FSCRT_DEFINEHANDLE(FSPDF_TEXTSELECTION);

#endif /* _FSPDF_DEF_HANDLE_TEXTSELECTION_ */

#ifndef _FSPDF_DEF_HANDLE_TEXTSEARCH_
#define _FSPDF_DEF_HANDLE_TEXTSEARCH_

FSCRT_DEFINEHANDLE(FSPDF_TEXTSEARCH);

#endif /* _FSPDF_DEF_HANDLE_TEXTSEARCH_ */

#ifndef _FSPDF_DEF_HANDLE_TEXTLINK_
#define _FSPDF_DEF_HANDLE_TEXTLINK_

FSCRT_DEFINEHANDLE(FSPDF_TEXTLINK);

#endif /* _FSPDF_DEF_HANDLE_TEXTLINK_ */

#ifndef _FSPDF_DEF_MACRO_TEXTPAGE_CHARSTATE_
#define _FSPDF_DEF_MACRO_TEXTPAGE_CHARSTATE_

#define FSPDF_TEXTPAGE_CHARSTATE_NORMAL                 1       

#define FSPDF_TEXTPAGE_CHARSTATE_GENERATED              2 

#define FSPDF_TEXTPAGE_CHARSTATE_NONUNICODE             3

#endif /* _FSPDF_DEF_MACRO_TEXTPAGE_CHARSTATE_ */


#ifndef _FSPDF_DEF_MACRO_TEXT_PARSEOPTION
#define _FSPDF_DEF_MACRO_TEXT_PARSEOPTION

#define FSPDF_TEXT_PARSEOPTION_STREAMORDER              0x0001

#define FSPDF_TEXT_PARSEOPTION_OUTPUTHYPHEN             0x0002

#endif /* _FSPDF_DEF_MACRO_TEXT_PARSEOPTION */

#ifndef _FSPDF_DEF_STRUCTURE_TEXTPAGE_CHARINFO_
#define _FSPDF_DEF_STRUCTURE_TEXTPAGE_CHARINFO_

typedef struct _TEXTPAGE_CHARINFO_
{
        FSCRT_FONT              font;                   
        FS_INT32                state;
        FS_FLOAT                fontSize;
        FS_FLOAT                originX;
        FS_FLOAT                originY;
        FSCRT_RECTF             bbox;
        FSCRT_MATRIX    matrix;
}FSPDF_TEXTPAGE_CHARINFO;

#endif /* _FSPDF_DEF_STRUCTURE_TEXTPAGE_CHARINFO_ */

/*******************************************************************************/
/* Text page                                                                   */
/*******************************************************************************/
FS_RESULT       FSPDF_TextPage_Load(FSCRT_PAGE pdfPage, FSPDF_TEXTPAGE* textPage);

FS_RESULT       FSPDF_TextPage_LoadWithOption(FSCRT_PAGE pdfPage, FS_INT32 option, FSPDF_TEXTPAGE* textPage);

FS_RESULT       FSPDF_TextPage_Release(FSPDF_TEXTPAGE textPage);

FS_RESULT       FSPDF_TextPage_CountChars(FSPDF_TEXTPAGE textPage, FS_INT32* count);

FS_RESULT       FSPDF_TextPage_GetChars(FSPDF_TEXTPAGE textPage, FS_INT32 start, FS_INT32 count, FSCRT_BSTR* chars);

FS_RESULT       FSPDF_TextPage_GetUnicode(FSPDF_TEXTPAGE textPage, FS_INT32 index, FS_DWORD* unicode);

FS_RESULT       FSPDF_TextPage_ExportToFile(FSPDF_TEXTPAGE textPage, FSCRT_FILE file);

FS_RESULT       FSPDF_TextPage_GetCharInfo(FSPDF_TEXTPAGE textPage, FS_INT32 charIndex, FSPDF_TEXTPAGE_CHARINFO* info);

FS_RESULT       FSPDF_TextPage_GetCharIndexAtPos(FSPDF_TEXTPAGE textPage, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FS_INT32* charIndex);

/*******************************************************************************/
/* Text selection                                                              */
/*******************************************************************************/
FS_RESULT       FSPDF_TextPage_SelectByRange(FSPDF_TEXTPAGE textPage, FS_INT32 start, FS_INT32 count, FSPDF_TEXTSELECTION* textSelection);

FS_RESULT       FSPDF_TextPage_SelectByRectangle(FSPDF_TEXTPAGE textPage, const FSCRT_RECTF* rect, FSPDF_TEXTSELECTION* textSelection);

FS_RESULT       FSPDF_TextSelection_Release(FSPDF_TEXTSELECTION textSelection);

FS_RESULT       FSPDF_TextSelection_GetBBox(FSPDF_TEXTSELECTION textSelection, FSCRT_RECTF* bbox);

FS_RESULT       FSPDF_TextSelection_GetChars(FSPDF_TEXTSELECTION textSelection, FSCRT_BSTR* chars);

FS_RESULT       FSPDF_TextSelection_CountPieces(FSPDF_TEXTSELECTION textSelection, FS_INT32* count);

FS_RESULT       FSPDF_TextSelection_GetPieceRect(FSPDF_TEXTSELECTION textSelection, FS_INT32 pieceIndex, FSCRT_RECTF* rect);

FS_RESULT       FSPDF_TextSelection_GetPieceRotation(FSPDF_TEXTSELECTION textSelection, FS_INT32 pieceIndex, FS_INT32* rotation);

FS_RESULT       FSPDF_TextSelection_GetPieceCharRange(FSPDF_TEXTSELECTION textSelection, FS_INT32 pieceIndex, FS_INT32* start, FS_INT32* count);

FS_RESULT       FSPDF_TextSelection_GetLayerArray(FSPDF_TEXTSELECTION textSelection, FSPDF_LAYERNODE* layers, FSCRT_ARRAY* layerArray);

FS_RESULT       FSPDF_TextSelection_GetVisibleSelection(FSPDF_TEXTSELECTION textSelection, FSPDF_LAYERCONTEXT context, FSPDF_TEXTSELECTION* visibleSelection);

/*******************************************************************************/
/* Text search                                                                 */
/*******************************************************************************/
FS_RESULT       FSPDF_TextPage_StartSearch(FSPDF_TEXTPAGE textPage, const FSCRT_BSTR* searchPattern, FS_DWORD flags, FS_INT32 startIndex, 
                                                                           FSPDF_TEXTSEARCH* textSearch);

FS_RESULT       FSPDF_TextSearch_Release(FSPDF_TEXTSEARCH textSearch);

FS_RESULT       FSPDF_TextSearch_FindNext(FSPDF_TEXTSEARCH textSearch, FS_BOOL* isMatch);

FS_RESULT       FSPDF_TextSearch_FindPrev(FSPDF_TEXTSEARCH textSearch, FS_BOOL* isMatch);

FS_RESULT       FSPDF_TextSearch_GetSelection(FSPDF_TEXTSEARCH textSearch, FSPDF_TEXTSELECTION* textSelection);

/*******************************************************************************/
/* Text link                                                                   */
/*******************************************************************************/
FS_RESULT       FSPDF_TextPage_ExtractLinks(FSPDF_TEXTPAGE textPage, FSPDF_TEXTLINK* textLink);

FS_RESULT       FSPDF_TextLink_Release(FSPDF_TEXTLINK textLink);

FS_RESULT       FSPDF_TextLink_CountLinks(FSPDF_TEXTLINK textLink, FS_INT32* linkCount);

FS_RESULT       FSPDF_TextLink_GetLink(FSPDF_TEXTLINK textLink, FS_INT32 linkIndex, FSCRT_BSTR* linkURI);

FS_RESULT       FSPDF_TextLink_GetSelection(FSPDF_TEXTLINK textLink, FS_INT32 linkIndex, FSPDF_TEXTSELECTION* textSelection);

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

#endif /* _FSPDF_TEXTPAGE_R_H_ */