Header file for PDF Text module of Foxit PDF SDK. More...
Go to the source code of this file.
Classes | |
| struct | FSPDF_TEXTPAGE |
| Handle type to PDF text page. More... | |
| struct | FSPDF_TEXTSELECTION |
| Handle type to PDF text selection. More... | |
| struct | FSPDF_TEXTSEARCH |
| Handle type to PDF text search. More... | |
| struct | FSPDF_TEXTLINK |
| Handle type to PDF text link. More... | |
| struct | FSPDF_TEXTPAGE_CHARINFO |
| Structure for character's information definition. More... | |
Macros | |
Macro Definitions for Character State | |
| |
| #define | FSPDF_TEXTPAGE_CHARSTATE_NORMAL 1 |
| Normal character. | |
| #define | FSPDF_TEXTPAGE_CHARSTATE_GENERATED 2 |
| Character is generated by Foxit, such as space character. | |
| #define | FSPDF_TEXTPAGE_CHARSTATE_NONUNICODE 3 |
| Character does not have its own unicode value . | |
Macro Definitions for PDF Text Page Parsing Flags | |
| #define | FSPDF_TEXT_PARSEOPTION_STREAMORDER 0x0001 |
| Parse the text content of PDF page by the stream order. | |
| #define | FSPDF_TEXT_PARSEOPTION_OUTPUTHYPHEN 0x0002 |
| Parse the text content of PDF page with outputting the hyphen on a line feed. | |
Functions | |
| FS_RESULT | FSPDF_TextPage_Load (FSCRT_PAGE pdfPage, FSPDF_TEXTPAGE *textPage) |
| Prepare information of all characters in a page. More... | |
| FS_RESULT | FSPDF_TextPage_LoadWithOption (FSCRT_PAGE pdfPage, FS_INT32 option, FSPDF_TEXTPAGE *textPage) |
| Prepare information of all characters in a page, with option. More... | |
| FS_RESULT | FSPDF_TextPage_Release (FSPDF_TEXTPAGE textPage) |
| Release all resources allocated for a PDF text page handle. More... | |
| FS_RESULT | FSPDF_TextPage_CountChars (FSPDF_TEXTPAGE textPage, FS_INT32 *count) |
| Get count of characters in a page. More... | |
| FS_RESULT | FSPDF_TextPage_GetChars (FSPDF_TEXTPAGE textPage, FS_INT32 start, FS_INT32 count, FSCRT_BSTR *chars) |
| Get text content in a page, within a specific character range. More... | |
| FS_RESULT | FSPDF_TextPage_GetUnicode (FSPDF_TEXTPAGE textPage, FS_INT32 index, FS_DWORD *unicode) |
| Get the unicode representation of a character in a page. More... | |
| FS_RESULT | FSPDF_TextPage_ExportToFile (FSPDF_TEXTPAGE textPage, FSCRT_FILE file) |
| Export text content in a page to a specific file handle. More... | |
| FS_RESULT | FSPDF_TextPage_GetCharInfo (FSPDF_TEXTPAGE textPage, FS_INT32 charIndex, FSPDF_TEXTPAGE_CHARINFO *info) |
| Get character information of a specific character. More... | |
| FS_RESULT | FSPDF_TextPage_GetCharIndexAtPos (FSPDF_TEXTPAGE textPage, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FS_INT32 *charIndex) |
| Get the character index at or around a specific position on the page. More... | |
| FS_RESULT | FSPDF_TextPage_SelectByRange (FSPDF_TEXTPAGE textPage, FS_INT32 start, FS_INT32 count, FSPDF_TEXTSELECTION *textSelection) |
| Get a text selection handle by specific character range. More... | |
| FS_RESULT | FSPDF_TextPage_SelectByRectangle (FSPDF_TEXTPAGE textPage, const FSCRT_RECTF *rect, FSPDF_TEXTSELECTION *textSelection) |
| Get a text selection handle by specific rectangle. More... | |
| FS_RESULT | FSPDF_TextSelection_Release (FSPDF_TEXTSELECTION textSelection) |
| Release all resources allocated for a PDF text selection handle. More... | |
| FS_RESULT | FSPDF_TextSelection_GetBBox (FSPDF_TEXTSELECTION textSelection, FSCRT_RECTF *bbox) |
| Get bounding box(a rectangular area) of a PDF text selected area. More... | |
| FS_RESULT | FSPDF_TextSelection_GetChars (FSPDF_TEXTSELECTION textSelection, FSCRT_BSTR *chars) |
| Extract the whole text from a PDF text selected area. More... | |
| FS_RESULT | FSPDF_TextSelection_CountPieces (FSPDF_TEXTSELECTION textSelection, FS_INT32 *count) |
| Count the number of all rectangular areas of segments in a PDF text selected area. More... | |
| FS_RESULT | FSPDF_TextSelection_GetPieceRect (FSPDF_TEXTSELECTION textSelection, FS_INT32 pieceIndex, FSCRT_RECTF *rect) |
| Get rectangular area of a specific segment, based on the result of the fucntion FSPDF_TextSelection_CountPieces. More... | |
| FS_RESULT | FSPDF_TextSelection_GetPieceRotation (FSPDF_TEXTSELECTION textSelection, FS_INT32 pieceIndex, FS_INT32 *rotation) |
| Get rotation of the specific segment, based on the result returned by function FSPDF_TextSelection_CountPieces. More... | |
| FS_RESULT | FSPDF_TextSelection_GetPieceCharRange (FSPDF_TEXTSELECTION textSelection, FS_INT32 pieceIndex, FS_INT32 *start, FS_INT32 *count) |
| Get index of the start character and the count of characters of a specific segment. More... | |
| FS_RESULT | FSPDF_TextSelection_GetLayerArray (FSPDF_TEXTSELECTION textSelection, FSPDF_LAYERNODE *layers, FSCRT_ARRAY *layerArray) |
| Get the layer array associated with a PDF text selected area. More... | |
| FS_RESULT | FSPDF_TextSelection_GetVisibleSelection (FSPDF_TEXTSELECTION textSelection, FSPDF_LAYERCONTEXT context, FSPDF_TEXTSELECTION *visibleSelection) |
| Get a new PDF text selected area of visible content from a specific a PDF text selected area. More... | |
| FS_RESULT | FSPDF_TextPage_StartSearch (FSPDF_TEXTPAGE textPage, const FSCRT_BSTR *searchPattern, FS_DWORD flags, FS_INT32 startIndex, FSPDF_TEXTSEARCH *textSearch) |
| Start a PDF text search process. More... | |
| FS_RESULT | FSPDF_TextSearch_Release (FSPDF_TEXTSEARCH textSearch) |
| Release all resources allocated for a PDF text search handle. More... | |
| FS_RESULT | FSPDF_TextSearch_FindNext (FSPDF_TEXTSEARCH textSearch, FS_BOOL *isMatch) |
| Search in the direction from start to end of the page. More... | |
| FS_RESULT | FSPDF_TextSearch_FindPrev (FSPDF_TEXTSEARCH textSearch, FS_BOOL *isMatch) |
| Search in the direction from end to start of the page. More... | |
| FS_RESULT | FSPDF_TextSearch_GetSelection (FSPDF_TEXTSEARCH textSearch, FSPDF_TEXTSELECTION *textSelection) |
| Get a text selection handle from a text search when a match is found. More... | |
| FS_RESULT | FSPDF_TextPage_ExtractLinks (FSPDF_TEXTPAGE textPage, FSPDF_TEXTLINK *textLink) |
| Process a PDF page text object to get URL formatted texts (as hyperlinks). More... | |
| FS_RESULT | FSPDF_TextLink_Release (FSPDF_TEXTLINK textLink) |
| Release all resources allocated for a PDF text link handle. More... | |
| FS_RESULT | FSPDF_TextLink_CountLinks (FSPDF_TEXTLINK textLink, FS_INT32 *linkCount) |
| Get count of the URL formatted texts inside a page. More... | |
| FS_RESULT | FSPDF_TextLink_GetLink (FSPDF_TEXTLINK textLink, FS_INT32 linkIndex, FSCRT_BSTR *linkURI) |
| Get the linked URL associated with a specific hyperlink. More... | |
| FS_RESULT | FSPDF_TextLink_GetSelection (FSPDF_TEXTLINK textLink, FS_INT32 linkIndex, FSPDF_TEXTSELECTION *textSelection) |
| Get a PDF text selection handle from a specific hyperlink. More... | |
Header file for PDF Text module of Foxit PDF SDK.
Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.
The following code is copyrighted and contains proprietary information and trade secrets of Foxit Software Inc.. You cannot distribute any part of Foxit PDF SDK to any third party or general public, unless there is a separate license agreement with Foxit Software Inc. which explicitly grants you such rights.
This header file providers access to PDF text information.
It contains:
