29 class DocEventCallback;
30 class FontMapperCallback;
43 class AppProviderCallback;
51 #if defined(_SWIG_ANDROID_) || defined(_SWIG_JAVA_) 60 typedef enum _Rotation {
78 typedef enum _Alignment {
92 typedef enum _FillMode {
112 typedef enum _Position {
138 typedef enum _ModuleName {
164 typedef enum _ColorSpaceType {
195 #if defined(__ANDROID__) || defined(_JAVA_) 204 typedef enum _Rotation {
222 typedef enum _Alignment {
236 typedef enum _FillMode {
256 typedef enum _Position {
282 typedef enum _ModuleName {
308 typedef enum _ColorSpaceType {
344 typedef enum _Rotation {
362 typedef enum _Alignment {
376 typedef enum _FillMode {
396 typedef enum _Position {
422 typedef enum _ModuleName {
448 typedef enum _ColorSpaceType {
479 #define CommonDefines foxit::common 575 typedef enum _State {
721 #ifndef __EMSCRIPTEN_RENDER__ 876 #if defined(__ANDROID__) || defined(FS_IOS_) || defined(_SWIG_ANDROID_) || defined(_SWIG_IOS_) 885 static bool IsFipsMode();
930 static void*
Alloc(
size_t size);
939 static void Free(
void* ptr);
952 static void*
Realloc(
void* ptr,
size_t new_size);
964 static void SetLogFile(
const char* log_file_path);
976 static void SetLogFile(
const wchar_t* log_file_path);
1004 typedef enum _LineCapStyle {
1028 typedef enum _LineJoinStyle {
1270 typedef enum _Filter {
1287 explicit Range(
int index);
1425 typedef enum _Styles {
1451 typedef enum _Charset {
1489 typedef enum _CIDCharset {
1509 typedef enum _StandardID {
1545 typedef enum _FontTypes {
1587 Font(
const char* font_file_path,
int face_index,
Charset charset);
1598 Font(
const wchar_t* font_file_path,
int face_index,
Charset charset);
1705 #ifdef _FONT_GETWOFFDATA_ 1904 return !(*
this == other);
1989 typedef enum _PointType {
2227 typedef enum _RenderingIntent {
2469 #endif // FS_COMMON_H_ CID Font charset: Adobe-CNS1.
Definition: fs_common.h:1495
Definition: fs_annot.h:1461
Font style: non-symbolic.
Definition: fs_common.h:1435
FontMapResult()
Constructor.
Definition: fs_common.h:1840
Indicates that a line is drawn from the previous point to this point, and this point will also be con...
Definition: fs_common.h:1999
Miter line join type.
Definition: fs_common.h:1033
Name for module "Optimizer".
Definition: fs_common.h:438
Styles
Enumeration for font styles.
Definition: fs_common.h:1425
LineCapStyle line_cap
Line cap style.
Definition: fs_common.h:1171
Color & operator=(const Color &other)
Assign operator.
Standard font: Helvetica-Bold.
Definition: fs_common.h:1521
Font charset: Korean (Wansung).
Definition: fs_common.h:1461
Color space: Separation.
Definition: fs_common.h:464
Bevel line join type.
Definition: fs_common.h:1045
FloatArray dashes
A dash array that represents the dash patterns. Value of each element in this array should not be neg...
Definition: fs_common.h:1179
Position: center.
Definition: fs_common.h:406
Font charset: Japanese (Shift-JIS).
Definition: fs_common.h:1459
Definition: fs_common.h:1263
bool AppendEllipse(const RectF &rect)
Add an ellipse figure to the end of current path.
Standard font: Times-Bold.
Definition: fs_common.h:1529
static void SetRenderTextGamma(float gamma)
Set gamma value for text rendering.
Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polyg...
Definition: fs_common.h:383
CID Font charset: Unknown.
Definition: fs_common.h:1491
static void Release()
Release all resource allocated by Foxit PDF SDK Library.
int GetRateOfProgress()
Get the rate of current progress.
Position: bottom right.
Definition: fs_common.h:414
Definition: fs_common.h:486
Color ConvertToCMYK(ColorSpace::RenderingIntent intent=ColorSpace::e_RenderIntentRelColorimetric) const
Convert to a CMYK color.
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:396
Definition: fs_common.h:1837
Color ConvertToRGB(ColorSpace::RenderingIntent intent=ColorSpace::e_RenderIntentRelColorimetric) const
Convert to a RGB color.
Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to h...
Definition: fs_common.h:1019
Definition: fs_common.h:2217
bool IsStandardFont(const pdf::PDFDoc &document)
Check whether current font is a standard font.
PointType GetPointType(int index)
Get the type of a point specified by index.
CFX_Object Object
Object type.
Definition: fs_basictypes.h:219
IFX_Pause PauseCallback
Definition: fs_common.h:1187
Color space: CalGray. (1 component, A)
Definition: fs_common.h:458
CID Font charset: Adobe-Japan1.
Definition: fs_common.h:1497
Definition: fs_common.h:634
Round line join type.
Definition: fs_common.h:1039
virtual FontMapResult MapFont(const char *font_name, bool is_truetype, uint32 styles, int weight, int italic_angle, Font::Charset charset)=0
A callback function used to map a suitable font according to input parameters.
Standard font: Times-BoldItalic.
Definition: fs_common.h:1531
GraphState(float line_width, LineJoinStyle line_join, float miter_limit, LineCapStyle line_cap, float dash_phase, const FloatArray &dashes)
Constructor, with parameters.
Definition: fs_common.h:1062
Font(const wchar_t *name, uint32 styles, Charset charset, int weight)
Constructor, with given attribute.
Unknown rotation.
Definition: fs_common.h:354
Rendering intent: Relative Colorimetric.
Definition: fs_common.h:2231
bool IsBold() const
Judge whether current font is bold or not.
static bool SetFontMapperCallback(FontMapperCallback *callback)
Set a FontMapperCallback object to Foxit PDF SDK.
static String Base64Encode(const void *data_buffer, size_t length)
Encode the source data buffer by Base64 algorithm.
bool operator==(const Color &other) const
Equal operator.
bool operator !=(const Path &other) const
Not equal operator.
Color space: DeviceGray. (1 component, gray)
Definition: fs_common.h:452
Only odd numbers in a range will be used (discards even numbers).
Definition: fs_common.h:1276
void Set(float line_width, LineJoinStyle line_join, float miter_limit, LineCapStyle line_cap, float dash_phase, const FloatArray &dashes)
Set value.
Definition: fs_common.h:1129
Range & operator=(const Range &other)
Assign operator.
PointF GetPoint(int index)
Get a point specified by index.
int GetComponentCount() const
Get the count of components.
bool CloseFigure()
Close current figure (which is also the last figure in current path).
Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint an...
Definition: fs_common.h:1014
CID Font charset: Adobe-GB1.
Definition: fs_common.h:1493
bool operator !=(const FontMapResult &other) const
Not equal operator.
Definition: fs_common.h:1903
Definition: fx_coordinates.h:30
static bool RegisterSignatureCallback(const char *filter, const char *sub_filter, pdf::SignatureCallback *signature_callback)
Register a third-party pdf::SignatureCallback object to Foxit PDF SDK for signing and verifying signa...
Rotate 180 degrees in clockwise direction.
Definition: fs_common.h:350
Name for module "OCR".
Definition: fs_common.h:432
bool IsSupportEmbedded(const pdf::PDFDoc &document)
Check whether current font is supported to be embedded to the specified PDF document or not.
CID Font charset: Unicode.
Definition: fs_common.h:1501
void SetValue(const FloatArray &component_array)
Set component value array.
RenderingIntent
Enumeration for rendering intent.
Definition: fs_common.h:2227
bool MoveTo(const PointF &point)
Add a point to the end of current path, to start a new figure.
Font style: all cap.
Definition: fs_common.h:1439
Filter
Enumeration for range filter.
Definition: fs_common.h:1270
void IncreasePointCount(int count)
Increase the point count and prepare adequate memory for these new points.
int GetSegmentCount() const
Get the count of range segments.
Header file for file operation related definitions and functions.
bool operator==(const Range &other) const
Equal operator.
File reading interface.
Definition: fx_stream.h:566
Color space: DeviceRGB. (3 components, R, G, B)
Definition: fs_common.h:454
void Clear()
Clear all points.
FloatArray GetValue() const
Get component value array.
CIDCharset
Enumeration for CID font charset.
Definition: fs_common.h:1489
ColorSpace & operator=(const ColorSpace &other)
Assign operator.
WIDE STRING CLASS.
Definition: fx_string.h:1452
GraphState(const GraphState &state)
Constructor, with another graph state object.
Definition: fs_common.h:1088
State
Enumeration for progress state.
Definition: fs_common.h:575
Font type: TrueType.
Definition: fs_common.h:1549
static void RegisterXFAAppProviderCallback(addon::xfa::AppProviderCallback *callback)
Register an addon::xfa::AppProviderCallback object to Foxit PDF SDK.
Rendering intent: Saturation.
Definition: fs_common.h:2233
Standard font: Helvetica.
Definition: fs_common.h:1519
Position: top right.
Definition: fs_common.h:402
Definition: fs_common.h:1194
foxit::common::file::ReaderCallback * file_read
A common::file::ReaderCallback object which is implemented by user. Foxit PDF SDK will use this callb...
Definition: fs_common.h:1929
Indicates that the point is the first point of a figure.
Definition: fs_common.h:1991
bool operator==(const FontMapResult &other) const
Equal operator.
Definition: fs_common.h:1890
LineCapStyle
Enumeration for line cap style.
Definition: fs_common.h:1004
Font style: script.
Definition: fs_common.h:1433
static ErrorCode Reinitialize()
Reinitialize Foxit PDF SDK Library.
static bool RegisterSecurityCallback(const char *filter, pdf::SecurityCallback *callback)
Register a pdf::SecurityCallback object to Foxit PDF SDK for decryption of the PDFs with special encr...
Definition: fs_pdfdoc.h:389
static bool SetCacheSize(uint32 size)
Set the upper limit of PDF library cache size.
Color space: DeviceCMYK. (4 components, C, M, Y, K)
Definition: fs_common.h:456
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_common.h:2355
static ErrorCode Initialize(const char *sn, const char *key)
Initialize Foxit PDF SDK Library, with valid license information.
foxit::uint32 GetStyles(const pdf::PDFDoc &document)
Get font styles.
bool operator!=(const ColorSpace &other) const
Not equal operator.
Font style: italic.
Definition: fs_common.h:1437
Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)
Definition: fs_common.h:474
FontMapResult(const FontMapResult &other)
Constructor, with another font mapping result object.
Definition: fs_common.h:1865
Progressive(const Progressive &other)
Constructor, with another progressive object.
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_common.h:1950
FontTypes
Enumeration for font type.
Definition: fs_common.h:1545
static bool SetAnnotIconProviderCallback(pdf::annots::IconProviderCallback *annot_icon_provider)
Set a customized pdf::annots::IconProviderCallback object to Foxit PDF SDK.
Progress state: progress needs to be continued.
Definition: fs_common.h:579
GraphState()
Constructor.
Definition: fs_common.h:1073
Position: bottom center.
Definition: fs_common.h:412
bool IsEmbedded(const pdf::PDFDoc &document)
Judge whether current font is embedded in a specified PDF document or not.
int GetSegmentEnd(int segment_index) const
Get the end index of a specified range segment.
Definition: fs_signature.h:1270
void Transform(const Matrix &matrix)
Transform all points in current path with a given matrix.
(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".
Definition: fs_common.h:424
~Progressive()
Destructor.
bool operator!=(const Color &other) const
Not equal operator.
Font style: serif.
Definition: fs_common.h:1429
Indicates that a line is drawn from the previous point to this point.
Definition: fs_common.h:1993
Name for module "Conversion".
Definition: fs_common.h:440
Color space: ICCBased DeviceGray. (1 component, gray)
Definition: fs_common.h:470
Header file for basic types definitions.
LineJoinStyle line_join
Line join style.
Definition: fs_common.h:1153
Position center left.
Definition: fs_common.h:404
Definition: fs_actioncallback.h:142
ColorSpaceType
Enumeration for color space.
Definition: fs_common.h:448
static void SetLogFile(const char *log_file_path)
Set the log file path.
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
Only even numbers in a range will be used (discards odd numbers).
Definition: fs_common.h:1274
virtual void OnDocSaved(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is saved.
Definition: fs_common.h:1250
Font charset: Traditional Chinese.
Definition: fs_common.h:1465
bool operator==(const ColorSpace &other) const
Equal operator.
Font charset: ANSI (United States, Western Europe).
Definition: fs_common.h:1453
static String FlateDecompress(const void *compressed_data_buffer, size_t length)
Decompress the compressed data buffer by DEFLATE algorithm.
Butt cap. The stroke is squared off at the endpoint of a path. There is no projection beyond the end ...
Definition: fs_common.h:1009
Position: center right.
Definition: fs_common.h:408
virtual void Release()=0
A callback function used to release current callback object itself.
String GetBaseFontName(const pdf::PDFDoc &document)
Get base font name.
int GetSegmentStart(int segment_index) const
Get the start index of a specified range segment.
Font charset: Standard symbols.
Definition: fs_common.h:1457
Color space: ICCBased DeviceRGB. (3 components, R, G, B)
Definition: fs_common.h:472
CIDCharset GetCIDCharset(const pdf::PDFDoc &document)
Get CID font charset.
Font style: force bold.
Definition: fs_common.h:1443
FillMode
Enumeration for filling mode type, mainly for path graphics object.
Definition: fs_common.h:376
static void * Realloc(void *ptr, size_t new_size)
Reallocate a memory block.
Name for module "Compliance".
Definition: fs_common.h:436
bool IsEmpty() const
Check whether current object is empty or not.
static bool HasModuleLicenseRight(common::ModuleName module_name)
Check if user has right to use a specified module of Foxit PDF SDK in current used license informatio...
FontMapResult & operator=(const FontMapResult &other)
Assign operator.
Definition: fs_common.h:1877
Font style: symbolic.
Definition: fs_common.h:1431
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fx_basic.h:3752
Definition: fs_common.h:996
int GetDescent() const
Get the descent value, in 1/1000 of em size (PDF units).
bool CubicBezierTo(const PointF &point1, const PointF &point2, const PointF &point3)
Add a cubic bezier spline to the end of current figure, by three points: two control points and one t...
Standard font: Courier-BoldOblique, Bold italic.
Definition: fs_common.h:1515
virtual void Release()=0
A callback function used to release current callback object itself.
Definition: fs_common.h:1982
bool operator==(const Path &other) const
Equal operator.
Font charset: Arabic.
Definition: fs_common.h:1479
foxit::common::ColorSpaceType GetColorSpaceType() const
Get color space type.
LineJoinStyle
Enumeration for line join style.
Definition: fs_common.h:1028
static String FlateCompress(const void *data_buffer, size_t length)
Compress the source data buffer by DEFLATE algorithm.
Font charset: System default, for unknown or mapping purpose.
Definition: fs_common.h:1455
Definition: fs_common.h:568
float line_width
Line width.
Definition: fs_common.h:1145
Winding fill mode, in which the system uses a direction in which a figure is drawn to determine wheth...
Definition: fs_common.h:388
Name for module "XFA".
Definition: fs_common.h:426
Font type: CID font.
Definition: fs_common.h:1553
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
Color space: DeviceN.
Definition: fs_common.h:466
virtual void OnDocOpened(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is opened.
Definition: fs_common.h:1220
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
virtual void OnDocWillOpen()
Triggered when the document will be opened.
Definition: fs_common.h:1208
static bool SetDocEventCallback(DocEventCallback *callback)
Set a DocEventCallback object to Foxit PDF SDK.
Font charset: Russian.
Definition: fs_common.h:1471
bool SetPoint(int index, const PointF &point, PointType type)
Change the value and type of a point specified by index.
static String Base64Decode(const void *encoded_data_buffer, size_t length)
Decode the encoded data buffer by Base64 algorithm.
bool LineTo(const PointF &point)
Add a point to the end of current figure, and a line is to be drawn from current point to the new poi...
Progressive & operator=(const Progressive &other)
Assign operator.
static bool UnregisterSecurityCallback(const char *filter)
Unregister a pdf::SecurityCallback object from Foxit PDF SDK.
int face_index
Face index. This is a zero-based index value:
Definition: fs_common.h:1939
Definition: fx_coordinates.h:596
Rendering intent: Perceptual.
Definition: fs_common.h:2229
Color()
Construct an empty color.
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:362
virtual void OnDocWillSave(const pdf::PDFDoc &document)
Triggered when a PDF document will be saved.
Definition: fs_common.h:1238
static bool SetActionCallback(ActionCallback *action_callback)
Set a foxit::ActionCallback object to Foxit PDF SDK, in aid of performing PDF actions.
static bool EnableJavaScript(bool enable_javascript)
Enable or disable javascript for PDF.
State Continue()
Continue the progressive process.
Definition: fs_basictypes.h:399
bool operator==(const Font &other) const
Equal operator.
ModuleName
Enumeration for module name which is used in license information.
Definition: fs_common.h:422
Font type: Type3.
Definition: fs_common.h:1551
Standard font: ZapfDingbats.
Definition: fs_common.h:1537
Standard font: Helvetica-Oblique, Italic.
Definition: fs_common.h:1525
Definition: fs_security.h:1226
void RemoveAll()
Remove all range segments.
int GetPointCount()
Get the count of points.
static String GetVersion()
Get the version of current Foxit PDF SDK library.
Indicates that this point is the ending point for a Bezier spline, and this point will also be connec...
Definition: fs_common.h:2007
Standard font: Times-Roman.
Definition: fs_common.h:1527
Font Embed(pdf::PDFDoc document)
Embed current font to the specified PDF document.
bool operator !=(const Range &other) const
Not equal operator.
WString GetName()
Retrieve the postscript name.
Standard font: Symbol.
Definition: fs_common.h:1535
Rotate 270 degrees in clockwise direction.
Definition: fs_common.h:352
Position: bottom left.
Definition: fs_common.h:410
Font style: fixed pitch.
Definition: fs_common.h:1427
Font charset: Simplified Chinese.
Definition: fs_common.h:1463
Color space: Pattern.
Definition: fs_common.h:468
Standard font: Times-Italic.
Definition: fs_common.h:1533
Color ConvertColor(const Color &color)
Convert input color to the color in current color space.
Definition: fs_common.h:1418
Color space: Lab. (3 components, A, B, C)
Definition: fs_common.h:462
Name for module "Redaction".
Definition: fs_common.h:428
Color space: Invalid.
Definition: fs_common.h:450
Fill mode: none.
Definition: fs_common.h:378
Center alignment.
Definition: fs_common.h:366
No rotation.
Definition: fs_common.h:346
Rotation
Enumeration for rotation.
Definition: fs_common.h:344
FontTypes GetFontType(const pdf::PDFDoc &document)
Get font type.
Foxit namespace.
Definition: fs_compare.h:27
Left alignment.
Definition: fs_common.h:364
Color space: CalRGB. (3 components, A, B, C)
Definition: fs_common.h:460
Definition: fs_common.h:537
void AddSingle(int index)
Add an index as a new range segment.
Name for module "Comparison".
Definition: fs_common.h:434
float dash_phase
Dash phase for dash pattern.
Definition: fs_common.h:1174
StandardID
Enumeration for standard font ID.
Definition: fs_common.h:1509
All the indexes within a range will be used.
Definition: fs_common.h:1272
BYTE STRING CLASS.
Definition: fx_string.h:317
Progress state: progress is finished.
Definition: fs_common.h:581
Font charset: Hebrew.
Definition: fs_common.h:1477
Charset
Enumeration for font charset.
Definition: fs_common.h:1451
static void Free(void *ptr)
Free a memory block.
Font style: small cap.
Definition: fs_common.h:1441
Font charset: Greek.
Definition: fs_common.h:1473
Font type: Type1.
Definition: fs_common.h:1547
Rotate 90 degrees in clockwise direction.
Definition: fs_common.h:348
virtual void Release()=0
A callback function used to release current callback object itself.
float GetCharWidth(uint32 unicode) const
Get the width (in 1/1000 of em size (PDF units)) of a character specified by unicode.
Standard font: Helvetica-BoldOblique, Bold italic.
Definition: fs_common.h:1523
static void * Alloc(size_t size)
Allocate a memory block.
bool IsEmpty() const
Check whether current object is empty or not.
Font charset: Baltic.
Definition: fs_common.h:1481
Standard font: Courier.
Definition: fs_common.h:1511
GraphState & operator=(const GraphState &state)
Assign operator.
Definition: fs_common.h:1104
Font charset: Turkish.
Definition: fs_common.h:1475
FontMapResult(foxit::common::file::ReaderCallback *file_read, int face_index)
Constructor, with parameters.
Definition: fs_common.h:1855
Progress state: any error occurs.
Definition: fs_common.h:577
#define NULL
The null-pointer value.
Definition: fx_system.h:767
virtual void OnDocWillDestroy(const pdf::PDFDoc &document)
Triggered when a PDF document will be destroyed.
Definition: fs_common.h:1229
Definition: fx_coordinates.h:1076
Font charset: Eastern European.
Definition: fs_common.h:1469
Path & operator=(const Path &other)
Assign operator.
StandardID GetStandard14Font(const pdf::PDFDoc &document)
Get standard font ID.
RectI GetCharBBox(uint32 unicode) const
Get the bounding box of a character specified by unicode.
Right alignment.
Definition: fs_common.h:368
int GetAscent() const
Get the ascent value, in 1/1000 of em size (PDF units).
Indicates that this point is a control point or ending point for a Bezier spline.
Definition: fs_common.h:2001
Rendering intent: Absolute Colorimetric.
Definition: fs_common.h:2235
bool RemovePoint(int index)
Remove a point specified by index.
Position: top left.
Definition: fs_common.h:398
Font & operator=(const Font &other)
Assign operator.
Position: top center.
Definition: fs_common.h:400
bool IsItalic() const
Judge whether current font object is italic or not.
PointType
Enumeration for point type in path.
Definition: fs_common.h:1989
ColorSpace GetColorSpace()
Get the color space that current color belongs to.
Standard font: Courier-Oblique, Italic.
Definition: fs_common.h:1517
~GraphState()
Destructor.
Definition: fs_common.h:1081
Standard font: Courier-Bold.
Definition: fs_common.h:1513
void AddSegment(int start_index, int end_index, Filter filter=e_All)
Add a new range segment. (Reverse ordering is legal.)
virtual void OnOutOfMemory()=0
A callback function used to notify application when Foxit PDF SDK runs out of memory.
Font charset: Thai.
Definition: fs_common.h:1467
CID Font charset: Adobe-Korea1.
Definition: fs_common.h:1499
void Set(foxit::common::file::ReaderCallback *file_read, int face_index)
Set value.
Definition: fs_common.h:1920
String GetFamilyName()
Retrieve the famliy name.
bool operator !=(const Font &other) const
Not equal operator.
static bool SetNotifierCallback(NotifierCallback *notifier)
Set a NotifierCallback object to Foxit PDF SDK.
Name for module "RMS".
Definition: fs_common.h:430
bool AppendRect(const RectF &rect)
Add a rectangle figure to the end of current path.
Definition: fx_coordinates.h:771
float miter_limit
The miter limit for line join.
Definition: fs_common.h:1163