29 class DocEventCallback;
30 class FontMapperCallback;
42 class AppProviderCallback;
50 #if defined(_SWIG_ANDROID_) || defined(_SWIG_JAVA_) 59 typedef enum _Rotation {
77 typedef enum _Alignment {
91 typedef enum _FillMode {
111 typedef enum _Position {
137 typedef enum _ModuleName {
160 #if defined(__ANDROID__) || defined(_JAVA_) 169 typedef enum _Rotation {
187 typedef enum _Alignment {
201 typedef enum _FillMode {
221 typedef enum _Position {
247 typedef enum _ModuleName {
275 typedef enum _Rotation {
293 typedef enum _Alignment {
307 typedef enum _FillMode {
327 typedef enum _Position {
353 typedef enum _ModuleName {
376 #define CommonDefines foxit::common 472 typedef enum _State {
618 #ifndef __EMSCRIPTEN_RENDER__ 773 #if defined(__ANDROID__) || defined(FS_IOS_) || defined(_SWIG_ANDROID_) || defined(_SWIG_IOS_) 782 static bool IsFipsMode();
827 static void*
Alloc(
size_t size);
836 static void Free(
void* ptr);
849 static void*
Realloc(
void* ptr,
size_t new_size);
861 static void SetLogFile(
const char* log_file_path);
873 static void SetLogFile(
const wchar_t* log_file_path);
901 typedef enum _LineCapStyle {
925 typedef enum _LineJoinStyle {
1164 typedef enum _Filter {
1181 explicit Range(
int index);
1319 typedef enum _Styles {
1345 typedef enum _Charset {
1383 typedef enum _CIDCharset {
1403 typedef enum _StandardID {
1439 typedef enum _FontTypes {
1481 Font(
const char* font_file_path,
int face_index,
Charset charset);
1492 Font(
const wchar_t* font_file_path,
int face_index,
Charset charset);
1599 #ifdef _FONT_GETWOFFDATA_ 1798 return !(*
this == other);
1883 typedef enum _PointType {
2110 #endif // FS_COMMON_H_ CID Font charset: Adobe-CNS1.
Definition: fs_common.h:1389
Definition: fs_annot.h:1444
Font style: non-symbolic.
Definition: fs_common.h:1329
FontMapResult()
Constructor.
Definition: fs_common.h:1734
Indicates that a line is drawn from the previous point to this point, and this point will also be con...
Definition: fs_common.h:1893
Miter line join type.
Definition: fs_common.h:930
Name for module "Optimizer".
Definition: fs_common.h:369
Styles
Enumeration for font styles.
Definition: fs_common.h:1319
LineCapStyle line_cap
Line cap style.
Definition: fs_common.h:1068
Standard font: Helvetica-Bold.
Definition: fs_common.h:1415
Font charset: Korean (Wansung).
Definition: fs_common.h:1355
Bevel line join type.
Definition: fs_common.h:942
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:1076
Position: center.
Definition: fs_common.h:337
Font charset: Japanese (Shift-JIS).
Definition: fs_common.h:1353
Definition: fs_common.h:1157
bool AppendEllipse(const RectF &rect)
Add an ellipse figure to the end of current path.
Standard font: Times-Bold.
Definition: fs_common.h:1423
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:314
CID Font charset: Unknown.
Definition: fs_common.h:1385
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:345
Definition: fs_common.h:383
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:327
Definition: fs_common.h:1731
Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to h...
Definition: fs_common.h:916
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:1084
CID Font charset: Adobe-Japan1.
Definition: fs_common.h:1391
Definition: fs_common.h:531
Round line join type.
Definition: fs_common.h:936
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.
bool operator!=(const Font &other) const
Not equal operator.
Standard font: Times-BoldItalic.
Definition: fs_common.h:1425
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:959
Unknown rotation.
Definition: fs_common.h:285
bool IsBold() const
Judge whether current font is bold or not.
static bool SetFontMapperCallback(FontMapperCallback *callback)
Set a FontMapperCallback object to Foxit PDF SDK.
bool operator!=(const Path &other) const
Not equal operator.
static String Base64Encode(const void *data_buffer, size_t length)
Encode the source data buffer by Base64 algorithm.
Only odd numbers in a range will be used (discards even numbers).
Definition: fs_common.h:1170
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:1026
Range & operator=(const Range &other)
Assign operator.
PointF GetPoint(int index)
Get a point specified by index.
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:911
CID Font charset: Adobe-GB1.
Definition: fs_common.h:1387
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:281
Name for module "OCR".
Definition: fs_common.h:363
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:1395
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:1333
Filter
Enumeration for range filter.
Definition: fs_common.h:1164
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:555
void Clear()
Clear all points.
CIDCharset
Enumeration for CID font charset.
Definition: fs_common.h:1383
WIDE STRING CLASS.
Definition: fx_string.h:1459
GraphState(const GraphState &state)
Constructor, with another graph state object.
Definition: fs_common.h:985
State
Enumeration for progress state.
Definition: fs_common.h:472
Font type: TrueType.
Definition: fs_common.h:1443
static void RegisterXFAAppProviderCallback(addon::xfa::AppProviderCallback *callback)
Register an addon::xfa::AppProviderCallback object to Foxit PDF SDK.
Standard font: Helvetica.
Definition: fs_common.h:1413
Position: top right.
Definition: fs_common.h:333
Definition: fs_common.h:1091
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:1823
Indicates that the point is the first point of a figure.
Definition: fs_common.h:1885
bool operator==(const FontMapResult &other) const
Equal operator.
Definition: fs_common.h:1784
LineCapStyle
Enumeration for line cap style.
Definition: fs_common.h:901
Font style: script.
Definition: fs_common.h:1327
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:347
static bool SetCacheSize(uint32 size)
Set the upper limit of PDF library cache size.
bool operator!=(const FontMapResult &other) const
Not equal operator.
Definition: fs_common.h:1797
bool IsEmpty() const
Check whether current object is empty or not.
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.
Font style: italic.
Definition: fs_common.h:1331
FontMapResult(const FontMapResult &other)
Constructor, with another font mapping result object.
Definition: fs_common.h:1759
Progressive(const Progressive &other)
Constructor, with another progressive object.
Definition: fs_common.h:1844
FontTypes
Enumeration for font type.
Definition: fs_common.h:1439
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:476
GraphState()
Constructor.
Definition: fs_common.h:970
Position: bottom center.
Definition: fs_common.h:343
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:951
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:355
~Progressive()
Destructor.
Font style: serif.
Definition: fs_common.h:1323
Indicates that a line is drawn from the previous point to this point.
Definition: fs_common.h:1887
Name for module "Conversion".
Definition: fs_common.h:371
Header file for basic types definitions.
LineJoinStyle line_join
Line join style.
Definition: fs_common.h:1050
Position center left.
Definition: fs_common.h:335
Definition: fs_actioncallback.h:142
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:1168
virtual void OnDocSaved(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is saved.
Definition: fs_common.h:1147
Font charset: Traditional Chinese.
Definition: fs_common.h:1359
Font(const wchar_t *name, uint32 styles, Charset charset, int weight=0)
Constructor, with given attribute.
Font charset: ANSI (United States, Western Europe).
Definition: fs_common.h:1347
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:906
Position: center right.
Definition: fs_common.h:339
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:1351
CIDCharset GetCIDCharset(const pdf::PDFDoc &document)
Get CID font charset.
Font style: force bold.
Definition: fs_common.h:1337
FillMode
Enumeration for filling mode type, mainly for path graphics object.
Definition: fs_common.h:307
static void * Realloc(void *ptr, size_t new_size)
Reallocate a memory block.
Name for module "Compliance".
Definition: fs_common.h:367
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:1771
Font style: symbolic.
Definition: fs_common.h:1325
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fx_basic.h:3736
Definition: fs_common.h:893
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:1409
virtual void Release()=0
A callback function used to release current callback object itself.
Definition: fs_common.h:1876
bool operator==(const Path &other) const
Equal operator.
Font charset: Arabic.
Definition: fs_common.h:1373
LineJoinStyle
Enumeration for line join style.
Definition: fs_common.h:925
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:1349
Definition: fs_common.h:465
float line_width
Line width.
Definition: fs_common.h:1042
Winding fill mode, in which the system uses a direction in which a figure is drawn to determine wheth...
Definition: fs_common.h:319
Name for module "XFA".
Definition: fs_common.h:357
Font type: CID font.
Definition: fs_common.h:1447
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:198
virtual void OnDocOpened(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is opened.
Definition: fs_common.h:1117
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:216
virtual void OnDocWillOpen()
Triggered when the document will be opened.
Definition: fs_common.h:1105
static bool SetDocEventCallback(DocEventCallback *callback)
Set a DocEventCallback object to Foxit PDF SDK.
Font charset: Russian.
Definition: fs_common.h:1365
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.
bool operator!=(const Range &other) const
Not equal 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:1833
Definition: fx_coordinates.h:590
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:293
virtual void OnDocWillSave(const pdf::PDFDoc &document)
Triggered when a PDF document will be saved.
Definition: fs_common.h:1135
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:375
bool operator==(const Font &other) const
Equal operator.
ModuleName
Enumeration for module name which is used in license information.
Definition: fs_common.h:353
Font type: Type3.
Definition: fs_common.h:1445
Standard font: ZapfDingbats.
Definition: fs_common.h:1431
Standard font: Helvetica-Oblique, Italic.
Definition: fs_common.h:1419
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:1901
Standard font: Times-Roman.
Definition: fs_common.h:1421
Font Embed(pdf::PDFDoc document)
Embed current font to the specified PDF document.
WString GetName()
Retrieve the postscript name.
Standard font: Symbol.
Definition: fs_common.h:1429
Rotate 270 degrees in clockwise direction.
Definition: fs_common.h:283
Position: bottom left.
Definition: fs_common.h:341
Font style: fixed pitch.
Definition: fs_common.h:1321
Font charset: Simplified Chinese.
Definition: fs_common.h:1357
Standard font: Times-Italic.
Definition: fs_common.h:1427
Definition: fs_common.h:1312
Name for module "Redaction".
Definition: fs_common.h:359
Fill mode: none.
Definition: fs_common.h:309
Center alignment.
Definition: fs_common.h:297
No rotation.
Definition: fs_common.h:277
Rotation
Enumeration for rotation.
Definition: fs_common.h:275
FontTypes GetFontType(const pdf::PDFDoc &document)
Get font type.
Foxit namespace.
Definition: fs_compare.h:27
Left alignment.
Definition: fs_common.h:295
Definition: fs_common.h:434
void AddSingle(int index)
Add an index as a new range segment.
Name for module "Comparison".
Definition: fs_common.h:365
float dash_phase
Dash phase for dash pattern.
Definition: fs_common.h:1071
StandardID
Enumeration for standard font ID.
Definition: fs_common.h:1403
All the indexes within a range will be used.
Definition: fs_common.h:1166
BYTE STRING CLASS.
Definition: fx_string.h:317
Progress state: progress is finished.
Definition: fs_common.h:478
Font charset: Hebrew.
Definition: fs_common.h:1371
Charset
Enumeration for font charset.
Definition: fs_common.h:1345
static void Free(void *ptr)
Free a memory block.
Font style: small cap.
Definition: fs_common.h:1335
Font charset: Greek.
Definition: fs_common.h:1367
Font type: Type1.
Definition: fs_common.h:1441
Rotate 90 degrees in clockwise direction.
Definition: fs_common.h:279
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:1417
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:1375
Standard font: Courier.
Definition: fs_common.h:1405
GraphState & operator=(const GraphState &state)
Assign operator.
Definition: fs_common.h:1001
Font charset: Turkish.
Definition: fs_common.h:1369
FontMapResult(foxit::common::file::ReaderCallback *file_read, int face_index)
Constructor, with parameters.
Definition: fs_common.h:1749
Progress state: any error occurs.
Definition: fs_common.h:474
#define NULL
The null-pointer value.
Definition: fx_system.h:771
virtual void OnDocWillDestroy(const pdf::PDFDoc &document)
Triggered when a PDF document will be destroyed.
Definition: fs_common.h:1126
Definition: fx_coordinates.h:1056
Font charset: Eastern European.
Definition: fs_common.h:1363
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:299
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:1895
bool RemovePoint(int index)
Remove a point specified by index.
Position: top left.
Definition: fs_common.h:329
Font & operator=(const Font &other)
Assign operator.
Position: top center.
Definition: fs_common.h:331
bool IsItalic() const
Judge whether current font object is italic or not.
PointType
Enumeration for point type in path.
Definition: fs_common.h:1883
Standard font: Courier-Oblique, Italic.
Definition: fs_common.h:1411
~GraphState()
Destructor.
Definition: fs_common.h:978
Standard font: Courier-Bold.
Definition: fs_common.h:1407
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:1361
CID Font charset: Adobe-Korea1.
Definition: fs_common.h:1393
void Set(foxit::common::file::ReaderCallback *file_read, int face_index)
Set value.
Definition: fs_common.h:1814
String GetFamilyName()
Retrieve the famliy name.
static bool SetNotifierCallback(NotifierCallback *notifier)
Set a NotifierCallback object to Foxit PDF SDK.
Name for module "RMS".
Definition: fs_common.h:361
bool AppendRect(const RectF &rect)
Add a rectangle figure to the end of current path.
Definition: fx_coordinates.h:766
float miter_limit
The miter limit for line join.
Definition: fs_common.h:1060