Foxit PDF SDK
fs_convert.h
Go to the documentation of this file.
1 
15 #ifndef FS_CONVERT_H_
16 #define FS_CONVERT_H_
17 
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 #include "pdf/fs_pdfpage.h"
21 
27 namespace foxit {
31 namespace addon {
35 namespace conversion {
37 class HTML2PDFSettingData FS_FINAL : public Object{
38  public:
44  typedef enum _HTML2PDFPageMode {
50 
56  typedef enum _HTML2PDFScalingMode {
64 
70  typedef enum _HTML2PDFEncodingFormat {
220 
226  typedef enum _HTML2PDFMediaStyle {
232 
233 
236  : page_width(0)
237  , page_height(0)
238  , is_to_page_scale(false)
239  , page_margin(0.0f, 0.0f, 0.0f, 0.0f)
240  , rotate_degrees(common::e_Rotation0)
241  , is_convert_link(false)
242  , is_generate_tag(false)
244  , to_generate_bookmarks(false)
247  , to_render_images(true)
249  , to_set_headerfooter(false)
250  , headerfooter_title(L"")
251  , headerfooter_url(L"")
252  , bookmark_root_name(L"")
253  , to_resize_objects(false)
254  , to_print_background(true)
255  , to_optimize_tag_tree(false)
257  , to_load_active_content(false)
258  , to_disable_sandbox(true)
259  , to_use_blacklist(false)
260  , to_hide_header(false)
261  , to_hide_footer(false)
262  , to_deny_local_file_access(false) {}
263 
306  const wchar_t* headerfooter_url, const wchar_t* bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree,
309  this->page_width = page_width;
310  this->page_height = page_height;
311  this->is_to_page_scale = is_to_page_scale;
312  this->page_margin = page_margin;
313  this->is_convert_link = is_convert_link;
314  this->rotate_degrees = rotate_degrees;
315  this->is_generate_tag = is_generate_tag;
316  this->page_mode = page_mode;
317  this->to_generate_bookmarks = to_generate_bookmarks;
318  this->scaling_mode = scaling_mode;
319  this->encoding_format = encoding_format;
320  this->to_render_images = to_render_images;
321  this->to_remove_underline_for_link = to_remove_underline_for_link;
322  this->to_set_headerfooter = to_set_headerfooter;
323  this->headerfooter_title = headerfooter_title;
324  this->headerfooter_url = headerfooter_url;
325  this->bookmark_root_name = bookmark_root_name;
326  this->to_resize_objects = to_resize_objects;
327  this->to_print_background = to_print_background;
328  this->to_optimize_tag_tree = to_optimize_tag_tree;
329  this->media_style = media_style;
330  this->to_load_active_content = to_load_active_content;
331  this->to_disable_sandbox = to_disable_sandbox;
332  this->to_use_blacklist = to_use_blacklist;
333  this->to_hide_header = to_hide_header;
334  this->to_hide_footer = to_hide_footer;
335  this->to_deny_local_file_access = to_deny_local_file_access;
336  }
337 
346  page_width = data.page_width;
347  page_height = data.page_height;
349  page_margin = data.page_margin;
353  page_mode = data.page_mode;
355  scaling_mode = data.scaling_mode;
366  media_style = data.media_style;
373  return (*this);
374  }
375 
418  const wchar_t* headerfooter_title, const wchar_t* headerfooter_url, const wchar_t* bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree,
421  this->page_width = page_width;
422  this->page_height = page_height;
423  this->is_to_page_scale = is_to_page_scale;
424  this->page_margin = page_margin;
425  this->is_convert_link = is_convert_link;
426  this->rotate_degrees = rotate_degrees;
427  this->is_generate_tag = is_generate_tag;
428  this->page_mode = page_mode;
429  this->to_generate_bookmarks = to_generate_bookmarks;
430  this->scaling_mode = scaling_mode;
431  this->encoding_format = encoding_format;
432  this->to_render_images = to_render_images;
433  this->to_remove_underline_for_link = to_remove_underline_for_link;
434  this->to_set_headerfooter = to_set_headerfooter;
435  this->headerfooter_title = headerfooter_title;
436  this->headerfooter_url = headerfooter_url;
437  this->bookmark_root_name = bookmark_root_name;
438  this->to_resize_objects = to_resize_objects;
439  this->to_print_background = to_print_background;
440  this->to_optimize_tag_tree = to_optimize_tag_tree;
441  this->media_style = media_style;
442  this->to_load_active_content = to_load_active_content;
443  this->to_disable_sandbox = to_disable_sandbox;
444  this->to_use_blacklist = to_use_blacklist;
445  this->to_hide_header = to_hide_header;
446  this->to_hide_footer = to_hide_footer;
447  this->to_deny_local_file_access = to_deny_local_file_access;
448  }
449 
455  float page_width;
456 
464  float page_height;
465 
473 
481 
487 
490 
493 
499 
502 
508 
513 
516 
519 
522 
525 
528 
531 
534 
537 
540 
546 
555 
562 
590 
593 
596 
605 };
606 
608 class TXT2PDFSettingData FS_FINAL : public Object {
609  public:
612  : page_width(0)
613  , page_height(0)
614  , text_size(0)
615  , text_color(0xFF000000)
616  , linespace(0)
617  , is_break_page(false) {
618  }
619 
635  ARGB text_color, float linespace, bool is_break_page) {
636  this->page_width = page_width;
637  this->page_height = page_height;
638  this->page_margin = page_margin;
639  this->font = font;
640  this->text_size = text_size;
641  this->text_color = text_color;
642  this->linespace = linespace;
643  this->is_break_page = is_break_page;
644  }
645 
654  page_width = data.page_width;
655  page_height = data.page_height;
656  page_margin = data.page_margin;
657  font = data.font;
658  text_size = data.text_size;
659  text_color = data.text_color;
660  linespace = data.linespace;
662  return (*this);
663  }
664 
680  ARGB text_color, float linespace, bool is_break_page) {
681  this->page_width = page_width;
682  this->page_height = page_height;
683  this->page_margin = page_margin;
684  this->font = font;
685  this->text_size = text_size;
686  this->text_color = text_color;
687  this->linespace = linespace;
688  this->is_break_page = is_break_page;
689  }
690 
692  float page_width;
693 
695  float page_height;
696 
704 
707 
709  float text_size;
710 
713 
715  float linespace;
716 
719 };
720 
727  public:
733  virtual void Release() = 0;
742  virtual void OnProgress(const wchar_t* message, float progress) = 0;
743  };
744 
751 class DWG2PDFSettingData FS_FINAL : public Object {
752  public:
758  typedef enum _DWG2PDFExportFlags {
786  e_FlagUseHLR = 0x0080,
804 
810  typedef enum _DWG2PDFExportHatchesType {
820 
826  typedef enum _DWG2PDFSearchableTextType {
834 
840  typedef enum _DWG2PDFColorPolicy {
848 
849 
854  : export_flags(1)
859  , is_active_layout(false)
860  , paper_width(0.0f)
861  , paper_height(0.0f)
863  , is_output_progress(true)
865 
874  export_flags = data.export_flags;
880  output_title = data.output_title;
886  paper_width = data.paper_width;
887  paper_height = data.paper_height;
888  color_policy = data.color_policy;
891  return (*this);
892  }
893 
900 
909 
920 
931 
942 
947 
952 
957 
962 
967 
972 
977 
985  float paper_width;
986 
995 
1004 
1011 
1017 };
1018 
1019 #if defined(_WIN32) || defined(_WIN64) || defined(__linux__)
1020 
1022 class Word2PDFSettingData FS_FINAL : public Object{
1023  public:
1030  typedef enum _ConvertOptimizeOption {
1036 
1043  typedef enum _ConvertContentOption {
1049 
1055  typedef enum _ConvertBookmarkOption {
1070 
1071 
1074  : include_doc_props(false)
1078  , convert_to_pdfa(false)
1079  , disable_vba_code(false)
1080  {}
1081 
1108  bool convert_to_pdfa, bool disable_vba_code) {
1109  this->include_doc_props = include_doc_props;
1110  this->optimize_option = optimize_option;
1111  this->content_option = content_option;
1112  this->bookmark_option = bookmark_option;
1113  this->convert_to_pdfa = convert_to_pdfa;
1114  this->disable_vba_code = disable_vba_code;
1115  }
1116 
1131  return (*this);
1132  }
1133 
1162  bool convert_to_pdfa, bool disable_vba_code) {
1163  this->include_doc_props = include_doc_props;
1164  this->optimize_option = optimize_option;
1165  this->content_option = content_option;
1166  this->bookmark_option = bookmark_option;
1167  this->convert_to_pdfa = convert_to_pdfa;
1168  this->disable_vba_code = disable_vba_code;
1169  }
1170 
1179 
1187 
1195 
1203 
1212 
1221 };
1222 
1224 class Excel2PDFSettingData FS_FINAL : public Object{
1225  public:
1231  typedef enum _ConvertQuality {
1236  } ConvertQuality;
1237 
1243  typedef enum _ScaleType {
1252  } ScaleType;
1253 
1254 
1257  : include_doc_props(false)
1259  , ignore_print_area(true)
1261  , convert_to_pdfa(false)
1262  , disable_vba_code(false)
1263  {}
1264 
1285  this->include_doc_props = include_doc_props;
1286  this->quality = quality;
1287  this->ignore_print_area = ignore_print_area;
1288  this->scale_type = scale_type;
1289  this->convert_to_pdfa = convert_to_pdfa;
1290  this->disable_vba_code = disable_vba_code;
1291  }
1292 
1302  quality = data.quality;
1304  scale_type = data.scale_type;
1307  return (*this);
1308  }
1309 
1332  this->include_doc_props = include_doc_props;
1333  this->quality = quality;
1334  this->ignore_print_area = ignore_print_area;
1335  this->scale_type = scale_type;
1336  this->convert_to_pdfa = convert_to_pdfa;
1338  }
1339 
1348 
1355 
1364 
1371 
1380 
1389 };
1390 
1392 class PowerPoint2PDFSettingData FS_FINAL : public Object{
1393  public:
1399  typedef enum _ConvertIntent {
1404  } ConvertIntent;
1405 
1412  typedef enum _HandoutOrder {
1423  } HandoutOrder;
1424 
1430  typedef enum _OutputType {
1449  } OutputType;
1450 
1451 
1455  , frame_output_slides(false)
1458  , output_hidden_slides(false)
1459  , include_doc_props(false)
1460  , disable_vba_code(false)
1461  {}
1462 
1485  this->intent = intent;
1486  this->frame_output_slides = frame_output_slides;
1487  this->handout_order = handout_order;
1488  this->output_hidden_slides = output_hidden_slides;
1489  this->output_type = output_type;
1490  this->include_doc_props = include_doc_props;
1491  this->disable_vba_code = disable_vba_code;
1492  }
1493 
1502  intent = data.intent;
1504  output_type = data.output_type;
1509  return (*this);
1510  }
1511 
1536  this->intent = intent;
1537  this->frame_output_slides = frame_output_slides;
1538  this->output_type = output_type;
1539  this->handout_order = handout_order;
1540  this->output_hidden_slides = output_hidden_slides;
1541  this->include_doc_props = include_doc_props;
1542  this->disable_vba_code = disable_vba_code;
1543  }
1544 
1550 
1558 
1565 
1583 
1591 
1600 
1609 };
1610 #endif // #if (defined(_WIN32) || defined(_WIN64))
1611 
1613 class HTML2PDFRelatedResource FS_FINAL : public Object{
1614  public:
1619  }
1620 
1630  this->related_resource_file = related_resource_file;
1631  this->resource_file_relative_path = resource_file_relative_path;
1632  }
1633 
1644  return (*this);
1645  }
1646 
1649 
1657 };
1658 
1661 
1662 #if (defined(_WIN32) || defined(_WIN64)) || defined(__linux__)
1663 
1664 class OFDConvertParam FS_FINAL : public Object{
1665  public:
1668  :is_embed_font(false) {}
1669 
1676  this->is_embed_font = is_embed_font;
1677  }
1678 
1686  void Set(bool is_embed_font) {
1687  this->is_embed_font = is_embed_font;
1688  }
1689 
1692 };
1693 #endif
1694 
1706 class Convert FS_FINAL : public Base {
1707  public:
1725  static void FromHTML(const wchar_t* src_html, const wchar_t* engine_path, const wchar_t* cookies_path, const HTML2PDFSettingData& setting_data, const wchar_t* saved_pdf_path, int32 timeout);
1726 
1745  static void FromHTML(const wchar_t* src_html, const wchar_t* engine_path, foxit::common::file::ReaderCallback* cookies_reader, const HTML2PDFSettingData& setting_data, const wchar_t* saved_pdf_path, int32 timeout);
1746 
1765  static void FromHTML(const wchar_t* src_html, const wchar_t* engine_path, foxit::common::file::ReaderCallback* cookies_reader, const HTML2PDFSettingData& setting_data, foxit::common::file::WriterCallback* saved_pdf_filestream, int32 timeout);
1766 
1787  static void FromHTML(foxit::common::file::ReaderCallback* src_html, const HTML2PDFRelatedResourceArray& html2pdf_related_resource_array, const wchar_t* engine_path, foxit::common::file::ReaderCallback* cookies_reader, const HTML2PDFSettingData& setting_data, foxit::common::file::WriterCallback* saved_pdf_filestream, int32 timeout);
1788 
1798  static void FromTXT(const wchar_t* src_txt, const wchar_t* saved_pdf_path, const TXT2PDFSettingData& setting_data);
1799 
1808  static void FromImage(const wchar_t* src_img, const wchar_t* saved_pdf_path);
1809 
1820  static void FromImage(foxit::common::file::ReaderCallback* file_reader, foxit::common::file::WriterCallback* saved_pdf_filestream);
1821 
1836  static bool FromDWG(const wchar_t* engine_path, const wchar_t* src_dwg_path, const wchar_t* saved_pdf_path,
1837  const DWG2PDFSettingData& settings);
1838 
1839 #if (defined(_WIN32) || defined(_WIN64))
1840 
1853  static void FromWord(const wchar_t* src_word_file_path, const wchar_t* src_file_password, const wchar_t* saved_pdf_path, const Word2PDFSettingData& setting_data);
1854 
1868  static void FromExcel(const wchar_t* src_excel_file_path, const wchar_t* src_file_password, const wchar_t* saved_pdf_path, const Excel2PDFSettingData& setting_data);
1869 
1883  static void FromPowerPoint(const wchar_t* src_ppt_file_path, const wchar_t* src_file_password, const wchar_t* saved_pdf_path, const PowerPoint2PDFSettingData& setting_data);
1884 
1885 #elif defined(__linux__) && !(defined(__ANDROID__) || defined(_FS_IOS_) || defined(_SWIG_ANDROID_) || defined(_SWIG_IOS_))
1886 
1911  static void FromWord(const wchar_t* src_word_file_path, const wchar_t* src_file_password, const wchar_t* saved_pdf_path, const wchar_t* engine_path, const Word2PDFSettingData& setting_data, const wchar_t* fx_engine_path = L"", const wchar_t* specified_user_profile_path = L"");
1912 
1938  static void FromExcel(const wchar_t* src_excel_file_path, const wchar_t* src_file_password, const wchar_t* saved_pdf_path, const wchar_t* engine_path, const Excel2PDFSettingData& setting_data, const wchar_t* fx_engine_path = L"", const wchar_t* specified_user_profile_path = L"");
1939 
1965  static void FromPowerPoint(const wchar_t* src_ppt_file_path, const wchar_t* src_file_password, const wchar_t* saved_pdf_path, const wchar_t* engine_path, const PowerPoint2PDFSettingData& setting_data, const wchar_t* fx_engine_path = L"", const wchar_t* specified_user_profile_path = L"");
1966 #endif
1967 
1990  static bool ToXML(const wchar_t* src_pdf_path, const wchar_t* src_file_password, const wchar_t* saved_xml_path, const wchar_t* saved_image_folder_path, bool is_force_to_tagged_pdf);
1991 
1992 #if (defined(_WIN32) || defined(_WIN64)) || defined(__linux__)
1993 
2005  static bool FromOFD(const wchar_t* src_ofd_path, const wchar_t* password, const wchar_t* saved_pdf_file_path, OFDConvertParam convert_param);
2006 
2019  static bool ToOFD(const wchar_t* src_pdf_path, const wchar_t* password, const wchar_t* saved_ofd_file_path, OFDConvertParam convert_param);
2020 #endif // #if (defined(_WIN32) || defined(_WIN64)) || defined(__linux__)
2021 
2022 };
2023 }
2024 }
2025 }
2026 #endif
Encoding foramt: "JIS".
Definition: fs_convert.h:98
bool include_doc_props
A boolean value which indicates whether to include Word document properties in the converted PDF docu...
Definition: fs_convert.h:1178
virtual void Release()=0
A callback function used to release current callback object itself.
Searchable text type: Only text displayed with SHX font is searchable.
Definition: fs_convert.h:830
Searchable text type: Only text displayed with TTF font is searchable.
Definition: fs_convert.h:832
ConvertBookmarkOption bookmark_option
Bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted ...
Definition: fs_convert.h:1202
Color policy: Drawing is exported to a monochrome PDF file.
Definition: fs_convert.h:844
uint32 export_flags
The export flags used for the converted PDF document. Please refer to values starting from DWG2PDFSet...
Definition: fs_convert.h:899
static void FromWord(const wchar_t *src_word_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Word2PDFSettingData &setting_data)
Convert a Word format file to a PDF file.
void Set(float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, common::Rotation rotate_degrees, bool is_generate_tag, HTML2PDFPageMode page_mode, bool to_generate_bookmarks, HTML2PDFScalingMode scaling_mode, HTML2PDFEncodingFormat encoding_format, bool to_render_images, bool to_remove_underline_for_link, bool to_set_headerfooter, const wchar_t *headerfooter_title, const wchar_t *headerfooter_url, const wchar_t *bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree, HTML2PDFMediaStyle media_style, bool to_load_active_content, bool to_disable_sandbox, bool to_use_blacklist, bool to_hide_header, bool to_hide_footer, bool to_deny_local_file_access)
Set value.
Definition: fs_convert.h:415
Encoding foramt: "X-KDDI-Shift_JIS".
Definition: fs_convert.h:210
bool convert_to_pdfa
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file....
Definition: fs_convert.h:1211
Encoding foramt: "EUC-CN".
Definition: fs_convert.h:104
Encoding foramt: "X-SoftBank-ISO-2022-JP".
Definition: fs_convert.h:218
Encoding foramt: "KOI8R".
Definition: fs_convert.h:118
Bit 9. Enable compression of internal PDF streams.
Definition: fs_convert.h:788
bool is_convert_link
Used to decide whether the web link should be converted or not.
Definition: fs_convert.h:489
HTML2PDFScalingMode
Enumeration for scaling mode used for converting HTML to PDF.
Definition: fs_convert.h:56
OutputType output_type
Output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPo...
Definition: fs_convert.h:1564
void Set(ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order, bool output_hidden_slides, bool include_doc_props, bool disable_vba_code)
Set value.
Definition: fs_convert.h:1534
Media style: screen. It means PDF page will be displayed in screen media style.
Definition: fs_convert.h:228
File writing interface.
Definition: fx_stream.h:470
bool to_deny_local_file_access
Used to decide whether to deny local file access or not during converting html file....
Definition: fs_convert.h:604
DWG2PDFSearchableTextType
Enumeration for searchable text type used for converting DWG to PDF.
Definition: fs_convert.h:826
Encoding foramt: "VISUAL".
Definition: fs_convert.h:152
Page scaling: Scale. It means HTML content will be scaled to fit PDF page size. In this mode,...
Definition: fs_convert.h:60
Encoding foramt: "X-DoCoMo-Shift_JIS".
Definition: fs_convert.h:212
Hatches export type: Exports hatch as a set of triangles (vectorizer).
Definition: fs_convert.h:814
HandoutOrder
Enumeration for specifying the page layout order in which slides appear on converted handouts....
Definition: fs_convert.h:1412
void Set(float page_width, float page_height, RectF page_margin, const common::Font &font, float text_size, ARGB text_color, float linespace, bool is_break_page)
Set value.
Definition: fs_convert.h:679
void * progress_callback
A pointer to a DWG2PDFProgressCallback object which is used to receive the progress of converting DWG...
Definition: fs_convert.h:1016
DWG2PDFSearchableTextType searchable_text_type
The type of search text type.
Definition: fs_convert.h:941
ConvertOptimizeOption
Enumeration for optimize option (which specifies resolution and quality) for converting Word to PDF.
Definition: fs_convert.h:1030
DWG2PDFColorPolicy color_policy
The color policy used for the converted PDF document.
Definition: fs_convert.h:1003
Encoding foramt: "X-TAM-ELANGO".
Definition: fs_convert.h:198
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
bool is_break_page
Used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
Definition: fs_convert.h:718
Encoding foramt: "Latin2".
Definition: fs_convert.h:76
Encoding foramt: "CP874".
Definition: fs_convert.h:124
Encoding foramt: "X-KDDI-ISO-2022-JP".
Definition: fs_convert.h:216
float page_height
Page height used for the converted PDF document.
Definition: fs_convert.h:695
bool to_optimize_tag_tree
Used to decide whether to optimize tag tree or not.
Definition: fs_convert.h:539
virtual void OnProgress(const wchar_t *message, float progress)=0
A callback function to be called when converting DWG to PDF.
Encoding foramt: "CP1257".
Definition: fs_convert.h:142
foxit::WString output_creator
The creator for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:971
bool is_to_page_scale
Used to decide whether to scale the converted PDF page or not.
Definition: fs_convert.h:472
When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed horiz...
Definition: fs_convert.h:1417
Color policy: Drawing is exported to a grayscale PDF file. Native colors are converted into grayscale...
Definition: fs_convert.h:846
Header file for PDF document related definitions and classes.
float page_height
The page height used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:464
bool disable_vba_code
A boolean value decide whether to disable the execution of vba code in the PowerPoint document.
Definition: fs_convert.h:1608
bool ignore_print_area
A boolean value which indicates whether to ignore any print area set when converting Excel document t...
Definition: fs_convert.h:1363
Searchable text type: No searchable text.
Definition: fs_convert.h:828
Media style: print. It means PDF page will be displayed in print media style.
Definition: fs_convert.h:230
Output type: handouts with four slide per handout page.
Definition: fs_convert.h:1444
Hatches export type: Exports hatch as a bitmap.
Definition: fs_convert.h:812
Encoding foramt: "EUC".
Definition: fs_convert.h:110
ConvertOptimizeOption optimize_option
Optimize option for covnerting Word to PDF, which specifies the resolution and quality of the convert...
Definition: fs_convert.h:1186
bool convert_to_pdfa
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file....
Definition: fs_convert.h:1379
Encoding foramt: "X-SoftBank-Shift_JIS".
Definition: fs_convert.h:214
Bit 8. Determines whether software uses vector hidden-line removal for corresponding viewports.
Definition: fs_convert.h:786
Encoding foramt: "ISO-8859-11".
Definition: fs_convert.h:148
Encoding foramt: "BIG5_HKSCS".
Definition: fs_convert.h:164
bool to_generate_bookmarks
Used to decide whether bookmarks should be generated or not.
Definition: fs_convert.h:501
Encoding foramt: "TSCII".
Definition: fs_convert.h:168
ScaleType scale_type
Scale type for the Excel sheet when converting Excel document to PDF file. Please refer to values sta...
Definition: fs_convert.h:1370
ConvertIntent intent
Converting intent. Please refer to values starting from PowerPoint2PDFSettingData::e_ConvertIntentPri...
Definition: fs_convert.h:1549
Output type: handouts with one slide per handout page.
Definition: fs_convert.h:1438
DWG2PDFExportHatchesType
Enumeration for hatches export type used for converting DWG to PDF.
Definition: fs_convert.h:810
Encoding foramt: "BHASKAR".
Definition: fs_convert.h:180
bool is_generate_tag
Used to decide whether the tag should be generated or not.
Definition: fs_convert.h:492
Optimize option: convert for screen, which is a lower quality and results in a smaller file size.
Definition: fs_convert.h:1034
File reading interface.
Definition: fx_stream.h:587
float page_width
The page width used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:455
Encoding foramt: "TAM".
Definition: fs_convert.h:170
HTML2PDFSettingData()
Constructor.
Definition: fs_convert.h:235
WIDE STRING CLASS.
Definition: fx_string.h:1461
Bit 2. Enable TTF font text to geometry conversion.
Definition: fs_convert.h:766
Multiple page mode.
Definition: fs_convert.h:48
common::Rotation rotate_degrees
The rotation degree used for the converted PDF page.Please refer to values starting from common::e_Ro...
Definition: fs_convert.h:486
DWG2PDFExportHatchesType other_export_hatches_type
The type of other (non-solid) hatches export.
Definition: fs_convert.h:919
Bit 7. Enable embedding of TTF font program to PDF file. The TTF font will be reduced by removing unu...
Definition: fs_convert.h:782
bool frame_output_slides
A boolean value which indicates whether to frame output slides in the converted PDF document.
Definition: fs_convert.h:1557
static void FromHTML(const wchar_t *src_html, const wchar_t *engine_path, const wchar_t *cookies_path, const HTML2PDFSettingData &setting_data, const wchar_t *saved_pdf_path, int32 timeout)
Convert a HTML format file or a URL of a Web page to a PDF file.
Bit 4. Enable simple geometry optimization (separated segments to one polyline, Bezier curve control ...
Definition: fs_convert.h:774
Excel2PDFSettingData()
Constructor.
Definition: fs_convert.h:1256
Encoding foramt: "Latin4".
Definition: fs_convert.h:80
bool to_hide_header
Used to decide whether to hide header or not. It can not support on Linux x86 platform.
Definition: fs_convert.h:592
bool is_active_layout
true means to export the active layout only, while false means not. Default value: false.
Definition: fs_convert.h:946
HTML2PDFEncodingFormat encoding_format
The HTML encoding format Please refer to values starting from HTML2PDFSettingData::e_EncodingFormatDe...
Definition: fs_convert.h:512
Encoding foramt: "Greek".
Definition: fs_convert.h:90
Encoding foramt: "UTF7".
Definition: fs_convert.h:178
Fit all rows of one sheet on one page.
Definition: fs_convert.h:1249
Encoding foramt: "HZ-GB-2312".
Definition: fs_convert.h:194
Output type: handouts with two slide per handout page.
Definition: fs_convert.h:1440
ScaleType
Enumeration for scaling type for each sheet in the Excel document for converting Excel to PDF.
Definition: fs_convert.h:1243
Encoding foramt: "GB18030".
Definition: fs_convert.h:162
Encoding foramt: "CP852".
Definition: fs_convert.h:120
Encoding foramt: Default.The encoding format will be automatically detected in chromium.
Definition: fs_convert.h:72
bool disable_vba_code
A boolean value decide whether to disable the execution of vba code in the Word document.
Definition: fs_convert.h:1220
Hatches export type: Exports hatch as a PDF path (solid hatches only).
Definition: fs_convert.h:816
Encoding foramt: "ASCII-7-bit".
Definition: fs_convert.h:116
Encoding foramt: "JAGRAN".
Definition: fs_convert.h:174
ConvertIntent
Enumeration for intent for converting PowerPoint to PDF.
Definition: fs_convert.h:1399
Optimize option: convert for print, which is higher quality and results in a larger file size.
Definition: fs_convert.h:1032
ConvertBookmarkOption
Enumeration for bookmark option for for converting Word to PDF.
Definition: fs_convert.h:1055
Encoding foramt: "EUC-JP".
Definition: fs_convert.h:94
Output type: handouts with three slide per handout page.
Definition: fs_convert.h:1442
Encoding foramt: "CP932".
Definition: fs_convert.h:126
bool include_doc_props
A boolean value which indicates whether to include Excel document properties in the converted PDF doc...
Definition: fs_convert.h:1347
float text_size
Font size. If valid, it should be above 0.
Definition: fs_convert.h:709
Output type: notes pages.
Definition: fs_convert.h:1434
Scaling mode: Fixed page with no scale. In this mode, the text size of HTML content will not be chang...
Definition: fs_convert.h:58
DWG2PDFExportFlags
Enumeration for flags of DWG to PDF export.
Definition: fs_convert.h:758
Encoding foramt: "X-TAM-WEBTAMIL".
Definition: fs_convert.h:208
bool is_output_progress
A boolean value which indicates whether to output progress logs. true means to output progress logs,...
Definition: fs_convert.h:1010
static bool FromOFD(const wchar_t *src_ofd_path, const wchar_t *password, const wchar_t *saved_pdf_file_path, OFDConvertParam convert_param)
Convert OFD file to PDF file.
HTML2PDFMediaStyle media_style
The media style used for the converted PDF document. Please refer to values starting from HTML2PDFSet...
Definition: fs_convert.h:545
RectF page_margin
The page margin used for converted PDF document.
Definition: fs_convert.h:480
OutputType
Enumeration for output type for converting PowerPoint to PDF.
Definition: fs_convert.h:1430
Encoding foramt: "Unicode".
Definition: fs_convert.h:108
Encoding foramt: "CP866".
Definition: fs_convert.h:122
static bool FromDWG(const wchar_t *engine_path, const wchar_t *src_dwg_path, const wchar_t *saved_pdf_path, const DWG2PDFSettingData &settings)
Convert a DWG format file to a PDF file.
HTML2PDFPageMode
Enumeration for page mode used for converting HTML to PDF.
Definition: fs_convert.h:44
Encoding foramt: "KOI8U".
Definition: fs_convert.h:144
Encoding foramt: "CP1256".
Definition: fs_convert.h:140
Encoding foramt: "CP1250".
Definition: fs_convert.h:128
Encoding foramt: "TAB".
Definition: fs_convert.h:172
Page scaling: Enlarge. It means PDF page will be enlarged to HTML content size. In this mode,...
Definition: fs_convert.h:62
HTML2PDFScalingMode scaling_mode
The scaling mode used for the converted PDF document. Please refer to values starting from HTML2PDFSe...
Definition: fs_convert.h:507
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
bool is_embed_font
Whether to embed font in the converted file. true means to embed font in the converted file,...
Definition: fs_convert.h:1691
Intent: converted result file will be used for showing on screen.
Definition: fs_convert.h:1403
HTML2PDFEncodingFormat
Enumeration for encoding format used for converting HTML to PDF.
Definition: fs_convert.h:70
foxit::WString output_subject
The subject for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:961
HTML2PDFSettingData(float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, common::Rotation rotate_degrees, bool is_generate_tag, HTML2PDFPageMode page_mode, bool to_generate_bookmarks, HTML2PDFScalingMode scaling_mode, HTML2PDFEncodingFormat encoding_format, bool to_render_images, bool to_remove_underline_for_link, bool to_set_headerfooter, const wchar_t *headerfooter_title, const wchar_t *headerfooter_url, const wchar_t *bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree, HTML2PDFMediaStyle media_style, bool to_load_active_content, bool to_disable_sandbox, bool to_use_blacklist, bool to_hide_header, bool to_hide_footer, bool to_deny_local_file_access)
Constructor, with parameters.
Definition: fs_convert.h:303
Bit 10. Enable ASCIIHex encoding of internal PDF streams.
Definition: fs_convert.h:790
Encoding foramt: "CP1255".
Definition: fs_convert.h:138
Encoding foramt: "HTCHANAKYA".
Definition: fs_convert.h:182
Fit a sheet on one page.
Definition: fs_convert.h:1251
Encoding foramt: "CSN_369103".
Definition: fs_convert.h:154
Encoding foramt: "ISO-8859-8-I".
Definition: fs_convert.h:150
static void FromExcel(const wchar_t *src_excel_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const Excel2PDFSettingData &setting_data)
Convert an Excel format file to a PDF file.
Fit all columns of one sheet on one page.
Definition: fs_convert.h:1247
Bit 15. Enable measuring scale in pdf.
Definition: fs_convert.h:802
HTML2PDFPageMode page_mode
The page mode used for the converting. Please refer to values starting from HTML2PDFSettingData::e_Pa...
Definition: fs_convert.h:498
Bit 1. Enable embedding of TTF(True Type Font) program to PDF file. The whole TTF font file will be e...
Definition: fs_convert.h:762
foxit::WString output_producer
The producer for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:976
Encoding foramt: "SJS".
Definition: fs_convert.h:96
bool to_use_blacklist
Used to decide whether to use blacklist or not.
Definition: fs_convert.h:589
bool to_set_headerfooter
Used to decide whether to set header-footer or not.
Definition: fs_convert.h:521
static bool ToXML(const wchar_t *src_pdf_path, const wchar_t *src_file_password, const wchar_t *saved_xml_path, const wchar_t *saved_image_folder_path, bool is_force_to_tagged_pdf)
Convert a PDF file to a XML format file.
foxit::WString output_keywords
The keywords for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:966
Encoding foramt: "UTF-32LE".
Definition: fs_convert.h:190
Excel2PDFSettingData(bool include_doc_props, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type, bool convert_to_pdfa, bool disable_vba_code)
Constructor, with parameters.
Definition: fs_convert.h:1283
foxit::WString bookmark_root_name
The bookmark's root name.
Definition: fs_convert.h:530
bool to_print_background
Used to decide whether to print background or not.
Definition: fs_convert.h:536
Output type: handouts with six slide per handout page.
Definition: fs_convert.h:1446
DWG2PDFExportHatchesType gradient_export_hatches_type
The type of gradient hatches export.
Definition: fs_convert.h:930
TXT2PDFSettingData & operator=(const TXT2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:653
bool to_hide_footer
Used to decide whether to hide footer or not. It can not support on Linux x86 platform.
Definition: fs_convert.h:595
Encoding foramt: "UTF-32BE".
Definition: fs_convert.h:188
Do not create bookmark in converted PDF file.
Definition: fs_convert.h:1057
Convert Word document without markup.
Definition: fs_convert.h:1045
Word2PDFSettingData & operator=(const Word2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:1124
Intent: converted result file will be used for printing.
Definition: fs_convert.h:1401
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
RectF page_margin
Page margin used for converted PDF document.
Definition: fs_convert.h:703
bool to_disable_sandbox
Used to decide whether to disable sandbox or not.
Definition: fs_convert.h:561
Hatches export type: Exports hatch as a polygon (solid hatches only).
Definition: fs_convert.h:818
HandoutOrder handout_order
Handout order used to specify the page layout order in which slides appear on converted handouts....
Definition: fs_convert.h:1582
DWG2PDFSettingData()
Constructor, with parameters.
Definition: fs_convert.h:853
Encoding foramt: "CP1252".
Definition: fs_convert.h:132
common::Font font
A font object.
Definition: fs_convert.h:706
Encoding foramt: "ASCII".
Definition: fs_convert.h:74
Header file for common definitions and classes.
Bit 12. If enabled, layout geometry will be zoomed to paper size, else layout settings will be applie...
Definition: fs_convert.h:798
DWG2PDFSettingData & operator=(const DWG2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:873
Encoding foramt: "BIG5".
Definition: fs_convert.h:100
void Set(bool include_doc_props, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type, bool convert_to_pdfa)
Set value.
Definition: fs_convert.h:1330
Encoding foramt: "MACINTOSH".
Definition: fs_convert.h:176
bool output_hidden_slides
A boolean value which indicates whether to convert hidden slides to the converted PDF document.
Definition: fs_convert.h:1590
Create bookmarks in converted PDF file by using each heading of Word document.
Definition: fs_convert.h:1063
Encoding foramt: "CP1254".
Definition: fs_convert.h:136
static void FromTXT(const wchar_t *src_txt, const wchar_t *saved_pdf_path, const TXT2PDFSettingData &setting_data)
Convert a TXT format file to a PDF file.
Encoding foramt: "X-TAM-TMNEWS".
Definition: fs_convert.h:206
Bit 5. If enabled, layer support will be added to PDF file (1.5 version required).
Definition: fs_convert.h:776
HTML2PDFSettingData & operator=(const HTML2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:345
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
float paper_height
The paper height used for the converted PDF document.
Definition: fs_convert.h:994
Definition: fs_basictypes.h:449
DWG2PDFExportHatchesType export_hatches_type
The type of solid hatches export.
Definition: fs_convert.h:908
static void FromImage(const wchar_t *src_img, const wchar_t *saved_pdf_path)
Convert a Image format file to a PDF file.
Word2PDFSettingData()
Constructor.
Definition: fs_convert.h:1073
Encoding foramt: "X-TAM-LTTMBARANI".
Definition: fs_convert.h:200
OFDConvertParam()
Constructor.
Definition: fs_convert.h:1667
static void FromPowerPoint(const wchar_t *src_ppt_file_path, const wchar_t *src_file_password, const wchar_t *saved_pdf_path, const PowerPoint2PDFSettingData &setting_data)
Convert a PowerPoint format file to a PDF file.
void Set(bool include_doc_props, ConvertOptimizeOption optimize_option, ConvertContentOption content_option, ConvertBookmarkOption bookmark_option, bool convert_to_pdfa, bool disable_vba_code)
Set value.
Definition: fs_convert.h:1160
Encoding foramt: "X-TAM-TBOOMIS".
Definition: fs_convert.h:204
Encoding foramt: "ISO-8859-13".
Definition: fs_convert.h:156
Header file for PDF page related definitions and classes.
Encoding foramt: "Hebrew".
Definition: fs_convert.h:92
bool to_render_images
Used to decide whether to render images or not.
Definition: fs_convert.h:515
ConvertContentOption content_option
Content option for covnerting Word to PDF, which specifies how much content of Word document is to be...
Definition: fs_convert.h:1194
PowerPoint2PDFSettingData()
Constructor.
Definition: fs_convert.h:1453
Encoding foramt: "Latin3".
Definition: fs_convert.h:78
ConvertQuality quality
Quality for covnerting Excel to PDF. Please refer to values starting from Excel2PDFSettingData::e_Con...
Definition: fs_convert.h:1354
Encoding foramt: "GBK".
Definition: fs_convert.h:160
Convert Word document with markup.
Definition: fs_convert.h:1047
Definition: fs_common.h:1503
float paper_width
The paper width used for the converted PDF document.
Definition: fs_convert.h:985
No rotation.
Definition: fs_common.h:59
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Foxit namespace.
Definition: fs_pdf3d.h:27
Word2PDFSettingData(bool include_doc_props, ConvertOptimizeOption optimize_option, ConvertContentOption content_option, ConvertBookmarkOption bookmark_option, bool convert_to_pdfa, bool disable_vba_code)
Constructor, with parameters.
Definition: fs_convert.h:1106
TXT2PDFSettingData(float page_width, float page_height, RectF page_margin, const common::Font &font, float text_size, ARGB text_color, float linespace, bool is_break_page)
Constructor, with parameters.
Definition: fs_convert.h:634
bool to_load_active_content
Used to decide whether to load active content or not.
Definition: fs_convert.h:554
Encoding foramt: "ISO_2022_CN".
Definition: fs_convert.h:166
DWG2PDFColorPolicy
Enumeration for color policy used for converting DWG to PDF.
Definition: fs_convert.h:840
TXT2PDFSettingData()
Constructor.
Definition: fs_convert.h:611
Bit 13. Create linearized PDF file.
Definition: fs_convert.h:800
Encoding foramt: "X-TAM-SHREE".
Definition: fs_convert.h:202
Encoding foramt: "UTF-16LE".
Definition: fs_convert.h:186
Encoding foramt: "KSC".
Definition: fs_convert.h:106
bool to_resize_objects
Whether to enable the Javascripts related resizing of the objects during rendering process.
Definition: fs_convert.h:533
Encoding foramt: "ISO-2022-KR".
Definition: fs_convert.h:158
Encoding foramt: "Arabic".
Definition: fs_convert.h:88
When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed verti...
Definition: fs_convert.h:1422
foxit::WString output_title
The title for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:951
Encoding foramt: "Latin6".
Definition: fs_convert.h:84
HTML2PDFMediaStyle
Enumeration for media style used for converting HTML to PDF.
Definition: fs_convert.h:226
Encoding foramt: "X-BINARYENC".
Definition: fs_convert.h:192
Encoding foramt: "GB".
Definition: fs_convert.h:102
Color policy: No color policy. A drawing is exported with its native color palette (as is).
Definition: fs_convert.h:842
#define NULL
The null-pointer value.
Definition: fx_system.h:792
static bool ToOFD(const wchar_t *src_pdf_path, const wchar_t *password, const wchar_t *saved_ofd_file_path, OFDConvertParam convert_param)
Convert PDF file to OFD file.
A callback class used for converting DWG to PDF.
Definition: fs_convert.h:726
Output type: outline view.
Definition: fs_convert.h:1436
Bit 11. Enable hyperlinks export.
Definition: fs_convert.h:792
foxit::WString headerfooter_title
The header-footer title which is content for center header.
Definition: fs_convert.h:524
Encoding foramt: "CP1253".
Definition: fs_convert.h:134
float page_width
Page width used for the converted PDF document.
Definition: fs_convert.h:692
bool disable_vba_code
A boolean value decide whether to disable the execution of vba code in the Excel document.
Definition: fs_convert.h:1388
void Set(bool is_embed_font)
Set value.
Definition: fs_convert.h:1686
bool to_remove_underline_for_link
Used to decide whether to remove underline decoration for link.
Definition: fs_convert.h:518
bool include_doc_props
A boolean value which indicates whether to include PowerPoint document properties in the converted PD...
Definition: fs_convert.h:1599
PowerPoint2PDFSettingData(ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order, bool output_hidden_slides, bool include_doc_props, bool disable_vba_code)
Constructor, with parameters.
Definition: fs_convert.h:1483
Definition: fs_convert.h:1706
Output type: handouts with nine slide per handout page.
Definition: fs_convert.h:1448
foxit::WString headerfooter_url
The header-footer url which is content for left footer.
Definition: fs_convert.h:527
Encoding foramt: "Latin5".
Definition: fs_convert.h:82
Definition: fs_convert.h:1664
ARGB text_color
Font color.
Definition: fs_convert.h:712
Create bookmarks in converted PDF file by using each bookmarks of Word document.
Definition: fs_convert.h:1068
Bit 3. Enable SHX font text to geometry conversion.
Definition: fs_convert.h:770
Encoding foramt: "ISO-8859-5".
Definition: fs_convert.h:86
Encoding foramt: "BIG5-CP950".
Definition: fs_convert.h:114
foxit::WString output_author
The author for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:956
Encoding foramt: "UTF-16BE".
Definition: fs_convert.h:184
Bit 6. If enabled, invisible layers will be added to PDF file (1.5 version required).
Definition: fs_convert.h:778
float linespace
Line spacing. If valid, it should be above 0.
Definition: fs_convert.h:715
ConvertQuality
Enumeration for quality for converting Excel to PDF.
Definition: fs_convert.h:1231
Encoding foramt: "CNS".
Definition: fs_convert.h:112
Output type: slides.
Definition: fs_convert.h:1432
ConvertContentOption
Enumeration for content option which specifies how much content of Word document is to be converted t...
Definition: fs_convert.h:1043
Encoding foramt: "CP1251".
Definition: fs_convert.h:130
OFDConvertParam(bool is_embed_font)
Constructor, with parameters.
Definition: fs_convert.h:1675
Encoding foramt: "ISO-8859-15".
Definition: fs_convert.h:146
Excel2PDFSettingData & operator=(const Excel2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:1300
Definition: fx_coordinates.h:771
Encoding foramt: "X-UTF8UTF8".
Definition: fs_convert.h:196
PowerPoint2PDFSettingData & operator=(const PowerPoint2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:1501