fpdf_pageobjects_r.h File Reference

Header file for PDF Page Objects module of Foxit PDF SDK. More...

Go to the source code of this file.

Classes

struct  FSPDF_PAGEOBJECT
 Handle type to page object. More...
 
struct  FSPDF_PAGEOBJECTS
 Handle type to page objects, which indicates a set of page objects. More...
 
struct  FSPDF_GRAPHSTATE
 Structure for PDF graph states. More...
 
struct  FSPDF_TEXTSTATE
 Structure for PDF text states. More...
 

Macros

Macro Definitions for Page Object Type
#define FSPDF_PAGEOBJECT_ALL   0
 Page object for all types.
 
#define FSPDF_PAGEOBJECT_TEXT   1
 Text object.
 
#define FSPDF_PAGEOBJECT_PATH   2
 Path object.
 
#define FSPDF_PAGEOBJECT_IMAGE   3
 Image object.
 
#define FSPDF_PAGEOBJECT_SHADING   4
 Shading object.
 
#define FSPDF_PAGEOBJECT_FORMXOBJECT   5
 Form XObject object.
 
Macro Definitions for Text Rendering Modes
#define FSPDF_TEXTMODE_FILL   0
 Fill text.
 
#define FSPDF_TEXTMODE_STROKE   1
 Stroke text.
 
#define FSPDF_TEXTMODE_FILLSTROKE   2
 Fill, and stroke text.
 
#define FSPDF_TEXTMODE_INVISIBLE   3
 Neither fill nor stroke text (invisible).
 
#define FSPDF_TEXTMODE_FILLCLIP   4
 Fill text and add to path for clipping.
 
#define FSPDF_TEXTMODE_STROKECLIP   5
 Stroke text and add to path for clipping.
 
#define FSPDF_TEXTMODE_FILLSTROKECLIP   6
 Fill, then stroke text and add to path for clipping.
 
#define FSPDF_TEXTMODE_CLIP   7
 Add text to path for clipping.
 
Macro Definitions for Image object Color space
#define FSPDF_IMAGECS_INVALID   0
 Color space: Invalid.
 
#define FSPDF_IMAGECS_DEVICEGRAY   1
 Color space: DeviceGray.
 
#define FSPDF_IMAGECS_DEVICERGB   2
 Color space: DeviceRGB.
 
#define FSPDF_IMAGECS_DEVICECMYK   3
 Color space: DeviceCMYK.
 
#define FSPDF_IMAGECS_CALGRAY   4
 Color space: CalGray.
 
#define FSPDF_IMAGECS_CALRGB   5
 Color space: CalRGB.
 
#define FSPDF_IMAGECS_LAB   6
 Color space: Lab.
 
#define FSPDF_IMAGECS_SEPARATION   8
 Color space: Separation.
 
#define FSPDF_IMAGECS_DEVICEN   9
 Color space: DeviceN.
 
#define FSPDF_IMAGECS_PATTERN   11
 Color space: Pattern.
 
#define FSPDF_IMAGECS_ICCBASED_DEVICEGRAY   12
 Color space: ICCBased.
 
#define FSPDF_IMAGECS_ICCBASED_DEVICERGB   13
 Color space: ICCBased.
 
#define FSPDF_IMAGECS_ICCBASED_DEVICECMYK   14
 Color space: ICCBased.
 

Functions

FS_RESULT FSPDF_Page_GetPageObjects (FSCRT_PAGE page, FSPDF_PAGEOBJECTS *pageObjs)
 Get page objects in a PDF page. More...
 
FS_RESULT FSPDF_PageObjects_CountObjects (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FS_INT32 *count)
 Get the count of page objects with specific type. More...
 
FS_RESULT FSPDF_PageObjects_GetObject (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FS_INT32 index, FSPDF_PAGEOBJECT *pageObj)
 Get a page object from page objects. More...
 
FS_RESULT FSPDF_PageObjects_EnumerateObject (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FSCRT_POSITION *position, FSPDF_PAGEOBJECT *pageObj)
 Enumerate page objects and retrieve a page object at a given position from page objects. More...
 
FS_RESULT FSPDF_PageObjects_GetObjectIndex (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FSPDF_PAGEOBJECT pageObj, FS_INT32 typeFilter, FS_INT32 *index)
 Get index of a page object. More...
 
FS_RESULT FSPDF_PageObjects_GetObjectAtPos (FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSPDF_PAGEOBJECT *pageObj)
 Get a page object at a specific point, in PDF page coordinate system. More...
 
FS_RESULT FSPDF_PageObjects_GetObjectListAtPos (FSCRT_PAGE page, FS_INT32 typeFilter, FS_FLOAT x, FS_FLOAT y, FS_FLOAT tolerance, FSCRT_ARRAY *pageObjList)
 Get an array of all page objects at a specific point, in PDF page coordinate system. More...
 
FS_RESULT FSPDF_PageObject_GetType (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 *type)
 Get type of a page object. More...
 
FS_RESULT FSPDF_PageObject_GetRect (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_RECTF *rect)
 Get rectangle of a page object. More...
 
FS_RESULT FSPDF_PageObject_GetMatrix (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_MATRIX *matrix)
 Get matrix of a page object. More...
 
FS_RESULT FSPDF_PageObject_GetGraphState (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_GRAPHSTATE *graphState)
 Get graph states of a page object . More...
 
FS_RESULT FSPDF_PageObject_GetColor (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_BOOL isStroke, FS_ARGB *color)
 Get color of a page object. More...
 
FS_RESULT FSPDF_PageObject_GetClipRect (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_RECTF *clipRect)
 Get clip rectangle of a page object . More...
 
FS_RESULT FSPDF_PageObject_HasTransparency (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_BOOL *hasTransparency)
 Check whether a page object has transparency. More...
 
FS_RESULT FSPDF_PageObject_GetLayers (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_ARRAY *layerArray)
 Get all the layers which associate with specific page object. More...
 
FS_RESULT FSPDF_TextObject_GetTextState (FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, FSPDF_TEXTSTATE *textState)
 Get text states of a text object. More...
 
FS_RESULT FSPDF_TextObject_GetUnicodeString (FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, FSCRT_BSTR *unicodeStr)
 Get unicode string of a text object. More...
 
FS_RESULT FSPDF_PathObject_GetPathData (FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FSCRT_PATHDATA *pathData)
 Get of path data of a path object . More...
 
FS_RESULT FSPDF_PathObject_GetFillMode (FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_INT32 *fillMode)
 Get fill mode of a path object. More...
 
FS_RESULT FSPDF_PathObject_GetStrokeState (FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_BOOL *isStroke)
 Get stroke state of a path object. More...
 
FS_RESULT FSPDF_ImageObject_CloneBitmap (FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_BITMAP *bitmap)
 Clone a bitmap from an image object. More...
 
FS_RESULT FSPDF_ImageObject_GetColorSpace (FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FS_INT32 *colorspace)
 Get the color space for an image object. More...
 
FS_RESULT FSPDF_ImageObject_GetStream (FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSPDF_OBJECT *stream)
 Get the image stream of an image object. More...
 
FS_RESULT FSPDF_FormXObject_GetObjects (FSCRT_PAGE page, FSPDF_PAGEOBJECT formXObj, FSPDF_PAGEOBJECTS *pageObjs)
 Get page objects from a Form XObject object. More...
 
FS_RESULT FSPDF_FormXObject_GetStream (FSCRT_PAGE page, FSPDF_PAGEOBJECT formXObj, FSPDF_OBJECT *stream)
 Get the stream of a form XObject. More...
 
FS_RESULT FSPDF_ShadingObject_GetShading (FSCRT_PAGE page, FSPDF_PAGEOBJECT shadingObj, FSPDF_OBJECT *shadingPDFObj)
 Get the PDF shading dictionary or stream object of a shading page object. More...
 
FS_RESULT FSPDF_PageObject_CountClipPath (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 *count)
 Get count of path clip in a page object. More...
 
FS_RESULT FSPDF_PageObject_GetClipPath (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index, FSCRT_PATHDATA *pathData, FS_INT32 *fillMode)
 Get a path clip from a page object. More...
 
FS_RESULT FSPDF_PageObject_CountClipText (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 *count)
 Get count of text clip in a page object. More...
 
FS_RESULT FSPDF_PageObject_GetClipText (FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index, FSPDF_PAGEOBJECT *textObj)
 Get a text clip from a page object. More...
 

Detailed Description

Header file for PDF Page Objects module of Foxit PDF SDK.

Copyright (C) 2003-2016, Foxit Software Inc.. All Rights Reserved.

http://www.foxitsoftware.com

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 provides direct access to PDF page objects.
It contains:

  • 1. Get page and form XObject objects.
  • 2. Get a specific page object.
  • 3. Render page objects.
  • 4. Get page object common attributes.
  • 5. Get text object particular attributes.
  • 6. Get path object particular attributes.
  • 7. Get image object particular attributes.
  • 8. Get path clip.
  • 9. Get text clip.
Note
If you want to purchase Foxit PDF SDK license and use ANY of the following functions, please request for enabling Edit Add-on explicitly.

Foxit Corporation