Foxit PDF SDK

fs_common.h
Go to the documentation of this file.
1
15 #ifndef FS_COMMON_H_
16 #define FS_COMMON_H_
17
18 #include "common/fs_basictypes.h"
19 #include "common/file/fs_file.h"
20
26 namespace foxit {
27 class ActionCallback;
28 namespace common {
29 class DocEventCallback;
30 class FontMapperCallback;
31 class Color;
32 } // namespace common
33 namespace pdf {
34 namespace annots {
35 class IconProviderCallback;
36 } // namespace annots
37 class PDFDoc;
38 class SignatureCallback;
39 class SecurityCallback;
40 class TimeStampCallback;
41 } // namespace pdf
42 namespace addon {
43 namespace xfa {
44 class AppProviderCallback;
45 } // namespace xfa
46 } // namespace addon
47
51 namespace common {
57 typedef enum _Rotation {
59 e_Rotation0 = 0,
61 e_Rotation90 = 1,
63 e_Rotation180 = 2,
65 e_Rotation270 = 3,
67 e_RotationUnknown = 4
68 } Rotation;
69
76 typedef enum _RotationPointOptions {
78 e_RotationPointCenter = 0,
80 e_RotationPointLeftTop = 1,
82 e_RotationPointRightTop = 2,
84 e_RotationPointLeftBottom = 3,
86 e_RotationPointRightBottom = 4
87 } RotationPointOptions;
88
94 typedef enum _Alignment {
96 e_AlignmentLeft = 0,
98 e_AlignmentCenter = 1,
100 e_AlignmentRight = 2
101 } Alignment;
102
108 typedef enum _FillMode {
110 e_FillModeNone = 0,
115 e_FillModeAlternate= 1,
120 e_FillModeWinding = 2
121 } FillMode;
122
128 typedef enum _Position {
130 e_PosTopLeft = 0,
132 e_PosTopCenter = 1,
134 e_PosTopRight = 2,
136 e_PosCenterLeft = 3,
138 e_PosCenter = 4,
140 e_PosCenterRight = 5,
142 e_PosBottomLeft = 6,
144 e_PosBottomCenter = 7,
146 e_PosBottomRight = 8
147 } Position;
148
154 typedef enum _ModuleName {
156 e_ModuleNameConnectedPDF = 1,
158 e_ModuleNameXFA = 2,
160 e_ModuleNameRedaction = 3,
162 e_ModuleNameRMS = 4,
164 e_ModuleNameOCR = 5,
166 e_ModuleNameComparison = 6,
168 e_ModuleNameCompliance = 7,
170 e_ModuleNameOptimizer = 8,
172 e_ModuleNameConversion = 9,
174 e_ModuleNameLayoutRecognition = 10,
176 e_ModuleNameAccessibility = 11,
178 e_ModuleNameTableMaker = 12,
180 e_ModuleNameDWG2PDF = 13,
182 e_ModuleNameAdvEdit = 14,
184 e_ModuleNamePDF2Office = 15,
186 e_ModuleName3D = 16,
188 e_ModuleNameOFD = 17,
190 e_ModuleNameOffice2PDF = 18,
192 e_ModuleNamePrint2PDF = 19
193 } ModuleName;
194
200 typedef enum _ColorSpaceType {
202 e_ColorSpaceInvalid = 0,
204 e_ColorSpaceDeviceGray = 1,
206 e_ColorSpaceDeviceRGB = 2,
208 e_ColorSpaceDeviceCMYK = 3,
210 e_ColorSpaceCalGray = 4,
212 e_ColorSpaceCalRGB = 5,
214 e_ColorSpaceLab = 6,
216 e_ColorSpaceICCBased = 7,
218 e_ColorSpaceSeparation = 8,
220 e_ColorSpaceDeviceN = 9,
222 e_ColorSpaceIndexed = 10,
224 e_ColorSpacePattern = 11,
226 e_ColorSpaceICCBasedDeviceGray = 12,
228 e_ColorSpaceICCBasedDeviceRGB = 13,
230 e_ColorSpaceICCBasedDeviceCMYK = 14
231 } ColorSpaceType;
232
238 typedef enum _LocaleID {
240 e_LocaleIDUnspecified = 0,
242 e_LocaleIDHongKong = 1,
244 e_LocaleIDTaiwan = 2,
246 e_LocaleIDNetherlands = 3,
248 e_LocaleIDFrance = 4,
250 e_LocaleIDGermany = 5,
252 e_LocaleIDItaly = 6,
254 e_LocaleIDKorea = 7,
256 e_LocaleIDJapan = 8
257 } LocaleID;
258
264 typedef enum _FileFormatType {
266 e_FileFormatTypeFDF = 0,
268 e_FileFormatTypeXFDF = 1,
270 e_FileFormatTypeHTML = 2,
272 e_FileFormatTypeXDP = 3,
274 e_FileFormatTypeXML = 4,
276 e_FileFormatTypeXFD = 5,
278 e_FileFormatTypePDF = 6,
280 e_FileFormatTypeTXT = 7
281 } FileFormatType;
282
283
284 #define CommonDefines foxit::common
285
291 class Codec FS_FINAL : public Base {
292 public:
301 static String Base64Encode(const void* data_buffer, size_t length);
302
311 static String Base64Decode(const void* encoded_data_buffer, size_t length);
312
321 static String FlateCompress(const void* data_buffer, size_t length);
322
331 static String FlateDecompress(const void* compressed_data_buffer, size_t length);
332 };
333
342 class NotifierCallback {
343 public:
349 virtual void Release() = 0;
350
363 virtual void OnOutOfMemory() = 0;
364
365 protected:
366 ~NotifierCallback() {}
367 };
368
373 class Progressive FS_FINAL : public Base {
374 public:
380 typedef enum _State {
382 e_Error = 0,
384 e_ToBeContinued = 1,
386 e_Finished = 2
387 } State;
388
394 Progressive(const Progressive& other);
396 ~Progressive();
397
405 Progressive& operator = (const Progressive& other);
406
415 State Continue();
416
423 int GetRateOfProgress();
424
425 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
426 explicit Progressive(FS_HANDLE handle = NULL);
427 };
432 class RenderConfig FS_FINAL : public Object {
433 public:
440 RenderConfig(int graphics_objs_count_in_one_step) :graphics_objs_count_in_one_step(graphics_objs_count_in_one_step) {}
441
443 RenderConfig():graphics_objs_count_in_one_step(100){}
444
452 RenderConfig& operator = (const RenderConfig& render_config) {
453 this->graphics_objs_count_in_one_step = render_config.graphics_objs_count_in_one_step;
454 return *this;
455 }
456
464 bool operator == (const RenderConfig& render_config) const {
465 if (this->graphics_objs_count_in_one_step == render_config.graphics_objs_count_in_one_step)
466 return true;
467 return false;
468 }
469
477 bool operator != (const RenderConfig& render_config) const {
478 if (this->graphics_objs_count_in_one_step != render_config.graphics_objs_count_in_one_step)
479 return true;
480 return false;
481 }
482
491 void Set(int graphics_objs_count_in_one_step) {
492 this->graphics_objs_count_in_one_step = graphics_objs_count_in_one_step;
493 }
494
507 int graphics_objs_count_in_one_step;
508 };
509
526 class Library FS_FINAL : public Object {
527 public:
544 static ErrorCode Initialize(const char* sn, const char* key);
545
546 #if !defined(_SWIG_ANDROID_) && !defined(_SWIG_IOS_) && !defined(_SWIG_JAVA_) && !defined(_SWIG_DOTNET_) && !defined(_SWIG_MACOC_) && !defined(_SWIG_PYTHON_) && !defined(_SWIG_NODEJS_) && !defined(_SWIG_GO_)
547
564 #if _FX_OS_ == _FX_IOS_ || _FX_OS_ == _FX_ANDROID_
565 static ErrorCode InitializeWithAppName(const char* sn, const char* key, const char* app_name);
566 #endif
567 #endif
568
590 static ErrorCode Initialize(const char* sn, const char* key, bool is_optimize_memory, bool enable_js_xfa_threadsafety = false);
591
603 static ErrorCode Reinitialize();
604
614 static void Release();
615
630 static bool HasModuleLicenseRight(common::ModuleName module_name);
631
637 static String GetVersion();
638
650 static bool SetCacheSize(uint32 size);
651
663 static bool EnableJavaScript(bool enable_javascript);
664
665 #ifndef __EMSCRIPTEN_RENDER__
666
688 static bool SetAnnotIconProviderCallback(pdf::annots::IconProviderCallback* annot_icon_provider);
689 #endif
690
702 static bool SetNotifierCallback(NotifierCallback* notifier);
703
718 static bool SetActionCallback(ActionCallback* action_callback);
719
728 static bool SetDocEventCallback(DocEventCallback* callback);
729
766 static bool RegisterSignatureCallback(const char* filter, const char* sub_filter,
767 pdf::SignatureCallback* signature_callback);
768
790 static void UnregisterSignatureCallback(const char* filter, const char* sub_filter);
791
826 static bool RegisterSecurityCallback(const char* filter, pdf::SecurityCallback* callback);
827
846 static bool UnregisterSecurityCallback(const char* filter);
847
867 static bool SetTimeStampCallback(pdf::TimeStampCallback* timestamp_callback);
868
869 #ifndef _FX_NO_XFA_
870
887 static void RegisterXFAAppProviderCallback(addon::xfa::AppProviderCallback* callback);
888
889 #endif
890
900 static void SetRenderTextGamma(float gamma);
901
912 static void* Alloc(size_t size);
913
921 static void Free(void* ptr);
922
934 static void* Realloc(void* ptr, size_t new_size);
935
946 static void SetLogFile(const char* log_file_path);
947
958 static void SetLogFile(const wchar_t* log_file_path);
959
970 static void SetLogFile(foxit::common::file::StreamCallback* log_file);
971
977 static foxit::ErrorCode FlushLog();
978
990 static bool SetFontMapperCallback(FontMapperCallback* callback);
991
1005 static void SetDefaultICCProfilesPath(const wchar_t* icc_profile_folder_path);
1006
1012 static RenderConfig GetRenderConfig();
1013
1021 static void SetRenderConfig(const RenderConfig& render_config);
1022
1038 static void EnableThreadSafety(bool is_enable_thread_safety);
1039
1040 #if defined(_WIN32) || defined(_WIN64)|| defined(__linux__)
1041
1057 static ErrorCode InitializeOFDEngine(const char* ofd_library_path);
1058
1067 static void ReleaseOFDEngine();
1068 #endif
1069
1077 static WString ExecuteJavaScript(const wchar_t* java_script);
1078
1086 static bool AddExternalFontPath(const wchar_t* font_path);
1087
1097 static void MatchExternalFontsOnly(bool only_match);
1098
1099 private:
1100 Library(const Library&);
1101 Library& operator = (const Library&);
1102 };
1104 class GraphState FS_FINAL : public Object {
1105 public:
1112 typedef enum _LineCapStyle {
1117 e_LineCapButt = 0,
1122 e_LineCapRound= 1,
1127 e_LineCapSquare = 2
1128 } LineCapStyle;
1129
1136 typedef enum _LineJoinStyle {
1141 e_LineJoinMiter = 0,
1147 e_LineJoinRound = 1,
1153 e_LineJoinBevel = 2
1154 } LineJoinStyle;
1155
1156
1170 GraphState(float line_width, LineJoinStyle line_join, float miter_limit,
1171 LineCapStyle line_cap, float dash_phase, const FloatArray& dashes) {
1172 this->line_width = line_width;
1173 this->line_join = line_join;
1174 this->miter_limit = miter_limit;
1175 this->line_cap = line_cap;
1176 this->dash_phase = dash_phase;
1177 this->dashes = dashes;
1178 }
1179
1181 GraphState()
1182 : line_width(1.0f)
1183 , line_join(e_LineJoinMiter)
1184 , miter_limit(10*1.0f)
1185 , line_cap(e_LineCapButt)
1186 , dash_phase(0) {}
1187
1193 GraphState(const GraphState& state) {
1194 this->line_width = state.line_width;
1195 this->line_join = state.line_join;
1196 this->miter_limit = state.miter_limit;
1197 this->line_cap = state.line_cap;
1198 this->dash_phase = state.dash_phase;
1199 this->dashes = state.dashes;
1200 }
1201
1209 GraphState& operator = (const GraphState& state) {
1210 this->line_width = state.line_width;
1211 this->line_join = state.line_join;
1212 this->miter_limit = state.miter_limit;
1213 this->line_cap = state.line_cap;
1214 this->dash_phase = state.dash_phase;
1215 this->dashes = state.dashes;
1216 return *this;
1217 }
1218
1234 void Set(float line_width, LineJoinStyle line_join, float miter_limit, LineCapStyle line_cap, float dash_phase,
1235 const FloatArray& dashes) {
1236 this->line_width = line_width;
1237 this->line_join = line_join;
1238 this->miter_limit = miter_limit;
1239 this->line_cap = line_cap;
1240 this->dash_phase = dash_phase;
1241 this->dashes = dashes;
1242 }
1243
1250 float line_width;
1258 LineJoinStyle line_join;
1268 float miter_limit;
1276 LineCapStyle line_cap;
1277
1279 float dash_phase;
1280
1284 FloatArray dashes;
1285 };
1286
1292 typedef IFX_Pause PauseCallback;
1293
1299 class DocEventCallback {
1300 public:
1306 virtual void Release() = 0;
1307
1313 virtual void OnDocWillOpen() {}
1314
1325 virtual void OnDocOpened(const pdf::PDFDoc& document, ErrorCode error_code) {}
1326
1334 virtual void OnDocWillDestroy(const pdf::PDFDoc& document) {}
1335
1343 virtual void OnDocWillSave(const pdf::PDFDoc& document) {}
1344
1355 virtual void OnDocSaved(const pdf::PDFDoc& document, ErrorCode error_code) {}
1356
1357 protected:
1358 ~DocEventCallback() {}
1359 };
1360
1368 class Range FS_FINAL : public Base {
1369 public:
1375 typedef enum _Filter {
1377 e_All = 0,
1379 e_Even = 1,
1381 e_Odd = 2
1382 } Filter;
1383
1385 Range();
1386
1392 explicit Range(int index);
1393
1406 explicit Range(int start_index, int end_index, Filter filter = e_All);
1407
1413 Range(const Range& other);
1414
1416 ~Range();
1417
1425 Range& operator = (const Range& other);
1426
1434 bool operator == (const Range& other) const;
1435
1443 bool operator != (const Range& other) const;
1444
1452 bool IsEmpty() const;
1453
1459 void AddSingle( int index );
1460
1475 void AddSegment( int start_index, int end_index, Filter filter = e_All );
1476
1482 int GetSegmentCount() const;
1483
1492 int GetSegmentStart(int segment_index) const;
1493
1502 int GetSegmentEnd(int segment_index) const;
1503
1509 void RemoveAll();
1510
1511 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1512 explicit Range(FS_HANDLE handle);
1513 };
1514
1523 class Font FS_FINAL : public Base {
1524 public:
1530 typedef enum _Styles {
1532 e_StyleFixedPitch = 0x0001,
1534 e_StyleSerif = 0x0002,
1536 e_StyleSymbolic = 0x0004,
1538 e_StyleScript = 0x0008,
1540 e_StyleNonSymbolic = 0x0020,
1542 e_StyleItalic = 0x0040,
1544 e_StyleAllCap = 0x10000,
1546 e_StylesSmallCap = 0x20000,
1548 e_StylesBold = 0x40000
1549 } Styles;
1550
1556 typedef enum _Charset {
1558 e_CharsetANSI = 0,
1560 e_CharsetDefault = 1,
1562 e_CharsetSymbol = 2,
1564 e_CharsetShift_JIS = 128,
1566 e_CharsetHangeul = 129,
1568 e_CharsetGB2312 = 134,
1570 e_CharsetChineseBig5 = 136,
1572 e_CharsetThai = 222,
1574 e_CharsetEastEurope = 238,
1576 e_CharsetRussian = 204,
1578 e_CharsetGreek = 161,
1580 e_CharsetTurkish = 162,
1582 e_CharsetHebrew = 177,
1584 e_CharsetArabic = 178,
1586 e_CharsetBaltic = 186
1587 } Charset;
1588
1594 typedef enum _CIDCharset {
1596 e_CIDCharsetUnknown = 0,
1598 e_CIDCharsetGB1 = 1,
1600 e_CIDCharsetCNS1 = 2,
1602 e_CIDCharsetJAPAN1 = 3,
1604 e_CIDCharsetKOREA1 = 4,
1606 e_CIDCharsetUNICODE = 5
1607 } CIDCharset;
1608
1614 typedef enum _StandardID {
1616 e_StdIDCourier = 0,
1618 e_StdIDCourierB = 1,
1620 e_StdIDCourierBI = 2,
1622 e_StdIDCourierI = 3,
1624 e_StdIDHelvetica = 4,
1626 e_StdIDHelveticaB = 5,
1628 e_StdIDHelveticaBI = 6,
1630 e_StdIDHelveticaI = 7,
1632 e_StdIDTimes = 8,
1634 e_StdIDTimesB = 9,
1636 e_StdIDTimesBI = 10,
1638 e_StdIDTimesI = 11,
1640 e_StdIDSymbol = 12,
1642 e_StdIDZapfDingbats = 13
1643 } StandardID;
1644
1650 typedef enum _FontTypes {
1652 e_FontTypeType1 = 1,
1654 e_FontTypeTrueType = 2,
1656 e_FontTypeType3 = 3,
1658 e_FontTypeCIDFont = 4
1659 } FontTypes;
1660
1673 Font(const wchar_t* name, uint32 styles, Charset charset, int weight);
1674
1681 explicit Font(StandardID font_id);
1682
1692 Font(const char* font_file_path, int face_index, Charset charset);
1693
1703 Font(const wchar_t* font_file_path, int face_index, Charset charset);
1704
1711 Font(foxit::common::file::StreamCallback* stream);
1712
1713 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1714 explicit Font(FS_HANDLE handle = NULL);
1715
1721 Font(const Font& other);
1722
1730 Font& operator = (const Font& other);
1731
1739 bool operator == (const Font& other) const;
1740
1748 bool operator != (const Font& other) const;
1749
1757 bool IsEmpty() const;
1758
1760 ~Font();
1761
1767 WString GetName();
1768
1774 String GetFamilyName();
1775
1781 bool IsBold() const;
1782
1788 bool IsItalic() const;
1789
1797 bool IsEmbedded(const pdf::PDFDoc& document);
1798
1807 bool IsSupportEmbedded(const pdf::PDFDoc& document);
1808
1821 Font Embed(pdf::PDFDoc document, bool is_add_all_unicodes = true);
1822
1833 UInt32Array AddUnicodes(const pdf::PDFDoc& document, const UInt32Array& unicode_array);
1834
1835 #ifdef _FONT_GETWOFFDATA_
1836
1843 String GetWoffData(pdf::PDFDoc document);
1844 #endif
1845
1851 int GetAscent() const;
1852
1858 int GetDescent() const;
1859
1867 RectI GetCharBBox(uint32 unicode) const;
1868
1876 float GetCharWidth(uint32 unicode) const;
1877
1886 RectI GetCharBBox(foxit::uint32 unicode,const foxit::pdf::PDFDoc& document);
1887
1896 float GetCharWidth(foxit::uint32 unicode,const foxit::pdf::PDFDoc& document);
1897
1906 foxit::uint32 GetStyles(const pdf::PDFDoc& document);
1907
1919 CIDCharset GetCIDCharset(const pdf::PDFDoc& document);
1920
1928 bool IsStandardFont(const pdf::PDFDoc& document);
1929
1941 StandardID GetStandard14Font(const pdf::PDFDoc& document);
1942
1951 FontTypes GetFontType(const pdf::PDFDoc& document);
1952
1960 String GetBaseFontName(const pdf::PDFDoc& document);
1961
1970 bool IsVertWriting(const pdf::PDFDoc& document);
1971
1980 String GetEncoding(const pdf::PDFDoc& document);
1981
1993 bool SetEncoding(const pdf::PDFDoc& document, const char* value);
1994
2003 bool IsCharSupported(foxit::uint32 unicode, const pdf::PDFDoc& document) const;
2004 };
2005
2010 class FontMapResult FS_FINAL : public Object {
2011 public:
2013 FontMapResult() : file_read(NULL), face_index(-1) {}
2014
2028 FontMapResult(foxit::common::file::ReaderCallback* file_read, int face_index) {
2029 this->file_read = file_read;
2030 this->face_index = face_index;
2031 }
2032
2038 FontMapResult(const FontMapResult& other) {
2039 this->file_read = other.file_read;
2040 this->face_index = other.face_index;
2041 }
2042
2050 FontMapResult& operator = (const FontMapResult& other) {
2051 this->file_read = other.file_read;
2052 this->face_index = other.face_index;
2053 return *this;
2054 }
2055
2063 bool operator == (const FontMapResult& other) const {
2064 if (this->file_read != other.file_read || this->face_index != other.face_index)
2065 return false;
2066 return true;
2067 }
2068
2076 bool operator != (const FontMapResult& other) const {
2077 return !(*this == other);
2078 }
2079
2093 void Set(foxit::common::file::ReaderCallback* file_read, int face_index) {
2094 this->file_read = file_read;
2095 this->face_index = face_index;
2096 }
2097
2102 foxit::common::file::ReaderCallback* file_read;
2112 int face_index;
2113 };
2114
2123 class FontMapperCallback {
2124 public:
2130 virtual void Release() = 0;
2131
2149 virtual FontMapResult MapFont(const char* font_name, bool is_truetype, uint32 styles,
2150 int weight, int italic_angle, Font::Charset charset) = 0;
2151
2165 virtual StringArray MapFont(const char* font_family_name, Font::Charset charset,
2166 uint32 styles, int weight, int italic_angle) = 0;
2167
2168 protected:
2169 ~FontMapperCallback() {}
2170 };
2171
2173 class Path FS_FINAL : public Base {
2174 public:
2180 typedef enum _PointType {
2182 e_TypeMoveTo = 1,
2184 e_TypeLineTo = 2,
2190 e_TypeLineToCloseFigure = 3,
2192 e_TypeBezierTo = 4,
2198 e_TypeBezierToCloseFigure = 5
2199 } PointType;
2200
2202 Path();
2204 ~Path();
2210 Path(const Path& other);
2218 Path& operator=(const Path& other);
2226 bool operator ==(const Path& other) const;
2234 bool operator != (const Path& other) const;
2235
2243 bool IsEmpty() const;
2244
2250 int GetPointCount();
2251
2260 PointF GetPoint(int index);
2261
2271 PointType GetPointType(int index);
2272
2284 bool SetPoint(int index, const PointF& point, PointType type);
2285
2296 bool MoveTo(const PointF& point);
2297
2307 bool LineTo(const PointF& point);
2308
2321 bool CubicBezierTo(const PointF& point1, const PointF& point2, const PointF& point3);
2322
2342 bool CloseFigure();
2343
2352 bool RemovePoint(int index);
2353
2361 bool AppendRect(const RectF& rect);
2362
2370 bool AppendEllipse(const RectF& rect);
2371
2379 void Transform(const Matrix& matrix);
2385 void Clear();
2386
2399 void IncreasePointCount(int count);
2400
2401 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2402 explicit Path(FS_HANDLE handle);
2403 };
2404
2406 FSDK_DEFINE_ARRAY(PathArray, Path)
2407
2408
2411 class ColorSpace FS_FINAL : public Base {
2412 public:
2421 typedef enum _RenderingIntent {
2423 e_RenderIntentPerceptual = 0,
2425 e_RenderIntentRelColorimetric = 1,
2427 e_RenderIntentSaturation = 2,
2429 e_RenderIntentAbsColorimetric = 3
2430 } RenderingIntent;
2431
2432
2433 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2434 explicit ColorSpace(FS_HANDLE handle);
2435
2444 ColorSpace(foxit::common::ColorSpaceType type);
2446 ~ColorSpace();
2447
2453 ColorSpace(const ColorSpace& other);
2454
2462 ColorSpace& operator=(const ColorSpace& other);
2463
2472 bool operator==(const ColorSpace& other) const;
2473
2482 bool operator!=(const ColorSpace& other) const;
2483
2491 bool IsEmpty() const;
2492
2500 int GetComponentCount() const;
2501
2508 foxit::common::ColorSpaceType GetColorSpaceType() const;
2509
2515 bool IsSpotColorSpace() const;
2516
2533 StringArray GetComponentNames() const;
2534
2543 Color ConvertColor(const Color& color);
2544
2555 Color ConvertColor(int r_value, int g_value, int b_value);
2556
2568 Color ConvertColor(int c_value, int m_value, int y_value, int k_value);
2569 };
2570
2574 class Color FS_FINAL : public Base {
2575 public:
2576 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2577 explicit Color(FS_HANDLE handle);
2578
2580 Color();
2586 explicit Color(const ColorSpace& color_space);
2588 ~Color();
2589
2595 Color(const Color& other);
2596
2604 Color& operator=(const Color& other);
2605
2613 bool operator==(const Color& other) const;
2614
2622 bool operator!=(const Color& other) const;
2623
2631 bool IsEmpty() const;
2632
2638 ColorSpace GetColorSpace();
2639
2649 FloatArray GetValue() const;
2650
2663 void SetValue(const FloatArray& component_array);
2664
2673 Color ConvertToRGB(ColorSpace::RenderingIntent intent = ColorSpace::e_RenderIntentRelColorimetric) const;
2674
2683 Color ConvertToCMYK(ColorSpace::RenderingIntent intent = ColorSpace::e_RenderIntentRelColorimetric) const;
2684 };
2685 } // namespace common
2686 } // namespace foxit
2687
2688 #endif // FS_COMMON_H_
2689
foxit::common::FontMapperCallback
Definition: fs_common.h:2123
foxit::common::Font::e_CharsetANSI
Font charset: ANSI (United States, Western Europe).
Definition: fs_common.h:1558
foxit::common::Library::GetRenderConfig
static RenderConfig GetRenderConfig()
Get the rendering configuration.
foxit::common::GraphState::LineCapStyle
LineCapStyle
Enumeration for line cap style.
Definition: fs_common.h:1112
foxit::common::Font::e_StdIDTimesBI
Standard font: Times-BoldItalic.
Definition: fs_common.h:1636
foxit::common::Path::Transform
void Transform(const Matrix &matrix)
Transform all points in current path with a given matrix.
foxit::common::Path::AppendRect
bool AppendRect(const RectF &rect)
Add a rectangle figure to the end of current path.
foxit::common::e_PosCenterLeft
Position center left.
Definition: fs_common.h:136
foxit::common::e_FillModeWinding
Winding fill mode, in which the system uses a direction in which a figure is drawn to determine wheth...
Definition: fs_common.h:120
foxit::common::FileFormatType
FileFormatType
Enumeration for file format type.
Definition: fs_common.h:264
foxit::common::Path::GetPointType
PointType GetPointType(int index)
Get the type of a point specified by index.
foxit::common::Library::AddExternalFontPath
static bool AddExternalFontPath(const wchar_t *font_path)
Add external font path.
foxit::common::Path::LineTo
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...
foxit::common::Font::operator=
Font & operator=(const Font &other)
Assign operator.
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::common::Library::EnableThreadSafety
static void EnableThreadSafety(bool is_enable_thread_safety)
Enable thread safety.
foxit::common::Path::CubicBezierTo
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...
foxit::common::Font::GetAscent
int GetAscent() const
Get the ascent value, in 1/1000 of em size (PDF units).
foxit::common::Font::e_CharsetTurkish
Font charset: Turkish.
Definition: fs_common.h:1580
foxit::common::Font::GetEncoding
String GetEncoding(const pdf::PDFDoc &document)
Get the current font encoding.
foxit::common::FontMapResult::file_read
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:2102
foxit::ActionCallback
Definition: fs_actioncallback.h:2624
foxit::common::Font::e_CharsetEastEurope
Font charset: Eastern European.
Definition: fs_common.h:1574
foxit::common::RenderConfig::RenderConfig
RenderConfig()
Constructor.
Definition: fs_common.h:443
foxit::common::e_ColorSpacePattern
Color space: Pattern.
Definition: fs_common.h:224
foxit::common::GraphState::LineJoinStyle
LineJoinStyle
Enumeration for line join style.
Definition: fs_common.h:1136
foxit::common::Library::RegisterSecurityCallback
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...
foxit::common::FontMapResult::operator==
bool operator==(const FontMapResult &other) const
Equal operator.
Definition: fs_common.h:2063
foxit::common::Color
Definition: fs_common.h:2574
foxit::common::ColorSpace
Definition: fs_common.h:2411
foxit::common::e_ColorSpaceDeviceN
Color space: DeviceN.
Definition: fs_common.h:220
foxit::common::Font::IsVertWriting
bool IsVertWriting(const pdf::PDFDoc &document)
Check whether current font is vertical writing.
foxit::common::Font::IsEmbedded
bool IsEmbedded(const pdf::PDFDoc &document)
Judge whether current font is embedded in a specified PDF document or not.
foxit::common::Range::operator!=
bool operator!=(const Range &other) const
Not equal operator.
foxit::common::Font::StandardID
StandardID
Enumeration for standard font ID.
Definition: fs_common.h:1614
foxit::common::e_FillModeNone
Fill mode: none.
Definition: fs_common.h:110
foxit::common::Font::e_CharsetArabic
Font charset: Arabic.
Definition: fs_common.h:1584
foxit::common::DocEventCallback
Definition: fs_common.h:1299
foxit::StringArray
Definition: fs_basictypes.h:229
foxit::common::Font::e_CharsetRussian
Font charset: Russian.
Definition: fs_common.h:1576
foxit::common::GraphState::line_cap
LineCapStyle line_cap
Line cap style.
Definition: fs_common.h:1276
foxit::common::Range::AddSegment
void AddSegment(int start_index, int end_index, Filter filter=e_All)
Add a new range segment. (Reverse ordering is legal.)
foxit::common::Range::~Range
~Range()
Destructor.
foxit::common::Font::AddUnicodes
UInt32Array AddUnicodes(const pdf::PDFDoc &document, const UInt32Array &unicode_array)
Add unicodes to current embedded font.
foxit::common::Position
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:128
foxit::common::e_FileFormatTypeXFD
File format type: XFD.
Definition: fs_common.h:276
foxit::common::Font::e_CharsetChineseBig5
Font charset: Traditional Chinese.
Definition: fs_common.h:1570
foxit::common::e_ModuleNameTableMaker
Name for module "TableMaker".
Definition: fs_common.h:178
foxit::common::Font::FontTypes
FontTypes
Enumeration for font type.
Definition: fs_common.h:1650
foxit::common::Path::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::common::Library::SetDocEventCallback
static bool SetDocEventCallback(DocEventCallback *callback)
Set a DocEventCallback object to Foxit PDF SDK.
foxit::common::e_Rotation90
Rotate 90 degrees in clockwise direction.
Definition: fs_common.h:61
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:220
foxit::common::Font::e_FontTypeType3
Font type: Type3.
Definition: fs_common.h:1656
foxit::common::GraphState
Definition: fs_common.h:1104
foxit::common::Font::e_StdIDCourierB
Standard font: Courier-Bold.
Definition: fs_common.h:1618
foxit::common::e_Rotation0
No rotation.
Definition: fs_common.h:59
foxit::common::Progressive
Definition: fs_common.h:373
foxit::common::Font::e_StylesSmallCap
Font style: small cap.
Definition: fs_common.h:1546
foxit::common::e_PosBottomLeft
Position: bottom left.
Definition: fs_common.h:142
foxit::common::Library::Alloc
static void * Alloc(size_t size)
Allocate a memory block.
foxit::common::Path::PointType
PointType
Enumeration for point type in path.
Definition: fs_common.h:2180
foxit::common::Font::e_StdIDTimesI
Standard font: Times-Italic.
Definition: fs_common.h:1638
foxit::common::Path::CloseFigure
bool CloseFigure()
Close current figure (which is also the last figure in current path).
foxit::common::GraphState::operator=
GraphState & operator=(const GraphState &state)
Assign operator.
Definition: fs_common.h:1209
foxit::common::Font::e_StyleAllCap
Font style: all cap.
Definition: fs_common.h:1544
foxit::common::Library::SetFontMapperCallback
static bool SetFontMapperCallback(FontMapperCallback *callback)
Set a FontMapperCallback object to Foxit PDF SDK.
foxit::common::e_ColorSpaceCalRGB
Color space: CalRGB. (3 components, A, B, C)
Definition: fs_common.h:212
foxit::common::Range::Range
Range()
Constructor.
foxit::common::NotifierCallback::OnOutOfMemory
virtual void OnOutOfMemory()=0
A callback function used to notify application when Foxit PDF SDK runs out of memory.
foxit::common::e_RotationPointLeftBottom
Rotate the text block based on the left-bottom point of the rectangle.
Definition: fs_common.h:84
foxit::common::PathArray
Definition: fs_common.h:2406
foxit::common::Progressive::GetRateOfProgress
int GetRateOfProgress()
Get the rate of current progress.
foxit::common::Font::e_StdIDCourierI
Standard font: Courier-Oblique, Italic.
Definition: fs_common.h:1622
foxit::common::Library
Definition: fs_common.h:526
foxit::common::e_ModuleNameAccessibility
Name for module "Accessibility".
Definition: fs_common.h:176
foxit::common::NotifierCallback
Definition: fs_common.h:342
foxit::common::Font::IsItalic
bool IsItalic() const
Judge whether current font object is italic or not.
foxit::common::e_AlignmentRight
Right alignment.
Definition: fs_common.h:100
IFX_FileStream
File stream interface, reading & writing.
Definition: fx_stream.h:692
foxit::common::FontMapResult::Set
void Set(foxit::common::file::ReaderCallback *file_read, int face_index)
Set value.
Definition: fs_common.h:2093
foxit::common::Font::e_CIDCharsetKOREA1
CID Font charset: Adobe-Korea1.
Definition: fs_common.h:1604
foxit::common::Path::GetPoint
PointF GetPoint(int index)
Get a point specified by index.
foxit::common::RenderConfig::graphics_objs_count_in_one_step
int graphics_objs_count_in_one_step
The count of graphics objects to be rendered in one step during progressive rendering process....
Definition: fs_common.h:507
foxit::common::Range::AddSingle
void AddSingle(int index)
Add an index as a new range segment.
foxit::common::Codec::FlateDecompress
static String FlateDecompress(const void *compressed_data_buffer, size_t length)
Decompress the compressed data buffer by DEFLATE algorithm.
foxit::common::Color::SetValue
void SetValue(const FloatArray &component_array)
Set component value array.
foxit::common::e_FileFormatTypeXML
File format type: XML.
Definition: fs_common.h:274
foxit::common::Font::e_CIDCharsetJAPAN1
CID Font charset: Adobe-Japan1.
Definition: fs_common.h:1602
foxit::common::Font::GetName
WString GetName()
Retrieve the postscript name.
foxit::common::DocEventCallback::OnDocOpened
virtual void OnDocOpened(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is opened.
Definition: fs_common.h:1325
foxit::common::Color::GetColorSpace
ColorSpace GetColorSpace()
Get the color space that current color belongs to.
foxit::common::FontMapResult::FontMapResult
FontMapResult(const FontMapResult &other)
Constructor, with another font mapping result object.
Definition: fs_common.h:2038
foxit::common::Font::Embed
Font Embed(pdf::PDFDoc document, bool is_add_all_unicodes=true)
Embed current font to the specified PDF document.
CFX_ArrayTemplate< float >
foxit::common::Codec::Base64Encode
static String Base64Encode(const void *data_buffer, size_t length)
Encode the source data buffer by Base64 algorithm.
foxit::common::e_ColorSpaceInvalid
Color space: Invalid.
Definition: fs_common.h:202
foxit::common::Font::e_StdIDHelveticaI
Standard font: Helvetica-Oblique, Italic.
Definition: fs_common.h:1630
foxit::common::Range::RemoveAll
void RemoveAll()
Remove all range segments.
foxit::common::e_ModuleNameComparison
Name for module "Comparison".
Definition: fs_common.h:166
foxit::common::GraphState::miter_limit
float miter_limit
The miter limit for line join.
Definition: fs_common.h:1268
foxit::common::Range::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::common::Font::Font
Font(const wchar_t *name, uint32 styles, Charset charset, int weight)
Constructor, with given attribute.
foxit::common::Alignment
Alignment
Enumeration for alignment (horizontal).
Definition: fs_common.h:94
foxit::common::FontMapperCallback::MapFont
virtual FontMapResult MapFont(const char *font_name, bool is_truetype, uint32 styles, int weight, int italic_angle, Font::Charset charset)=0
(This function will be deprecated in the future. It is recommended to use FontMapperCallback::MapFont...
foxit::common::GraphState::GraphState
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:1170
foxit::common::Library::SetDefaultICCProfilesPath
static void SetDefaultICCProfilesPath(const wchar_t *icc_profile_folder_path)
Set path of folder which contains default ICC profile files.
IFX_FileRead
File reading interface.
Definition: fx_stream.h:587
foxit::common::Font::e_StylesBold
Font style: force bold.
Definition: fs_common.h:1548
foxit::common::Font::e_CharsetHangeul
Font charset: Korean (Wansung).
Definition: fs_common.h:1566
foxit::common::Library::RegisterSignatureCallback
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...
foxit::common::Library::Initialize
static ErrorCode Initialize(const char *sn, const char *key)
Initialize Foxit PDF SDK Library, with valid license information.
foxit::common::e_Rotation270
Rotate 270 degrees in clockwise direction.
Definition: fs_common.h:65
fs_file.h
Header file for file operation related definitions and functions.
foxit::common::Font::e_CharsetShift_JIS
Font charset: Japanese (Shift-JIS).
Definition: fs_common.h:1564
foxit::common::Font::e_CharsetGB2312
Font charset: Simplified Chinese.
Definition: fs_common.h:1568
foxit::common::Font::e_StyleSymbolic
Font style: symbolic.
Definition: fs_common.h:1536
foxit::common::Color::ConvertToRGB
Color ConvertToRGB(ColorSpace::RenderingIntent intent=ColorSpace::e_RenderIntentRelColorimetric) const
Convert to a RGB color.
foxit::common::e_ModuleNameOffice2PDF
Name for module "Office2PDF".
Definition: fs_common.h:190
foxit::common::Font::GetBaseFontName
String GetBaseFontName(const pdf::PDFDoc &document)
Get base font name.
foxit::ErrorCode
ErrorCode
Enumeration for error code.
Definition: fs_basictypes.h:236
fs_basictypes.h
Header file for basic types definitions.
foxit::common::Path::operator==
bool operator==(const Path &other) const
Equal operator.
foxit::common::Library::SetLogFile
static void SetLogFile(const char *log_file_path)
Set the log file path.
foxit::common::Codec
Definition: fs_common.h:291
foxit::common::Font::e_CIDCharsetCNS1
CID Font charset: Adobe-CNS1.
Definition: fs_common.h:1600
foxit::common::e_ModuleNameRedaction
Name for module "Redaction".
Definition: fs_common.h:160
foxit::common::RenderConfig::operator==
bool operator==(const RenderConfig &render_config) const
Equal operator.
Definition: fs_common.h:464
foxit::common::GraphState::dash_phase
float dash_phase
Dash phase for dash pattern.
Definition: fs_common.h:1279
foxit::common::e_AlignmentLeft
Left alignment.
Definition: fs_common.h:96
foxit::common::Progressive::operator=
Progressive & operator=(const Progressive &other)
Assign operator.
foxit::common::Font::IsSupportEmbedded
bool IsSupportEmbedded(const pdf::PDFDoc &document)
Check whether current font is supported to be embedded to the specified PDF document or not.
foxit::common::Library::SetRenderTextGamma
static void SetRenderTextGamma(float gamma)
Set gamma value for text rendering.
foxit::common::Path
Definition: fs_common.h:2173
foxit::common::GraphState::e_LineJoinRound
Round line join type.
Definition: fs_common.h:1147
foxit::common::e_AlignmentCenter
Center alignment.
Definition: fs_common.h:98
foxit::common::Color::~Color
~Color()
Destructor.
foxit::common::Library::SetCacheSize
static bool SetCacheSize(uint32 size)
Set the upper limit of PDF library cache size.
foxit::common::e_ModuleNamePrint2PDF
Name for module "Print2PDF".
Definition: fs_common.h:192
foxit::common::DocEventCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::common::Font::CIDCharset
CIDCharset
Enumeration for CID font charset.
Definition: fs_common.h:1594
foxit::common::Progressive::~Progressive
~Progressive()
Destructor.
foxit::common::Font::e_StyleItalic
Font style: italic.
Definition: fs_common.h:1542
foxit::common::Font::GetCharWidth
float GetCharWidth(uint32 unicode) const
Get the width (in 1/1000 of em size (PDF units)) of a character specified by unicode.
foxit::common::e_ModuleNameRMS
Name for module "RMS".
Definition: fs_common.h:162
foxit::common::Font::GetStandard14Font
StandardID GetStandard14Font(const pdf::PDFDoc &document)
Get standard font ID.
foxit::common::Range::GetSegmentStart
int GetSegmentStart(int segment_index) const
Get the start index of a specified range segment.
foxit::common::Font::GetCharBBox
RectI GetCharBBox(uint32 unicode) const
Get the bounding box of a character specified by unicode.
foxit::common::Font::e_CIDCharsetGB1
CID Font charset: Adobe-GB1.
Definition: fs_common.h:1598
foxit::common::e_PosBottomRight
Position: bottom right.
Definition: fs_common.h:146
foxit::pdf::TimeStampCallback
Definition: fs_signature.h:1868
foxit::common::DocEventCallback::OnDocWillDestroy
virtual void OnDocWillDestroy(const pdf::PDFDoc &document)
Triggered when a PDF document will be destroyed.
Definition: fs_common.h:1334
foxit::common::Range::GetSegmentEnd
int GetSegmentEnd(int segment_index) const
Get the end index of a specified range segment.
foxit::common::Font::e_StdIDTimes
Standard font: Times-Roman.
Definition: fs_common.h:1632
foxit::common::e_PosCenter
Position: center.
Definition: fs_common.h:138
foxit::common::Range::operator==
bool operator==(const Range &other) const
Equal operator.
foxit::common::FontMapResult::operator=
FontMapResult & operator=(const FontMapResult &other)
Assign operator.
Definition: fs_common.h:2050
foxit::common::e_PosTopLeft
Position: top left.
Definition: fs_common.h:130
foxit::common::Path::SetPoint
bool SetPoint(int index, const PointF &point, PointType type)
Change the value and type of a point specified by index.
foxit::common::ColorSpaceType
ColorSpaceType
Enumeration for color space.
Definition: fs_common.h:200
foxit::common::Range::e_Odd
Only odd numbers in a range will be used (discards even numbers).
Definition: fs_common.h:1381
foxit::common::Path::AppendEllipse
bool AppendEllipse(const RectF &rect)
Add an ellipse figure to the end of current path.
foxit::common::GraphState::Set
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:1234
foxit::common::DocEventCallback::OnDocWillSave
virtual void OnDocWillSave(const pdf::PDFDoc &document)
Triggered when a PDF document will be saved.
Definition: fs_common.h:1343
foxit::common::FontMapResult::operator!=
bool operator!=(const FontMapResult &other) const
Not equal operator.
Definition: fs_common.h:2076
foxit::pdf::SecurityCallback
Definition: fs_security.h:1277
foxit::common::FontMapResult::face_index
int face_index
Face index. This is a zero-based index value:
Definition: fs_common.h:2112
foxit::common::GraphState::e_LineCapRound
Round cap. A semicircular arc with a diameter equal to the line width is drawn around the endpoint an...
Definition: fs_common.h:1122
foxit::common::e_ColorSpaceLab
Color space: Lab. (3 components, A, B, C)
Definition: fs_common.h:214
foxit::common::Font::Charset
Charset
Enumeration for font charset.
Definition: fs_common.h:1556
foxit::common::e_PosTopCenter
Position: top center.
Definition: fs_common.h:132
foxit::common::Color::operator=
Color & operator=(const Color &other)
Assign operator.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::common::Library::ExecuteJavaScript
static WString ExecuteJavaScript(const wchar_t *java_script)
Execute javascript.
foxit::common::FontMapResult
Definition: fs_common.h:2010
foxit::common::Path::Clear
void Clear()
Clear all points.
foxit::common::Path::e_TypeBezierTo
Indicates that this point is a control point or ending point for a Bezier spline.
Definition: fs_common.h:2192
foxit::common::Library::UnregisterSignatureCallback
static void UnregisterSignatureCallback(const char *filter, const char *sub_filter)
Unregister the third-party pdf::SignatureCallback object, which is associated with a specific filter ...
foxit::common::Library::FlushLog
static foxit::ErrorCode FlushLog()
Flush the log file.
foxit::common::e_FileFormatTypeTXT
File format type: TXT.
Definition: fs_common.h:280
foxit::common::e_ColorSpaceCalGray
Color space: CalGray. (1 component, A)
Definition: fs_common.h:210
foxit::common::Font::e_StyleScript
Font style: script.
Definition: fs_common.h:1538
foxit::common::Font::e_StdIDHelvetica
Standard font: Helvetica.
Definition: fs_common.h:1624
foxit::common::Path::e_TypeLineToCloseFigure
Indicates that a line is drawn from the previous point to this point, and this point will also be con...
Definition: fs_common.h:2190
foxit::common::Color::operator!=
bool operator!=(const Color &other) const
Not equal operator.
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::common::e_ModuleNameOptimizer
Name for module "Optimizer".
Definition: fs_common.h:170
foxit::common::Library::Release
static void Release()
Release all resource allocated by Foxit PDF SDK Library.
foxit::common::e_FillModeAlternate
Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polyg...
Definition: fs_common.h:115
foxit::common::Path::operator=
Path & operator=(const Path &other)
Assign operator.
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::common::Codec::Base64Decode
static String Base64Decode(const void *encoded_data_buffer, size_t length)
Decode the encoded data buffer by Base64 algorithm.
foxit::common::e_RotationPointCenter
Rotate the text block based on the center point.
Definition: fs_common.h:78
foxit::common::e_RotationUnknown
Unknown rotation.
Definition: fs_common.h:67
foxit::common::Path::GetPointCount
int GetPointCount()
Get the count of points.
foxit::common::e_RotationPointRightTop
Rotate the text block based on the right-top point of the rectangle.
Definition: fs_common.h:82
foxit::common::e_ColorSpaceICCBased
Color space: ICCBased.
Definition: fs_common.h:216
foxit::common::Color::Color
Color()
Construct an empty color.
foxit::common::Path::e_TypeLineTo
Indicates that a line is drawn from the previous point to this point.
Definition: fs_common.h:2184
foxit::common::Font::e_StyleFixedPitch
Font style: fixed pitch.
Definition: fs_common.h:1532
foxit::common::e_ModuleNameOCR
Name for module "OCR".
Definition: fs_common.h:164
foxit::common::e_RotationPointRightBottom
Rotate the text block based on the right-bottom point of the rectangle.
Definition: fs_common.h:86
foxit::common::e_ColorSpaceSeparation
Color space: Separation.
Definition: fs_common.h:218
operator==
bool operator==(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are equal.
Definition: fs_basictypes.h:128
foxit::common::FillMode
FillMode
Enumeration for filling mode type, mainly for path graphics object.
Definition: fs_common.h:108
foxit::common::Library::RegisterXFAAppProviderCallback
static void RegisterXFAAppProviderCallback(addon::xfa::AppProviderCallback *callback)
Register an addon::xfa::AppProviderCallback object to Foxit PDF SDK.
foxit::common::Library::EnableJavaScript
static bool EnableJavaScript(bool enable_javascript)
Enable or disable javascript for PDF.
foxit::common::Font::Styles
Styles
Enumeration for font styles.
Definition: fs_common.h:1530
foxit::common::FontMapperCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::common::e_ColorSpaceDeviceRGB
Color space: DeviceRGB. (3 components, R, G, B)
Definition: fs_common.h:206
foxit::common::Font::e_CharsetHebrew
Font charset: Hebrew.
Definition: fs_common.h:1582
foxit::common::e_LocaleIDKorea
Locale ID for country: Korea.
Definition: fs_common.h:254
foxit::common::GraphState::dashes
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:1284
foxit::common::e_FileFormatTypeXFDF
File format type: XFDF.
Definition: fs_common.h:268
foxit::common::Font::SetEncoding
bool SetEncoding(const pdf::PDFDoc &document, const char *value)
Set the current font encoding.
foxit::common::e_ModuleNamePDF2Office
Name for module "PDF2Office".
Definition: fs_common.h:184
foxit::common::Font::e_FontTypeCIDFont
Font type: CID font.
Definition: fs_common.h:1658
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::common::e_FileFormatTypePDF
File format type: PDF.
Definition: fs_common.h:278
foxit::common::e_FileFormatTypeXDP
File format type: XDP.
Definition: fs_common.h:272
foxit::common::FontMapResult::FontMapResult
FontMapResult(foxit::common::file::ReaderCallback *file_read, int face_index)
Constructor, with parameters.
Definition: fs_common.h:2028
foxit::common::Range::operator=
Range & operator=(const Range &other)
Assign operator.
foxit::common::Font::e_StyleSerif
Font style: serif.
Definition: fs_common.h:1534
foxit::common::Progressive::e_Error
Progress state: any error occurs.
Definition: fs_common.h:382
foxit::common::Font::e_FontTypeTrueType
Font type: TrueType.
Definition: fs_common.h:1654
foxit::common::Font::e_CharsetBaltic
Font charset: Baltic.
Definition: fs_common.h:1586
foxit::common::Font::e_CharsetGreek
Font charset: Greek.
Definition: fs_common.h:1578
foxit::common::Path::IncreasePointCount
void IncreasePointCount(int count)
Increase the point count and prepare adequate memory for these new points.
foxit::common::Font::e_StdIDCourier
Standard font: Courier.
Definition: fs_common.h:1616
foxit::common::GraphState::line_width
float line_width
Line width.
Definition: fs_common.h:1250
foxit::common::e_LocaleIDNetherlands
Locale ID for country: Netherlands.
Definition: fs_common.h:246
foxit::common::Font::IsStandardFont
bool IsStandardFont(const pdf::PDFDoc &document)
Check whether current font is a standard font.
IFX_Pause
Definition: fx_basic.h:3758
foxit::common::e_FileFormatTypeFDF
File format type: FDF.
Definition: fs_common.h:266
foxit::common::Font::e_StyleNonSymbolic
Font style: non-symbolic.
Definition: fs_common.h:1540
foxit::common::Font::GetStyles
foxit::uint32 GetStyles(const pdf::PDFDoc &document)
Get font styles.
foxit::common::e_ColorSpaceDeviceCMYK
Color space: DeviceCMYK. (4 components, C, M, Y, K)
Definition: fs_common.h:208
foxit::common::e_ColorSpaceDeviceGray
Color space: DeviceGray. (1 component, gray)
Definition: fs_common.h:204
operator!=
bool operator!=(const char *str1, const CFX_ByteString &str2)
Check if two byte strings are not equal.
Definition: fs_basictypes.h:140
foxit::common::e_RotationPointLeftTop
Rotate the text block based on the left-top point of the rectangle.
Definition: fs_common.h:80
foxit::common::e_LocaleIDJapan
Locale ID for country: Japan.
Definition: fs_common.h:256
foxit::common::e_ModuleNameDWG2PDF
Name for module "DWG2PDF".
Definition: fs_common.h:180
foxit::common::GraphState::e_LineJoinBevel
Bevel line join type.
Definition: fs_common.h:1153
foxit::common::Font::e_StdIDHelveticaB
Standard font: Helvetica-Bold.
Definition: fs_common.h:1626
foxit::common::e_LocaleIDTaiwan
Locale ID for region: Taiwan.
Definition: fs_common.h:244
foxit::common::Library::SetRenderConfig
static void SetRenderConfig(const RenderConfig &render_config)
Set the rendering configuration.
foxit::common::Progressive::Progressive
Progressive(const Progressive &other)
Constructor, with another progressive object.
foxit::common::Color::ConvertToCMYK
Color ConvertToCMYK(ColorSpace::RenderingIntent intent=ColorSpace::e_RenderIntentRelColorimetric) const
Convert to a CMYK color.
foxit::common::Font::e_StdIDZapfDingbats
Standard font: ZapfDingbats.
Definition: fs_common.h:1642
foxit::common::Codec::FlateCompress
static String FlateCompress(const void *data_buffer, size_t length)
Compress the source data buffer by DEFLATE algorithm.
foxit::common::Library::SetActionCallback
static bool SetActionCallback(ActionCallback *action_callback)
Set a foxit::ActionCallback object to Foxit PDF SDK, in aid of performing PDF actions.
foxit::common::NotifierCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::common::GraphState::GraphState
GraphState()
Constructor.
Definition: fs_common.h:1181
foxit::common::Range::e_All
All the indexes within a range will be used.
Definition: fs_common.h:1377
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::common::e_PosBottomCenter
Position: bottom center.
Definition: fs_common.h:144
foxit::common::GraphState::e_LineCapButt
Butt cap. The stroke is squared off at the endpoint of a path. There is no projection beyond the end ...
Definition: fs_common.h:1117
foxit::common::e_ModuleName3D
Name for module "3D".
Definition: fs_common.h:186
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::common::Font::e_CharsetThai
Font charset: Thai.
Definition: fs_common.h:1572
foxit::common::e_ModuleNameAdvEdit
Name for module "AdvEdit".
Definition: fs_common.h:182
foxit::common::e_LocaleIDHongKong
Locale ID for region: HongKong.
Definition: fs_common.h:242
foxit::common::Library::GetVersion
static String GetVersion()
Get the version of current Foxit PDF SDK library.
foxit::common::Font::GetFamilyName
String GetFamilyName()
Retrieve the famliy name.
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::common::GraphState::e_LineCapSquare
Projecting square cap. The stroke continues beyond the endpoint of the path for a distance equal to h...
Definition: fs_common.h:1127
foxit::common::Color::operator==
bool operator==(const Color &other) const
Equal operator.
foxit::common::Library::UnregisterSecurityCallback
static bool UnregisterSecurityCallback(const char *filter)
Unregister a pdf::SecurityCallback object from Foxit PDF SDK.
foxit::pdf::annots::IconProviderCallback
Definition: fs_annot.h:1758
foxit::common::Font::e_CIDCharsetUNICODE
CID Font charset: Unicode.
Definition: fs_common.h:1606
foxit::common::Path::e_TypeBezierToCloseFigure
Indicates that this point is the ending point for a Bezier spline, and this point will also be connec...
Definition: fs_common.h:2198
foxit::common::Progressive::State
State
Enumeration for progress state.
Definition: fs_common.h:380
foxit::common::e_PosTopRight
Position: top right.
Definition: fs_common.h:134
foxit::common::Font::IsCharSupported
bool IsCharSupported(foxit::uint32 unicode, const pdf::PDFDoc &document) const
Check whether the character is supported by current font.
foxit::common::Library::MatchExternalFontsOnly
static void MatchExternalFontsOnly(bool only_match)
Specify whether to match fonts only from external fonts.
foxit::common::GraphState::e_LineJoinMiter
Miter line join type.
Definition: fs_common.h:1141
foxit::common::FontMapResult::FontMapResult
FontMapResult()
Constructor.
Definition: fs_common.h:2013
foxit::common::Font::operator!=
bool operator!=(const Font &other) const
Not equal operator.
foxit::common::e_LocaleIDUnspecified
Locale ID: Unspecified, used when locale is not specified.
Definition: fs_common.h:240
foxit::common::Path::MoveTo
bool MoveTo(const PointF &point)
Add a point to the end of current path, to start a new figure.
foxit::common::Library::HasModuleLicenseRight
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...
foxit::common::Range::e_Even
Only even numbers in a range will be used (discards odd numbers).
Definition: fs_common.h:1379
foxit::common::e_ModuleNameConversion
Name for module "Conversion".
Definition: fs_common.h:172
foxit::common::Font::GetCIDCharset
CIDCharset GetCIDCharset(const pdf::PDFDoc &document)
Get CID font charset.
foxit::common::ModuleName
ModuleName
Enumeration for module name which is used in license information.
Definition: fs_common.h:154
foxit::common::Font::e_StdIDSymbol
Standard font: Symbol.
Definition: fs_common.h:1640
foxit::common::e_Rotation180
Rotate 180 degrees in clockwise direction.
Definition: fs_common.h:63
foxit::common::Progressive::Continue
State Continue()
Continue the progressive process.
foxit::common::e_FileFormatTypeHTML
File format type: HTML.
Definition: fs_common.h:270
foxit::common::Font::e_CharsetSymbol
Font charset: Standard symbols.
Definition: fs_common.h:1562
foxit::common::e_ModuleNameConnectedPDF
(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".
Definition: fs_common.h:156
foxit::common::Progressive::e_ToBeContinued
Progress state: progress needs to be continued.
Definition: fs_common.h:384
FX_RECT
Definition: fx_coordinates.h:596
foxit::common::Path::~Path
~Path()
Destructor.
foxit::common::Font::GetDescent
int GetDescent() const
Get the descent value, in 1/1000 of em size (PDF units).
foxit::common::e_ColorSpaceIndexed
Color space: Indexed.
Definition: fs_common.h:222
foxit::common::Font::e_FontTypeType1
Font type: Type1.
Definition: fs_common.h:1652
foxit::common::Font
Definition: fs_common.h:1523
foxit::common::Library::Realloc
static void * Realloc(void *ptr, size_t new_size)
Reallocate a memory block.
foxit::common::Library::SetNotifierCallback
static bool SetNotifierCallback(NotifierCallback *notifier)
Set a NotifierCallback object to Foxit PDF SDK.
foxit::common::e_ModuleNameCompliance
Name for module "Compliance".
Definition: fs_common.h:168
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::common::Library::Free
static void Free(void *ptr)
Free a memory block.
foxit::common::RotationPointOptions
RotationPointOptions
Enumeration for rotation point options.
Definition: fs_common.h:76
foxit::common::Range::GetSegmentCount
int GetSegmentCount() const
Get the count of range segments.
foxit::common::Path::RemovePoint
bool RemovePoint(int index)
Remove a point specified by index.
foxit::common::Font::IsBold
bool IsBold() const
Judge whether current font is bold or not.
foxit::common::ColorSpace::e_RenderIntentRelColorimetric
Rendering intent: Relative Colorimetric.
Definition: fs_common.h:2425
foxit::common::Font::GetFontType
FontTypes GetFontType(const pdf::PDFDoc &document)
Get font type.
foxit::common::Library::SetAnnotIconProviderCallback
static bool SetAnnotIconProviderCallback(pdf::annots::IconProviderCallback *annot_icon_provider)
Set a customized pdf::annots::IconProviderCallback object to Foxit PDF SDK.
foxit::common::Progressive::e_Finished
Progress state: progress is finished.
Definition: fs_common.h:386
foxit::common::Font::e_CharsetDefault
Font charset: System default, for unknown or mapping purpose.
Definition: fs_common.h:1560
foxit::common::e_LocaleIDGermany
Locale ID for country: Germany.
Definition: fs_common.h:250
foxit::common::Library::Reinitialize
static ErrorCode Reinitialize()
Re-initialize Foxit PDF SDK Library.
foxit::common::e_ModuleNameLayoutRecognition
(Reserved, currently, this module is not provided) Name for module "LayoutRecognition".
Definition: fs_common.h:174
foxit::pdf::SignatureCallback
Definition: fs_signature.h:1453
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::common::e_PosCenterRight
Position: center right.
Definition: fs_common.h:140
foxit::common::ColorSpace::RenderingIntent
RenderingIntent
Enumeration for rendering intent.
Definition: fs_common.h:2421
foxit::common::RenderConfig::RenderConfig
RenderConfig(int graphics_objs_count_in_one_step)
Constructor, with parameter.
Definition: fs_common.h:440
foxit::common::e_ColorSpaceICCBasedDeviceRGB
Color space: ICCBased DeviceRGB. (3 components, R, G, B)
Definition: fs_common.h:228
foxit::common::Range
Definition: fs_common.h:1368
foxit::common::Color::GetValue
FloatArray GetValue() const
Get component value array.
foxit::common::LocaleID
LocaleID
Enumeration for locale ID.
Definition: fs_common.h:238
foxit::common::RenderConfig::operator!=
bool operator!=(const RenderConfig &render_config) const
Not equal operator.
Definition: fs_common.h:477
foxit::common::Range::Filter
Filter
Enumeration for range filter.
Definition: fs_common.h:1375
foxit::common::DocEventCallback::OnDocSaved
virtual void OnDocSaved(const pdf::PDFDoc &document, ErrorCode error_code)
Triggered when a PDF document is saved.
Definition: fs_common.h:1355
foxit::common::e_ColorSpaceICCBasedDeviceGray
Color space: ICCBased DeviceGray. (1 component, gray)
Definition: fs_common.h:226
foxit::common::e_LocaleIDItaly
Locale ID for country: Italy.
Definition: fs_common.h:252
foxit::common::Font::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::common::GraphState::GraphState
GraphState(const GraphState &state)
Constructor, with another graph state object.
Definition: fs_common.h:1193
foxit::common::Font::e_StdIDTimesB
Standard font: Times-Bold.
Definition: fs_common.h:1634
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
foxit::common::Font::~Font
~Font()
Destructor.
foxit::common::Font::e_StdIDCourierBI
Standard font: Courier-BoldOblique, Bold italic.
Definition: fs_common.h:1620
foxit::common::Path::operator!=
bool operator!=(const Path &other) const
Not equal operator.
foxit::Base
Definition: fs_basictypes.h:451
foxit::common::Font::e_StdIDHelveticaBI
Standard font: Helvetica-BoldOblique, Bold italic.
Definition: fs_common.h:1628
foxit::common::e_ModuleNameXFA
Name for module "XFA".
Definition: fs_common.h:158
foxit::common::e_LocaleIDFrance
Locale ID for country: France.
Definition: fs_common.h:248
foxit::common::RenderConfig::operator=
RenderConfig & operator=(const RenderConfig &render_config)
Assign operator.
Definition: fs_common.h:452
foxit::addon::xfa::AppProviderCallback
Definition: fs_xfa.h:119
foxit::common::Font::operator==
bool operator==(const Font &other) const
Equal operator.
foxit::common::RenderConfig::Set
void Set(int graphics_objs_count_in_one_step)
Set value.
Definition: fs_common.h:491
foxit::common::PauseCallback
IFX_Pause PauseCallback
Definition: fs_common.h:1292
foxit::common::e_ColorSpaceICCBasedDeviceCMYK
Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)
Definition: fs_common.h:230
foxit::common::RenderConfig
Definition: fs_common.h:432
foxit::common::Font::e_CIDCharsetUnknown
CID Font charset: Unknown.
Definition: fs_common.h:1596
foxit::common::GraphState::line_join
LineJoinStyle line_join
Line join style.
Definition: fs_common.h:1258
foxit::common::Path::Path
Path()
Constructor.
foxit::common::e_ModuleNameOFD
Name for module "OFD".
Definition: fs_common.h:188
foxit::common::Color::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::common::Path::e_TypeMoveTo
Indicates that the point is the first point of a figure.
Definition: fs_common.h:2182
foxit::common::Library::SetTimeStampCallback
static bool SetTimeStampCallback(pdf::TimeStampCallback *timestamp_callback)
Set a pdf::TimeStampCallback object to Foxit PDF SDK, in aid of interacting with time stamp server.
foxit::common::DocEventCallback::OnDocWillOpen
virtual void OnDocWillOpen()
Triggered when the document will be opened.
Definition: fs_common.h:1313