Foxit PDF SDK
foxit::common Namespace Reference

Common namespace. More...

Namespaces

 file
 File namespace.
 

Classes

class  Barcode
 
class  Bitmap
 
class  Codec
 
class  Color
 
class  ColorSpace
 
class  DocEventCallback
 
class  Font
 
class  FontMapperCallback
 
class  FontMapResult
 
class  GraphState
 
class  Image
 
class  Library
 
class  NotifierCallback
 
class  Path
 
class  PathArray
 
class  Progressive
 
class  Range
 
class  RenderConfig
 
class  Renderer
 

Typedefs

typedef IFX_Pause PauseCallback
 

Enumerations

enum  Alignment { e_AlignmentLeft = 0, e_AlignmentCenter = 1, e_AlignmentRight = 2 }
 Enumeration for alignment (horizontal). More...
 
enum  ColorSpaceType {
  e_ColorSpaceInvalid = 0, e_ColorSpaceDeviceGray = 1, e_ColorSpaceDeviceRGB = 2, e_ColorSpaceDeviceCMYK = 3,
  e_ColorSpaceCalGray = 4, e_ColorSpaceCalRGB = 5, e_ColorSpaceLab = 6, e_ColorSpaceSeparation = 8,
  e_ColorSpaceDeviceN = 9, e_ColorSpacePattern = 11, e_ColorSpaceICCBasedDeviceGray = 12, e_ColorSpaceICCBasedDeviceRGB = 13,
  e_ColorSpaceICCBasedDeviceCMYK = 14
}
 Enumeration for color space. More...
 
enum  FileFormatType {
  e_FileFormatTypeFDF = 0, e_FileFormatTypeXFDF = 1, e_FileFormatTypeHTML = 2, e_FileFormatTypeXDP = 3,
  e_FileFormatTypeXML = 4, e_FileFormatTypeXFD = 5, e_FileFormatTypePDF = 6, e_FileFormatTypeTXT = 7
}
 Enumeration for file format type. More...
 
enum  FillMode { e_FillModeNone = 0, e_FillModeAlternate = 1, e_FillModeWinding = 2 }
 Enumeration for filling mode type, mainly for path graphics object. More...
 
enum  LocaleID {
  e_LocaleIDUnspecified = 0, e_LocaleIDHongKong = 1, e_LocaleIDTaiwan = 2, e_LocaleIDNetherlands = 3,
  e_LocaleIDFrance = 4, e_LocaleIDGermany = 5, e_LocaleIDItaly = 6, e_LocaleIDKorea = 7,
  e_LocaleIDJapan = 8
}
 Enumeration for locale ID. More...
 
enum  ModuleName {
  e_ModuleNameConnectedPDF = 1, e_ModuleNameXFA = 2, e_ModuleNameRedaction = 3, e_ModuleNameRMS = 4,
  e_ModuleNameOCR = 5, e_ModuleNameComparison = 6, e_ModuleNameCompliance = 7, e_ModuleNameOptimizer = 8,
  e_ModuleNameConversion = 9, e_ModuleNameLayoutRecognition = 10, e_ModuleNameAccessibility = 11, e_ModuleNameTableMaker = 12
}
 Enumeration for module name which is used in license information. More...
 
enum  Position {
  e_PosTopLeft = 0, e_PosTopCenter = 1, e_PosTopRight = 2, e_PosCenterLeft = 3,
  e_PosCenter = 4, e_PosCenterRight = 5, e_PosBottomLeft = 6, e_PosBottomCenter = 7,
  e_PosBottomRight = 8
}
 Enumeration for watermark position in a PDF page. More...
 
enum  Rotation {
  e_Rotation0 = 0, e_Rotation90 = 1, e_Rotation180 = 2, e_Rotation270 = 3,
  e_RotationUnknown = 4
}
 Enumeration for rotation. More...
 

Detailed Description

Common namespace.

Add-on namespace.

Typedef Documentation

◆ PauseCallback

This class represents a callback object used for pausing during a progressive process. All the pure virtual functions in this class are used as callback functions and should be implemented by user to do pausing in a customized way.

Enumeration Type Documentation

◆ Alignment

Enumeration for alignment (horizontal).

Values of this enumeration should be used alone.

Enumerator
e_AlignmentLeft 

Left alignment.

e_AlignmentCenter 

Center alignment.

e_AlignmentRight 

Right alignment.

◆ ColorSpaceType

Enumeration for color space.

Values of this enumeration should be used alone.

Enumerator
e_ColorSpaceInvalid 

Color space: Invalid.

e_ColorSpaceDeviceGray 

Color space: DeviceGray. (1 component, gray)

e_ColorSpaceDeviceRGB 

Color space: DeviceRGB. (3 components, R, G, B)

e_ColorSpaceDeviceCMYK 

Color space: DeviceCMYK. (4 components, C, M, Y, K)

e_ColorSpaceCalGray 

Color space: CalGray. (1 component, A)

e_ColorSpaceCalRGB 

Color space: CalRGB. (3 components, A, B, C)

e_ColorSpaceLab 

Color space: Lab. (3 components, A, B, C)

e_ColorSpaceSeparation 

Color space: Separation.

e_ColorSpaceDeviceN 

Color space: DeviceN.

e_ColorSpacePattern 

Color space: Pattern.

e_ColorSpaceICCBasedDeviceGray 

Color space: ICCBased DeviceGray. (1 component, gray)

e_ColorSpaceICCBasedDeviceRGB 

Color space: ICCBased DeviceRGB. (3 components, R, G, B)

e_ColorSpaceICCBasedDeviceCMYK 

Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)

◆ FileFormatType

Enumeration for file format type.

Values of this enumeration can be used alone.

Enumerator
e_FileFormatTypeFDF 

File format type: FDF.

e_FileFormatTypeXFDF 

File format type: XFDF.

e_FileFormatTypeHTML 

File format type: HTML.

e_FileFormatTypeXDP 

File format type: XDP.

e_FileFormatTypeXML 

File format type: XML.

e_FileFormatTypeXFD 

File format type: XFD.

e_FileFormatTypePDF 

File format type: PDF.

e_FileFormatTypeTXT 

File format type: TXT.

◆ FillMode

Enumeration for filling mode type, mainly for path graphics object.

Values of this enumeration should be used alone.

Enumerator
e_FillModeNone 

Fill mode: none.

e_FillModeAlternate 

Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polygon sides on each scan line.

e_FillModeWinding 

Winding fill mode, in which the system uses a direction in which a figure is drawn to determine whether to fill an area.

◆ LocaleID

Enumeration for locale ID.

Values of this enumeration can be used alone.

Enumerator
e_LocaleIDUnspecified 

Locale ID: Unspecified, used when locale is not specified.

e_LocaleIDHongKong 

Locale ID for region: HongKong.

e_LocaleIDTaiwan 

Locale ID for region: Taiwan.

e_LocaleIDNetherlands 

Locale ID for country: Netherlands.

e_LocaleIDFrance 

Locale ID for country: France.

e_LocaleIDGermany 

Locale ID for country: Germany.

e_LocaleIDItaly 

Locale ID for country: Italy.

e_LocaleIDKorea 

Locale ID for country: Korea.

e_LocaleIDJapan 

Locale ID for country: Japan.

◆ ModuleName

Enumeration for module name which is used in license information.

Values of this enumeration should be used alone.

Enumerator
e_ModuleNameConnectedPDF 

(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".

e_ModuleNameXFA 

Name for module "XFA".

e_ModuleNameRedaction 

Name for module "Redaction".

e_ModuleNameRMS 

Name for module "RMS".

e_ModuleNameOCR 

Name for module "OCR".

e_ModuleNameComparison 

Name for module "Comparison".

e_ModuleNameCompliance 

Name for module "Compliance".

e_ModuleNameOptimizer 

Name for module "Optimizer".

e_ModuleNameConversion 

Name for module "Conversion".

e_ModuleNameLayoutRecognition 

(Reserved, currently, this module is not provided) Name for module "LayoutRecognition".

e_ModuleNameAccessibility 

Name for module "Accessibility".

e_ModuleNameTableMaker 

Name for module "TableMaker".

◆ Position

Enumeration for watermark position in a PDF page.

Values of this enumeration should be used alone.

Enumerator
e_PosTopLeft 

Position: top left.

e_PosTopCenter 

Position: top center.

e_PosTopRight 

Position: top right.

e_PosCenterLeft 

Position center left.

e_PosCenter 

Position: center.

e_PosCenterRight 

Position: center right.

e_PosBottomLeft 

Position: bottom left.

e_PosBottomCenter 

Position: bottom center.

e_PosBottomRight 

Position: bottom right.

◆ Rotation

Enumeration for rotation.

Values of this enumeration should be used alone.

Enumerator
e_Rotation0 

No rotation.

e_Rotation90 

Rotate 90 degrees in clockwise direction.

e_Rotation180 

Rotate 180 degrees in clockwise direction.

e_Rotation270 

Rotate 270 degrees in clockwise direction.

e_RotationUnknown 

Unknown rotation.