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 {
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 {
68 } Rotation;
69 
75 typedef enum _Alignment {
82 } Alignment;
83 
89 typedef enum _FillMode {
102 } FillMode;
103 
109 typedef enum _Position {
128 } Position;
129 
135 typedef enum _ModuleName {
170 } ModuleName;
171 
177 typedef enum _ColorSpaceType {
205 
211 typedef enum _LocaleID {
230 } LocaleID;
231 
237 typedef enum _FileFormatType {
255 
256 
257 #define CommonDefines foxit::common
258 
264 class Codec FS_FINAL : public Base {
265  public:
274  static String Base64Encode(const void* data_buffer, size_t length);
275 
284  static String Base64Decode(const void* encoded_data_buffer, size_t length);
285 
294  static String FlateCompress(const void* data_buffer, size_t length);
295 
304  static String FlateDecompress(const void* compressed_data_buffer, size_t length);
305 };
306 
316  public:
322  virtual void Release() = 0;
323 
336  virtual void OnOutOfMemory() = 0;
337 
338  protected:
339  ~NotifierCallback() {}
340 };
341 
346 class Progressive FS_FINAL : public Base {
347  public:
353  typedef enum _State {
355  e_Error = 0,
360  } State;
361 
367  Progressive(const Progressive& other);
369  ~Progressive();
370 
378  Progressive& operator = (const Progressive& other);
379 
388  State Continue();
389 
396  int GetRateOfProgress();
397 
398  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
399  explicit Progressive(FS_HANDLE handle = NULL);
400 };
405 class RenderConfig FS_FINAL : public Object {
406  public:
414 
417 
425  RenderConfig& operator = (const RenderConfig& render_config) {
427  return *this;
428  }
429 
437  bool operator == (const RenderConfig& render_config) const {
439  return true;
440  return false;
441  }
442 
450  bool operator != (const RenderConfig& render_config) const {
452  return true;
453  return false;
454  }
455 
465  this->graphics_objs_count_in_one_step = graphics_objs_count_in_one_step;
466  }
467 
481 };
482 
499 class Library FS_FINAL : public Object {
500  public:
517  static ErrorCode Initialize(const char* sn, const char* key);
518 
537  static ErrorCode Initialize(const char* sn, const char* key, bool is_optimize_memory);
538 
550  static ErrorCode Reinitialize();
551 
561  static void Release();
562 
577  static bool HasModuleLicenseRight(common::ModuleName module_name);
578 
584  static String GetVersion();
585 
597  static bool SetCacheSize(uint32 size);
598 
610  static bool EnableJavaScript(bool enable_javascript);
611 
612 #ifndef __EMSCRIPTEN_RENDER__
613 
635  static bool SetAnnotIconProviderCallback(pdf::annots::IconProviderCallback* annot_icon_provider);
636 #endif
637 
648  static bool SetNotifierCallback(NotifierCallback* notifier);
649 
664  static bool SetActionCallback(ActionCallback* action_callback);
665 
674  static bool SetDocEventCallback(DocEventCallback* callback);
675 
712  static bool RegisterSignatureCallback(const char* filter, const char* sub_filter,
713  pdf::SignatureCallback* signature_callback);
714 
749  static bool RegisterSecurityCallback(const char* filter, pdf::SecurityCallback* callback);
750 
769  static bool UnregisterSecurityCallback(const char* filter);
770 
790  static bool SetTimeStampCallback(pdf::TimeStampCallback* timestamp_callback);
791 
792  #ifndef _FX_NO_XFA_
793 
811  #endif // #ifndef _FX_NO_XFA_
812 
822  static void SetRenderTextGamma(float gamma);
823 
834  static void* Alloc(size_t size);
835 
843  static void Free(void* ptr);
844 
856  static void* Realloc(void* ptr, size_t new_size);
857 
868  static void SetLogFile(const char* log_file_path);
869 
880  static void SetLogFile(const wchar_t* log_file_path);
881 
893  static bool SetFontMapperCallback(FontMapperCallback* callback);
894 
908  static void SetDefaultICCProfilesPath(const wchar_t* icc_profile_folder_path);
909 
915  static RenderConfig GetRenderConfig();
916 
924  static void SetRenderConfig(const RenderConfig& render_config);
925 
936  static void EnableThreadSafety(bool is_enable_thread_safety);
937 
938 #if defined(_WIN32) || defined(_WIN64)|| defined(__linux__)
939 
955  static ErrorCode InitializeOFDEngine(const char* ofd_library_path);
956 
965  static void ReleaseOFDEngine();
966 #endif
967  private:
968  Library(const Library&);
969  Library& operator = (const Library&);
970 };
972 class GraphState FS_FINAL : public Object {
973  public:
980  typedef enum _LineCapStyle {
996  } LineCapStyle;
997 
1004  typedef enum _LineJoinStyle {
1022  } LineJoinStyle;
1023 
1024 
1040  this->line_width = line_width;
1041  this->line_join = line_join;
1042  this->miter_limit = miter_limit;
1043  this->line_cap = line_cap;
1044  this->dash_phase = dash_phase;
1045  this->dashes = dashes;
1046  }
1047 
1050  : line_width(1.0f)
1052  , miter_limit(10*1.0f)
1054  , dash_phase(0) {}
1055 
1061  GraphState(const GraphState& state) {
1062  this->line_width = state.line_width;
1063  this->line_join = state.line_join;
1064  this->miter_limit = state.miter_limit;
1065  this->line_cap = state.line_cap;
1066  this->dash_phase = state.dash_phase;
1067  this->dashes = state.dashes;
1068  }
1069 
1078  this->line_width = state.line_width;
1079  this->line_join = state.line_join;
1080  this->miter_limit = state.miter_limit;
1081  this->line_cap = state.line_cap;
1082  this->dash_phase = state.dash_phase;
1083  this->dashes = state.dashes;
1084  return *this;
1085  }
1086 
1103  const FloatArray& dashes) {
1104  this->line_width = line_width;
1105  this->line_join = line_join;
1106  this->miter_limit = miter_limit;
1107  this->line_cap = line_cap;
1108  this->dash_phase = dash_phase;
1109  this->dashes = dashes;
1110  }
1111 
1118  float line_width;
1145 
1147  float dash_phase;
1148 
1153 };
1154 
1161 
1168  public:
1174  virtual void Release() = 0;
1175 
1181  virtual void OnDocWillOpen() {}
1182 
1193  virtual void OnDocOpened(const pdf::PDFDoc& document, ErrorCode error_code) {}
1194 
1202  virtual void OnDocWillDestroy(const pdf::PDFDoc& document) {}
1203 
1211  virtual void OnDocWillSave(const pdf::PDFDoc& document) {}
1212 
1223  virtual void OnDocSaved(const pdf::PDFDoc& document, ErrorCode error_code) {}
1224 
1225  protected:
1226  ~DocEventCallback() {}
1227 };
1228 
1236 class Range FS_FINAL : public Base {
1237  public:
1243  typedef enum _Filter {
1245  e_All = 0,
1247  e_Even = 1,
1249  e_Odd = 2
1250  } Filter;
1251 
1253  Range();
1254 
1260  explicit Range(int index);
1261 
1274  explicit Range(int start_index, int end_index, Filter filter = e_All);
1275 
1281  Range(const Range& other);
1282 
1284  ~Range();
1285 
1293  Range& operator = (const Range& other);
1294 
1302  bool operator == (const Range& other) const;
1303 
1311  bool operator != (const Range& other) const;
1312 
1320  bool IsEmpty() const;
1321 
1327  void AddSingle( int index );
1328 
1343  void AddSegment( int start_index, int end_index, Filter filter = e_All );
1344 
1350  int GetSegmentCount() const;
1351 
1360  int GetSegmentStart(int segment_index) const;
1361 
1370  int GetSegmentEnd(int segment_index) const;
1371 
1377  void RemoveAll();
1378 
1379  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1380  explicit Range(FS_HANDLE handle);
1381 };
1382 
1391 class Font FS_FINAL : public Base {
1392  public:
1398  typedef enum _Styles {
1402  e_StyleSerif = 0x0002,
1406  e_StyleScript = 0x0008,
1410  e_StyleItalic = 0x0040,
1412  e_StyleAllCap = 0x10000,
1414  e_StylesSmallCap = 0x20000,
1416  e_StylesBold = 0x40000
1417  } Styles;
1418 
1424  typedef enum _Charset {
1455  } Charset;
1456 
1462  typedef enum _CIDCharset {
1475  } CIDCharset;
1476 
1482  typedef enum _StandardID {
1511  } StandardID;
1512 
1518  typedef enum _FontTypes {
1527  } FontTypes;
1528 
1541  Font(const wchar_t* name, uint32 styles, Charset charset, int weight);
1542 
1549  explicit Font(StandardID font_id);
1550 
1560  Font(const char* font_file_path, int face_index, Charset charset);
1561 
1571  Font(const wchar_t* font_file_path, int face_index, Charset charset);
1572 
1573  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1574  explicit Font(FS_HANDLE handle = NULL);
1575 
1581  Font(const Font& other);
1582 
1590  Font& operator = (const Font& other);
1591 
1599  bool operator == (const Font& other) const;
1600 
1608  bool operator != (const Font& other) const;
1609 
1617  bool IsEmpty() const;
1618 
1620  ~Font();
1621 
1627  WString GetName();
1628 
1635 
1641  bool IsBold() const;
1642 
1648  bool IsItalic() const;
1649 
1657  bool IsEmbedded(const pdf::PDFDoc& document);
1658 
1667  bool IsSupportEmbedded(const pdf::PDFDoc& document);
1668 
1681  Font Embed(pdf::PDFDoc document, bool is_add_all_unicodes = true);
1682 
1693  UInt32Array AddUnicodes(const pdf::PDFDoc& document, const UInt32Array& unicode_array);
1694 
1695 #ifdef _FONT_GETWOFFDATA_
1696 
1703  String GetWoffData(pdf::PDFDoc document);
1704 #endif
1705 
1711  int GetAscent() const;
1712 
1718  int GetDescent() const;
1719 
1727  RectI GetCharBBox(uint32 unicode) const;
1728 
1736  float GetCharWidth(uint32 unicode) const;
1737 
1746  RectI GetCharBBox(foxit::uint32 unicode,const foxit::pdf::PDFDoc& document);
1747 
1756  float GetCharWidth(foxit::uint32 unicode,const foxit::pdf::PDFDoc& document);
1757 
1766  foxit::uint32 GetStyles(const pdf::PDFDoc& document);
1767 
1779  CIDCharset GetCIDCharset(const pdf::PDFDoc& document);
1780 
1788  bool IsStandardFont(const pdf::PDFDoc& document);
1789 
1801  StandardID GetStandard14Font(const pdf::PDFDoc& document);
1802 
1811  FontTypes GetFontType(const pdf::PDFDoc& document);
1812 
1820  String GetBaseFontName(const pdf::PDFDoc& document);
1821 
1830  bool IsVertWriting(const pdf::PDFDoc& document);
1831 
1840  String GetEncoding(const pdf::PDFDoc& document);
1841 
1853  bool SetEncoding(const pdf::PDFDoc& document, const char* value);
1854 };
1855 
1860 class FontMapResult FS_FINAL : public Object {
1861  public:
1864 
1879  this->file_read = file_read;
1880  this->face_index = face_index;
1881  }
1882 
1889  this->file_read = other.file_read;
1890  this->face_index = other.face_index;
1891  }
1892 
1901  this->file_read = other.file_read;
1902  this->face_index = other.face_index;
1903  return *this;
1904  }
1905 
1913  bool operator == (const FontMapResult& other) const {
1914  if (this->file_read != other.file_read || this->face_index != other.face_index)
1915  return false;
1916  return true;
1917  }
1918 
1926  bool operator != (const FontMapResult& other) const {
1927  return !(*this == other);
1928  }
1929 
1944  this->file_read = file_read;
1945  this->face_index = face_index;
1946  }
1947 
1963 };
1964 
1974  public:
1980  virtual void Release() = 0;
1981 
1997  virtual FontMapResult MapFont(const char* font_name, bool is_truetype, uint32 styles,
1998  int weight, int italic_angle, Font::Charset charset) = 0;
1999 
2000  protected:
2001  ~FontMapperCallback() {}
2002 };
2003 
2005 class Path FS_FINAL : public Base {
2006  public:
2012  typedef enum _PointType {
2031  } PointType;
2032 
2034  Path();
2036  ~Path();
2042  Path(const Path& other);
2050  Path& operator=(const Path& other);
2058  bool operator ==(const Path& other) const;
2066  bool operator != (const Path& other) const;
2067 
2075  bool IsEmpty() const;
2076 
2082  int GetPointCount();
2083 
2092  PointF GetPoint(int index);
2093 
2103  PointType GetPointType(int index);
2104 
2116  bool SetPoint(int index, const PointF& point, PointType type);
2117 
2128  bool MoveTo(const PointF& point);
2129 
2139  bool LineTo(const PointF& point);
2140 
2153  bool CubicBezierTo(const PointF& point1, const PointF& point2, const PointF& point3);
2154 
2174  bool CloseFigure();
2175 
2184  bool RemovePoint(int index);
2185 
2193  bool AppendRect(const RectF& rect);
2194 
2202  bool AppendEllipse(const RectF& rect);
2203 
2211  void Transform(const Matrix& matrix);
2217  void Clear();
2218 
2231  void IncreasePointCount(int count);
2232 
2233  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2234  explicit Path(FS_HANDLE handle);
2235 };
2236 
2238 FSDK_DEFINE_ARRAY(PathArray, Path)
2239 
2240 
2243 class ColorSpace FS_FINAL : public Base {
2244  public:
2253  typedef enum _RenderingIntent {
2255  e_RenderIntentPerceptual = 0,
2257  e_RenderIntentRelColorimetric = 1,
2259  e_RenderIntentSaturation = 2,
2261  e_RenderIntentAbsColorimetric = 3
2262  } RenderingIntent;
2263 
2264 
2265  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2266  explicit ColorSpace(FS_HANDLE handle);
2267 
2278  ~ColorSpace();
2279 
2285  ColorSpace(const ColorSpace& other);
2286 
2294  ColorSpace& operator=(const ColorSpace& other);
2295 
2304  bool operator==(const ColorSpace& other) const;
2305 
2314  bool operator!=(const ColorSpace& other) const;
2315 
2323  bool IsEmpty() const;
2324 
2332  int GetComponentCount() const;
2333 
2340  foxit::common::ColorSpaceType GetColorSpaceType() const;
2341 
2347  bool IsSpotColorSpace() const;
2348 
2365  StringArray GetComponentNames() const;
2366 
2375  Color ConvertColor(const Color& color);
2376 
2387  Color ConvertColor(int r_value, int g_value, int b_value);
2388 
2400  Color ConvertColor(int c_value, int m_value, int y_value, int k_value);
2401 };
2402 
2406 class Color FS_FINAL : public Base {
2407  public:
2408  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2409  explicit Color(FS_HANDLE handle);
2410 
2412  Color();
2418  explicit Color(const ColorSpace& color_space);
2420  ~Color();
2421 
2427  Color(const Color& other);
2428 
2436  Color& operator=(const Color& other);
2437 
2445  bool operator==(const Color& other) const;
2446 
2454  bool operator!=(const Color& other) const;
2455 
2463  bool IsEmpty() const;
2464 
2471 
2481  FloatArray GetValue() const;
2482 
2495  void SetValue(const FloatArray& component_array);
2496 
2506 
2516 };
2517 } // namespace common
2518 } // namespace foxit
2519 
2520 #endif // FS_COMMON_H_
2521 
foxit::common::FontMapperCallback
Definition: fs_common.h:1973
foxit::common::Font::e_CharsetANSI
Font charset: ANSI (United States, Western Europe).
Definition: fs_common.h:1426
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:980
foxit::common::Font::e_StdIDTimesBI
Standard font: Times-BoldItalic.
Definition: fs_common.h:1504
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:117
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:101
foxit::common::FileFormatType
FileFormatType
Enumeration for file format type.
Definition: fs_common.h:237
foxit::common::Path::GetPointType
PointType GetPointType(int index)
Get the type of a point specified by index.
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:214
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:1448
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:1952
foxit::ActionCallback
Definition: fs_actioncallback.h:2158
foxit::common::Font::e_CharsetEastEurope
Font charset: Eastern European.
Definition: fs_common.h:1442
foxit::common::RenderConfig::RenderConfig
RenderConfig()
Constructor.
Definition: fs_common.h:416
foxit::common::e_ColorSpacePattern
Color space: Pattern.
Definition: fs_common.h:197
foxit::common::GraphState::LineJoinStyle
LineJoinStyle
Enumeration for line join style.
Definition: fs_common.h:1004
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:1913
foxit::common::Color
Definition: fs_common.h:2406
foxit::common::ColorSpace
Definition: fs_common.h:2243
foxit::common::e_ColorSpaceDeviceN
Color space: DeviceN.
Definition: fs_common.h:195
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:1482
foxit::common::e_FillModeNone
Fill mode: none.
Definition: fs_common.h:91
foxit::common::Font::e_CharsetArabic
Font charset: Arabic.
Definition: fs_common.h:1452
foxit::common::DocEventCallback
Definition: fs_common.h:1167
foxit::StringArray
Definition: fs_basictypes.h:230
foxit::common::Font::e_CharsetRussian
Font charset: Russian.
Definition: fs_common.h:1444
foxit::common::GraphState::line_cap
LineCapStyle line_cap
Line cap style.
Definition: fs_common.h:1144
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:109
foxit::common::e_FileFormatTypeXFD
File format type: XFD.
Definition: fs_common.h:249
foxit::common::Font::e_CharsetChineseBig5
Font charset: Traditional Chinese.
Definition: fs_common.h:1438
foxit::common::e_ModuleNameTableMaker
Name for module "TableMaker".
Definition: fs_common.h:159
foxit::common::Font::FontTypes
FontTypes
Enumeration for font type.
Definition: fs_common.h:1518
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:221
foxit::common::Font::e_FontTypeType3
Font type: Type3.
Definition: fs_common.h:1524
foxit::common::GraphState
Definition: fs_common.h:972
foxit::common::Font::e_StdIDCourierB
Standard font: Courier-Bold.
Definition: fs_common.h:1486
foxit::common::e_Rotation0
No rotation.
Definition: fs_common.h:59
foxit::common::Progressive
Definition: fs_common.h:346
foxit::common::Font::e_StylesSmallCap
Font style: small cap.
Definition: fs_common.h:1414
foxit::common::e_PosBottomLeft
Position: bottom left.
Definition: fs_common.h:123
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:2012
foxit::common::Font::e_StdIDTimesI
Standard font: Times-Italic.
Definition: fs_common.h:1506
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:1077
foxit::common::Font::e_StyleAllCap
Font style: all cap.
Definition: fs_common.h:1412
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:189
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::PathArray
Definition: fs_common.h:2238
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:1490
foxit::common::Library
Definition: fs_common.h:499
foxit::common::e_ModuleNameAccessibility
Name for module "Accessibility".
Definition: fs_common.h:157
foxit::common::NotifierCallback
Definition: fs_common.h:315
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:81
foxit::common::FontMapResult::Set
void Set(foxit::common::file::ReaderCallback *file_read, int face_index)
Set value.
Definition: fs_common.h:1943
foxit::common::Font::e_CIDCharsetKOREA1
CID Font charset: Adobe-Korea1.
Definition: fs_common.h:1472
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:480
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:247
foxit::common::Font::e_CIDCharsetJAPAN1
CID Font charset: Adobe-Japan1.
Definition: fs_common.h:1470
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:1193
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:1888
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:179
foxit::common::Font::e_StdIDHelveticaI
Standard font: Helvetica-Oblique, Italic.
Definition: fs_common.h:1498
foxit::common::Range::RemoveAll
void RemoveAll()
Remove all range segments.
foxit::common::e_ModuleNameComparison
Name for module "Comparison".
Definition: fs_common.h:147
foxit::common::GraphState::miter_limit
float miter_limit
The miter limit for line join.
Definition: fs_common.h:1136
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:75
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
A callback function used to map a suitable font according to input parameters.
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:1038
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:570
foxit::common::Font::e_StylesBold
Font style: force bold.
Definition: fs_common.h:1416
foxit::common::Font::e_CharsetHangeul
Font charset: Korean (Wansung).
Definition: fs_common.h:1434
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:1432
foxit::common::Font::e_CharsetGB2312
Font charset: Simplified Chinese.
Definition: fs_common.h:1436
foxit::common::Font::e_StyleSymbolic
Font style: symbolic.
Definition: fs_common.h:1404
foxit::common::Color::ConvertToRGB
Color ConvertToRGB(ColorSpace::RenderingIntent intent=ColorSpace::e_RenderIntentRelColorimetric) const
Convert to a RGB color.
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:237
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:264
foxit::common::Font::e_CIDCharsetCNS1
CID Font charset: Adobe-CNS1.
Definition: fs_common.h:1468
foxit::common::e_ModuleNameRedaction
Name for module "Redaction".
Definition: fs_common.h:141
foxit::common::RenderConfig::operator==
bool operator==(const RenderConfig &render_config) const
Equal operator.
Definition: fs_common.h:437
foxit::common::GraphState::dash_phase
float dash_phase
Dash phase for dash pattern.
Definition: fs_common.h:1147
foxit::common::e_AlignmentLeft
Left alignment.
Definition: fs_common.h:77
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:2005
foxit::common::GraphState::e_LineJoinRound
Round line join type.
Definition: fs_common.h:1015
foxit::common::e_AlignmentCenter
Center alignment.
Definition: fs_common.h:79
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::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:1462
foxit::common::Progressive::~Progressive
~Progressive()
Destructor.
foxit::common::Font::e_StyleItalic
Font style: italic.
Definition: fs_common.h:1410
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:143
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:1466
foxit::common::e_PosBottomRight
Position: bottom right.
Definition: fs_common.h:127
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:1202
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:1500
foxit::common::e_PosCenter
Position: center.
Definition: fs_common.h:119
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:1900
foxit::common::e_PosTopLeft
Position: top left.
Definition: fs_common.h:111
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:177
foxit::common::Range::e_Odd
Only odd numbers in a range will be used (discards even numbers).
Definition: fs_common.h:1249
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:1102
foxit::common::DocEventCallback::OnDocWillSave
virtual void OnDocWillSave(const pdf::PDFDoc &document)
Triggered when a PDF document will be saved.
Definition: fs_common.h:1211
foxit::common::FontMapResult::operator!=
bool operator!=(const FontMapResult &other) const
Not equal operator.
Definition: fs_common.h:1926
foxit::pdf::SecurityCallback
Definition: fs_security.h:1211
foxit::common::FontMapResult::face_index
int face_index
Face index. This is a zero-based index value:
Definition: fs_common.h:1962
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:990
foxit::common::e_ColorSpaceLab
Color space: Lab. (3 components, A, B, C)
Definition: fs_common.h:191
foxit::common::Font::Charset
Charset
Enumeration for font charset.
Definition: fs_common.h:1424
foxit::common::e_PosTopCenter
Position: top center.
Definition: fs_common.h:113
foxit::common::Color::operator=
Color & operator=(const Color &other)
Assign operator.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::common::FontMapResult
Definition: fs_common.h:1860
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:2024
foxit::common::e_FileFormatTypeTXT
File format type: TXT.
Definition: fs_common.h:253
foxit::common::e_ColorSpaceCalGray
Color space: CalGray. (1 component, A)
Definition: fs_common.h:187
foxit::common::Font::e_StyleScript
Font style: script.
Definition: fs_common.h:1406
foxit::common::Font::e_StdIDHelvetica
Standard font: Helvetica.
Definition: fs_common.h:1492
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:2022
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:151
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:96
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_RotationUnknown
Unknown rotation.
Definition: fs_common.h:67
foxit::common::Path::GetPointCount
int GetPointCount()
Get the count of points.
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:2016
foxit::common::Font::e_StyleFixedPitch
Font style: fixed pitch.
Definition: fs_common.h:1400
foxit::common::e_ModuleNameOCR
Name for module "OCR".
Definition: fs_common.h:145
foxit::common::e_ColorSpaceSeparation
Color space: Separation.
Definition: fs_common.h:193
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:89
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:1398
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:183
foxit::common::Font::e_CharsetHebrew
Font charset: Hebrew.
Definition: fs_common.h:1450
foxit::common::e_LocaleIDKorea
Locale ID for country: Korea.
Definition: fs_common.h:227
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:1152
foxit::common::e_FileFormatTypeXFDF
File format type: XFDF.
Definition: fs_common.h:241
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:165
foxit::common::Font::e_FontTypeCIDFont
Font type: CID font.
Definition: fs_common.h:1526
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::common::e_FileFormatTypePDF
File format type: PDF.
Definition: fs_common.h:251
foxit::common::e_FileFormatTypeXDP
File format type: XDP.
Definition: fs_common.h:245
foxit::common::FontMapResult::FontMapResult
FontMapResult(foxit::common::file::ReaderCallback *file_read, int face_index)
Constructor, with parameters.
Definition: fs_common.h:1878
foxit::common::Range::operator=
Range & operator=(const Range &other)
Assign operator.
foxit::common::Font::e_StyleSerif
Font style: serif.
Definition: fs_common.h:1402
foxit::common::Progressive::e_Error
Progress state: any error occurs.
Definition: fs_common.h:355
foxit::common::Font::e_FontTypeTrueType
Font type: TrueType.
Definition: fs_common.h:1522
foxit::common::Font::e_CharsetBaltic
Font charset: Baltic.
Definition: fs_common.h:1454
foxit::common::Font::e_CharsetGreek
Font charset: Greek.
Definition: fs_common.h:1446
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:1484
foxit::common::GraphState::line_width
float line_width
Line width.
Definition: fs_common.h:1118
foxit::common::e_LocaleIDNetherlands
Locale ID for country: Netherlands.
Definition: fs_common.h:219
foxit::common::Font::IsStandardFont
bool IsStandardFont(const pdf::PDFDoc &document)
Check whether current font is a standard font.
IFX_Pause
Definition: fx_basic.h:3761
foxit::common::e_FileFormatTypeFDF
File format type: FDF.
Definition: fs_common.h:239
foxit::common::Font::e_StyleNonSymbolic
Font style: non-symbolic.
Definition: fs_common.h:1408
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:185
foxit::common::e_ColorSpaceDeviceGray
Color space: DeviceGray. (1 component, gray)
Definition: fs_common.h:181
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_LocaleIDJapan
Locale ID for country: Japan.
Definition: fs_common.h:229
foxit::common::e_ModuleNameDWG2PDF
Name for module "DWG2PDF".
Definition: fs_common.h:161
foxit::common::GraphState::e_LineJoinBevel
Bevel line join type.
Definition: fs_common.h:1021
foxit::common::Font::e_StdIDHelveticaB
Standard font: Helvetica-Bold.
Definition: fs_common.h:1494
foxit::common::e_LocaleIDTaiwan
Locale ID for region: Taiwan.
Definition: fs_common.h:217
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:1510
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:1049
foxit::common::Range::e_All
All the indexes within a range will be used.
Definition: fs_common.h:1245
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:780
foxit::common::e_PosBottomCenter
Position: bottom center.
Definition: fs_common.h:125
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:985
foxit::common::e_ModuleName3D
Name for module "3D".
Definition: fs_common.h:167
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::common::Font::e_CharsetThai
Font charset: Thai.
Definition: fs_common.h:1440
foxit::common::e_ModuleNameAdvEdit
Name for module "AdvEdit".
Definition: fs_common.h:163
foxit::common::e_LocaleIDHongKong
Locale ID for region: HongKong.
Definition: fs_common.h:215
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:610
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:995
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:1748
foxit::common::Font::e_CIDCharsetUNICODE
CID Font charset: Unicode.
Definition: fs_common.h:1474
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:2030
foxit::common::Progressive::State
State
Enumeration for progress state.
Definition: fs_common.h:353
foxit::common::e_PosTopRight
Position: top right.
Definition: fs_common.h:115
foxit::common::GraphState::e_LineJoinMiter
Miter line join type.
Definition: fs_common.h:1009
foxit::common::FontMapResult::FontMapResult
FontMapResult()
Constructor.
Definition: fs_common.h:1863
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:213
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:1247
foxit::common::e_ModuleNameConversion
Name for module "Conversion".
Definition: fs_common.h:153
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:135
foxit::common::Font::e_StdIDSymbol
Standard font: Symbol.
Definition: fs_common.h:1508
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:243
foxit::common::Font::e_CharsetSymbol
Font charset: Standard symbols.
Definition: fs_common.h:1430
foxit::common::e_ModuleNameConnectedPDF
(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".
Definition: fs_common.h:137
foxit::common::Progressive::e_ToBeContinued
Progress state: progress needs to be continued.
Definition: fs_common.h:357
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::Font::e_FontTypeType1
Font type: Type1.
Definition: fs_common.h:1520
foxit::common::Font
Definition: fs_common.h:1391
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:149
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::common::Library::Free
static void Free(void *ptr)
Free a memory block.
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:2257
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:359
foxit::common::Font::e_CharsetDefault
Font charset: System default, for unknown or mapping purpose.
Definition: fs_common.h:1428
foxit::common::e_LocaleIDGermany
Locale ID for country: Germany.
Definition: fs_common.h:223
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:155
foxit::pdf::SignatureCallback
Definition: fs_signature.h:1453
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
foxit::common::e_PosCenterRight
Position: center right.
Definition: fs_common.h:121
foxit::common::ColorSpace::RenderingIntent
RenderingIntent
Enumeration for rendering intent.
Definition: fs_common.h:2253
foxit::common::RenderConfig::RenderConfig
RenderConfig(int graphics_objs_count_in_one_step)
Constructor, with parameter.
Definition: fs_common.h:413
foxit::common::e_ColorSpaceICCBasedDeviceRGB
Color space: ICCBased DeviceRGB. (3 components, R, G, B)
Definition: fs_common.h:201
foxit::common::Range
Definition: fs_common.h:1236
foxit::common::Color::GetValue
FloatArray GetValue() const
Get component value array.
foxit::common::LocaleID
LocaleID
Enumeration for locale ID.
Definition: fs_common.h:211
foxit::common::RenderConfig::operator!=
bool operator!=(const RenderConfig &render_config) const
Not equal operator.
Definition: fs_common.h:450
foxit::common::Range::Filter
Filter
Enumeration for range filter.
Definition: fs_common.h:1243
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:1223
foxit::common::e_ColorSpaceICCBasedDeviceGray
Color space: ICCBased DeviceGray. (1 component, gray)
Definition: fs_common.h:199
foxit::common::e_LocaleIDItaly
Locale ID for country: Italy.
Definition: fs_common.h:225
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:1061
foxit::common::Font::e_StdIDTimesB
Standard font: Times-Bold.
Definition: fs_common.h:1502
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
foxit::common::Font::~Font
~Font()
Destructor.
foxit::common::Font::e_StdIDCourierBI
Standard font: Courier-BoldOblique, Bold italic.
Definition: fs_common.h:1488
foxit::common::Path::operator!=
bool operator!=(const Path &other) const
Not equal operator.
foxit::Base
Definition: fs_basictypes.h:427
foxit::common::Font::e_StdIDHelveticaBI
Standard font: Helvetica-BoldOblique, Bold italic.
Definition: fs_common.h:1496
foxit::common::e_ModuleNameXFA
Name for module "XFA".
Definition: fs_common.h:139
foxit::common::e_LocaleIDFrance
Locale ID for country: France.
Definition: fs_common.h:221
foxit::common::RenderConfig::operator=
RenderConfig & operator=(const RenderConfig &render_config)
Assign operator.
Definition: fs_common.h:425
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:464
foxit::common::PauseCallback
IFX_Pause PauseCallback
Definition: fs_common.h:1160
foxit::common::e_ColorSpaceICCBasedDeviceCMYK
Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)
Definition: fs_common.h:203
foxit::common::RenderConfig
Definition: fs_common.h:405
foxit::common::Font::e_CIDCharsetUnknown
CID Font charset: Unknown.
Definition: fs_common.h:1464
foxit::common::GraphState::line_join
LineJoinStyle line_join
Line join style.
Definition: fs_common.h:1126
foxit::common::Path::Path
Path()
Constructor.
foxit::common::e_ModuleNameOFD
Name for module "OFD".
Definition: fs_common.h:169
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:2014
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:1181