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 
296  const wchar_t* headerfooter_url, const wchar_t* bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree,
298  this->page_width = page_width;
299  this->page_height = page_height;
300  this->is_to_page_scale = is_to_page_scale;
301  this->page_margin = page_margin;
302  this->is_convert_link = is_convert_link;
303  this->rotate_degrees = rotate_degrees;
304  this->is_generate_tag = is_generate_tag;
305  this->page_mode = page_mode;
306  this->to_generate_bookmarks = to_generate_bookmarks;
307  this->scaling_mode = scaling_mode;
308  this->encoding_format = encoding_format;
309  this->to_render_images = to_render_images;
310  this->to_remove_underline_for_link = to_remove_underline_for_link;
311  this->to_set_headerfooter = to_set_headerfooter;
312  this->headerfooter_title = headerfooter_title;
313  this->headerfooter_url = headerfooter_url;
314  this->bookmark_root_name = bookmark_root_name;
315  this->to_resize_objects = to_resize_objects;
316  this->to_print_background = to_print_background;
317  this->to_optimize_tag_tree = to_optimize_tag_tree;
318  this->media_style = media_style;
319  this->to_load_active_content = to_load_active_content;
320  }
321 
330  page_width = data.page_width;
331  page_height = data.page_height;
333  page_margin = data.page_margin;
337  page_mode = data.page_mode;
339  scaling_mode = data.scaling_mode;
350  media_style = data.media_style;
352  return (*this);
353  }
354 
392  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,
394  this->page_width = page_width;
395  this->page_height = page_height;
396  this->is_to_page_scale = is_to_page_scale;
397  this->page_margin = page_margin;
398  this->is_convert_link = is_convert_link;
399  this->rotate_degrees = rotate_degrees;
400  this->is_generate_tag = is_generate_tag;
401  this->page_mode = page_mode;
402  this->to_generate_bookmarks = to_generate_bookmarks;
403  this->scaling_mode = scaling_mode;
404  this->encoding_format = encoding_format;
405  this->to_render_images = to_render_images;
406  this->to_remove_underline_for_link = to_remove_underline_for_link;
407  this->to_set_headerfooter = to_set_headerfooter;
408  this->headerfooter_title = headerfooter_title;
409  this->headerfooter_url = headerfooter_url;
410  this->bookmark_root_name = bookmark_root_name;
411  this->to_resize_objects = to_resize_objects;
412  this->to_print_background = to_print_background;
413  this->to_optimize_tag_tree = to_optimize_tag_tree;
414  this->media_style = media_style;
415  this->to_load_active_content = to_load_active_content;
416  }
417 
423  float page_width;
424 
432  float page_height;
433 
441 
449 
455 
458 
461 
467 
470 
476 
481 
484 
487 
490 
493 
496 
499 
502 
505 
508 
514 
523 };
524 
526 class TXT2PDFSettingData FS_FINAL : public Object {
527  public:
530  : page_width(0)
531  , page_height(0)
532  , text_size(0)
533  , text_color(0xFF000000)
534  , linespace(0)
535  , is_break_page(false) {
536  }
537 
553  ARGB text_color, float linespace, bool is_break_page) {
554  this->page_width = page_width;
555  this->page_height = page_height;
556  this->page_margin = page_margin;
557  this->font = font;
558  this->text_size = text_size;
559  this->text_color = text_color;
560  this->linespace = linespace;
561  this->is_break_page = is_break_page;
562  }
563 
572  page_width = data.page_width;
573  page_height = data.page_height;
574  page_margin = data.page_margin;
575  font = data.font;
576  text_size = data.text_size;
577  text_color = data.text_color;
578  linespace = data.linespace;
580  return (*this);
581  }
582 
598  ARGB text_color, float linespace, bool is_break_page) {
599  this->page_width = page_width;
600  this->page_height = page_height;
601  this->page_margin = page_margin;
602  this->font = font;
603  this->text_size = text_size;
604  this->text_color = text_color;
605  this->linespace = linespace;
606  this->is_break_page = is_break_page;
607  }
608 
610  float page_width;
611 
613  float page_height;
614 
622 
625 
627  float text_size;
628 
631 
633  float linespace;
634 
637 };
638 
639 #if defined(_WIN32) || defined(_WIN64) || defined(__linux__)
640 
642 class Word2PDFSettingData FS_FINAL : public Object{
643  public:
650  typedef enum _ConvertOptimizeOption {
652  e_ConvertOptimizeOptionForPrint = 0,
654  e_ConvertOptimizeOptionForOnScreen = 1
655  } ConvertOptimizeOption;
656 
663  typedef enum _ConvertContentOption {
665  e_ConvertContentOptionOnlyContent = 0,
667  e_ConvertContentOptionWithMarkup = 1
668  } ConvertContentOption;
669 
675  typedef enum _ConvertBookmarkOption {
677  e_ConvertBookmarkOptionNone = 0,
683  e_ConvertBookmarkOptionUseHeadings = 1,
688  e_ConvertBookmarkOptionUseWordBookmark = 2
689  } ConvertBookmarkOption;
690 
691 
693  Word2PDFSettingData()
694  : include_doc_props(false)
695  , optimize_option(Word2PDFSettingData::e_ConvertOptimizeOptionForPrint)
696  , content_option(Word2PDFSettingData::e_ConvertContentOptionOnlyContent)
697  , bookmark_option(Word2PDFSettingData::e_ConvertBookmarkOptionNone)
698  , convert_to_pdfa(false)
699  {}
700 
724  Word2PDFSettingData(bool include_doc_props, ConvertOptimizeOption optimize_option,
725  ConvertContentOption content_option, ConvertBookmarkOption bookmark_option,
726  bool convert_to_pdfa) {
727  this->include_doc_props = include_doc_props;
728  this->optimize_option = optimize_option;
729  this->content_option = content_option;
730  this->bookmark_option = bookmark_option;
731  this->convert_to_pdfa = convert_to_pdfa;
732  }
733 
741  Word2PDFSettingData &operator = (const Word2PDFSettingData& data) {
742  include_doc_props = data.include_doc_props;
743  optimize_option = data.optimize_option;
744  content_option = data.content_option;
745  bookmark_option = data.bookmark_option;
746  convert_to_pdfa = data.convert_to_pdfa;
747  return (*this);
748  }
749 
775  void Set(bool include_doc_props, ConvertOptimizeOption optimize_option,
776  ConvertContentOption content_option, ConvertBookmarkOption bookmark_option,
777  bool convert_to_pdfa) {
778  this->include_doc_props = include_doc_props;
779  this->optimize_option = optimize_option;
780  this->content_option = content_option;
781  this->bookmark_option = bookmark_option;
782  this->convert_to_pdfa = convert_to_pdfa;
783  }
784 
792  bool include_doc_props;
793 
800  ConvertOptimizeOption optimize_option;
801 
808  ConvertContentOption content_option;
809 
816  ConvertBookmarkOption bookmark_option;
817 
825  bool convert_to_pdfa;
826 };
827 
829 class Excel2PDFSettingData FS_FINAL : public Object{
830  public:
836  typedef enum _ConvertQuality {
838  e_ConvertQualityStandard = 0,
840  e_ConvertQualityMinimum = 1
841  } ConvertQuality;
842 
848  typedef enum _ScaleType {
850  e_ScaleTypeNone = 0,
852  e_ScaleTypeFitAllColumns = 1,
854  e_ScaleTypeFitAllRows = 2,
856  e_ScaleTypeFitSheet = 3
857  } ScaleType;
858 
859 
861  Excel2PDFSettingData()
862  : include_doc_props(false)
863  , quality(Excel2PDFSettingData::e_ConvertQualityStandard)
864  , ignore_print_area(true)
865  , scale_type(Excel2PDFSettingData::e_ScaleTypeNone)
866  , convert_to_pdfa(false)
867  {}
868 
886  Excel2PDFSettingData(bool include_doc_props, ConvertQuality quality, bool ignore_print_area,
887  ScaleType scale_type, bool convert_to_pdfa) {
888  this->include_doc_props = include_doc_props;
889  this->quality = quality;
890  this->ignore_print_area = ignore_print_area;
891  this->scale_type = scale_type;
892  this->convert_to_pdfa = convert_to_pdfa;
893  }
894 
902  Excel2PDFSettingData &operator = (const Excel2PDFSettingData& data) {
903  include_doc_props = data.include_doc_props;
904  quality = data.quality;
905  ignore_print_area = data.ignore_print_area;
906  scale_type = data.scale_type;
907  convert_to_pdfa = data.convert_to_pdfa;
908  return (*this);
909  }
910 
930  void Set(bool include_doc_props, ConvertQuality quality, bool ignore_print_area,
931  ScaleType scale_type, bool convert_to_pdfa) {
932  this->include_doc_props = include_doc_props;
933  this->quality = quality;
934  this->ignore_print_area = ignore_print_area;
935  this->scale_type = scale_type;
936  this->convert_to_pdfa = convert_to_pdfa;
937  }
938 
946  bool include_doc_props;
947 
953  ConvertQuality quality;
954 
962  bool ignore_print_area;
963 
969  ScaleType scale_type;
970 
978  bool convert_to_pdfa;
979 };
980 
982 class PowerPoint2PDFSettingData FS_FINAL : public Object{
983  public:
989  typedef enum _ConvertIntent {
991  e_ConvertIntentPrint = 0,
993  e_ConvertIntentScreen = 1
994  } ConvertIntent;
995 
1002  typedef enum _HandoutOrder {
1007  e_HandoutOrderHorizontalFirst = 0,
1012  e_HandoutOrderVerticalFirst = 1
1013  } HandoutOrder;
1014 
1020  typedef enum _OutputType {
1022  e_OutputSlides = 1,
1024  e_OutputNotesPages = 2,
1026  e_OutputOutline = 3,
1028  e_OutputOneSlideHandouts = 4,
1030  e_OutputTwoSlideHandouts = 5,
1032  e_OutputThreeSlideHandouts = 6,
1034  e_OutputFourSlideHandouts = 7,
1036  e_OutputSixSlideHandouts = 8,
1038  e_OutputNineSlideHandouts = 9
1039  } OutputType;
1040 
1041 
1043  PowerPoint2PDFSettingData()
1044  : intent(PowerPoint2PDFSettingData::e_ConvertIntentPrint)
1045  , frame_output_slides(false)
1046  , output_type(PowerPoint2PDFSettingData::e_OutputSlides)
1047  , handout_order(PowerPoint2PDFSettingData::e_HandoutOrderVerticalFirst)
1048  , output_hidden_slides(false)
1049  , include_doc_props(false)
1050  {}
1051 
1071  PowerPoint2PDFSettingData(ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order,
1072  bool output_hidden_slides, bool include_doc_props) {
1073  this->intent = intent;
1074  this->frame_output_slides = frame_output_slides;
1075  this->handout_order = handout_order;
1076  this->output_hidden_slides = output_hidden_slides;
1077  this->output_type = output_type;
1078  this->include_doc_props = include_doc_props;
1079  }
1080 
1088  PowerPoint2PDFSettingData &operator = (const PowerPoint2PDFSettingData& data) {
1089  intent = data.intent;
1090  frame_output_slides = data.frame_output_slides;
1091  output_type = data.output_type;
1092  handout_order = data.handout_order;
1093  output_hidden_slides = data.output_hidden_slides;
1094  include_doc_props = data.include_doc_props;
1095  return (*this);
1096  }
1097 
1119  void Set(ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order,
1120  bool output_hidden_slides, bool include_doc_props) {
1121  this->intent = intent;
1122  this->frame_output_slides = frame_output_slides;
1123  this->output_type = output_type;
1124  this->handout_order = handout_order;
1125  this->output_hidden_slides = output_hidden_slides;
1126  this->include_doc_props = include_doc_props;
1127  }
1128 
1133  ConvertIntent intent;
1134 
1141  bool frame_output_slides;
1142 
1148  OutputType output_type;
1149 
1166  HandoutOrder handout_order;
1167 
1174  bool output_hidden_slides;
1175 
1183  bool include_doc_props;
1184 };
1185 #endif // #if (defined(_WIN32) || defined(_WIN64))
1186 
1188 class HTML2PDFRelatedResource FS_FINAL : public Object{
1189  public:
1194  }
1195 
1205  this->related_resource_file = related_resource_file;
1206  this->resource_file_relative_path = resource_file_relative_path;
1207  }
1208 
1219  return (*this);
1220  }
1221 
1224 
1232 };
1233 
1236 
1237 
1245 class Convert FS_FINAL : public Base {
1246  public:
1264  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);
1265 
1284  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);
1285 
1304  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);
1305 
1326  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);
1327 
1337  static void FromTXT(const wchar_t* src_txt, const wchar_t* saved_pdf_path, const TXT2PDFSettingData& setting_data);
1338 
1339 #if (defined(_WIN32) || defined(_WIN64))
1340 
1353  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);
1354 
1368  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);
1369 
1383  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);
1384 
1385 #elif defined(__linux__) && !(defined(__ANDROID__) || defined(_FS_IOS_) || defined(_SWIG_ANDROID_) || defined(_SWIG_IOS_))
1386 
1405  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);
1406 
1426  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);
1427 
1447  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);
1448 #endif
1449 
1472  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);
1473 
1474 };
1475 }
1476 }
1477 }
1478 #endif
foxit::addon::conversion::HTML2PDFSettingData::media_style
HTML2PDFMediaStyle media_style
The media style used for the converted PDF document. Please refer to values starting from HTML2PDFSet...
Definition: fs_convert.h:513
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatDefault
Encoding foramt: Default.The encoding format will be automatically detected in chromium.
Definition: fs_convert.h:72
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP866
Encoding foramt: "CP866".
Definition: fs_convert.h:122
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatGB18030
Encoding foramt: "GB18030".
Definition: fs_convert.h:162
IFX_FileWrite
File writing interface.
Definition: fx_stream.h:451
foxit::addon::conversion::HTML2PDFSettingData::e_MediaStyleScreen
Media style: screen. It means PDF page will be displayed in screen media style.
Definition: fs_convert.h:228
foxit::addon::conversion::HTML2PDFSettingData::Set
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)
Set value.
Definition: fs_convert.h:389
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatHebrew
Encoding foramt: "Hebrew".
Definition: fs_convert.h:92
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_TAM_ELANGO
Encoding foramt: "X-TAM-ELANGO".
Definition: fs_convert.h:198
foxit::addon::conversion::HTML2PDFSettingData::e_ScalingModeScale
Page scaling: Scale. It means HTML content will be scaled to fit PDF page size.
Definition: fs_convert.h:60
foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFScalingMode
HTML2PDFScalingMode
Enumeration for scaling mode used for converting HTML to PDF.
Definition: fs_convert.h:56
foxit::addon::conversion::HTML2PDFSettingData::e_ScalingModeEnlarge
Page scaling: Enlarge. It means PDF page will be enlarged to HTML content size.
Definition: fs_convert.h:62
foxit::addon::conversion::TXT2PDFSettingData::Set
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:597
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatVISUAL
Encoding foramt: "VISUAL".
Definition: fs_convert.h:152
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_2022_KR
Encoding foramt: "ISO-2022-KR".
Definition: fs_convert.h:158
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
foxit::common::e_Rotation0
No rotation.
Definition: fs_common.h:59
foxit::addon::conversion::HTML2PDFSettingData::is_convert_link
bool is_convert_link
Used to decide whether the web link should be converted or not.
Definition: fs_convert.h:457
foxit::addon::conversion::HTML2PDFSettingData::page_width
float page_width
The page width used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:423
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCSN_369103
Encoding foramt: "CSN_369103".
Definition: fs_convert.h:154
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatEUC_JP
Encoding foramt: "EUC-JP".
Definition: fs_convert.h:94
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatHTCHANAKYA
Encoding foramt: "HTCHANAKYA".
Definition: fs_convert.h:182
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatASCII_7_bit
Encoding foramt: "ASCII-7-bit".
Definition: fs_convert.h:116
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1252
Encoding foramt: "CP1252".
Definition: fs_convert.h:132
foxit::addon::conversion::HTML2PDFSettingData::e_MediaStylePrint
Media style: print. It means PDF page will be displayed in print media style.
Definition: fs_convert.h:230
fs_common.h
Header file for common definitions and classes.
foxit::addon::conversion::HTML2PDFSettingData::is_to_page_scale
bool is_to_page_scale
Used to decide whether to scale the converted PDF page or not.
Definition: fs_convert.h:440
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatKOI8R
Encoding foramt: "KOI8R".
Definition: fs_convert.h:118
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1254
Encoding foramt: "CP1254".
Definition: fs_convert.h:136
foxit::addon::conversion::TXT2PDFSettingData::page_height
float page_height
Page height used for the converted PDF document.
Definition: fs_convert.h:613
IFX_FileRead
File reading interface.
Definition: fx_stream.h:566
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_8859_11
Encoding foramt: "ISO-8859-11".
Definition: fs_convert.h:148
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatBIG5
Encoding foramt: "BIG5".
Definition: fs_convert.h:100
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatJIS
Encoding foramt: "JIS".
Definition: fs_convert.h:98
foxit::addon::conversion::HTML2PDFSettingData::page_margin
RectF page_margin
The page margin used for converted PDF document.
Definition: fs_convert.h:448
foxit::addon::conversion::HTML2PDFSettingData::rotate_degrees
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:454
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatGBK
Encoding foramt: "GBK".
Definition: fs_convert.h:160
foxit::addon::conversion::HTML2PDFSettingData
Definition: fs_convert.h:37
foxit::ARGB
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1253
Encoding foramt: "CP1253".
Definition: fs_convert.h:134
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_BINARYENC
Encoding foramt: "X-BINARYENC".
Definition: fs_convert.h:192
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_8859_15
Encoding foramt: "ISO-8859-15".
Definition: fs_convert.h:146
foxit::addon::conversion::HTML2PDFSettingData::headerfooter_url
foxit::WString headerfooter_url
The header-footer url which is content for left footer.
Definition: fs_convert.h:495
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1255
Encoding foramt: "CP1255".
Definition: fs_convert.h:138
foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFPageMode
HTML2PDFPageMode
Enumeration for page mode used for converting HTML to PDF.
Definition: fs_convert.h:44
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatUTF_16LE
Encoding foramt: "UTF-16LE".
Definition: fs_convert.h:186
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_SoftBank_ISO_2022_JP
Encoding foramt: "X-SoftBank-ISO-2022-JP".
Definition: fs_convert.h:218
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_TAM_SHREE
Encoding foramt: "X-TAM-SHREE".
Definition: fs_convert.h:202
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatKSC
Encoding foramt: "KSC".
Definition: fs_convert.h:106
foxit::addon::conversion::HTML2PDFSettingData::to_remove_underline_for_link
bool to_remove_underline_for_link
Used to decide whether to remove underline decoration for link.
Definition: fs_convert.h:486
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatBHASKAR
Encoding foramt: "BHASKAR".
Definition: fs_convert.h:180
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1251
Encoding foramt: "CP1251".
Definition: fs_convert.h:130
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_DoCoMo_Shift_JIS
Encoding foramt: "X-DoCoMo-Shift_JIS".
Definition: fs_convert.h:212
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatKOI8U
Encoding foramt: "KOI8U".
Definition: fs_convert.h:144
foxit::addon::conversion::HTML2PDFSettingData::to_load_active_content
bool to_load_active_content
Used to decide whether to load active content or not.
Definition: fs_convert.h:522
foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFSettingData
HTML2PDFSettingData()
Constructor.
Definition: fs_convert.h:235
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_KDDI_ISO_2022_JP
Encoding foramt: "X-KDDI-ISO-2022-JP".
Definition: fs_convert.h:216
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatGB
Encoding foramt: "GB".
Definition: fs_convert.h:102
foxit::addon::conversion::HTML2PDFSettingData::to_optimize_tag_tree
bool to_optimize_tag_tree
Used to decide whether to optimize tag tree or not.
Definition: fs_convert.h:507
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatMACINTOSH
Encoding foramt: "MACINTOSH".
Definition: fs_convert.h:176
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatUnicode
Encoding foramt: "Unicode".
Definition: fs_convert.h:108
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_TAM_TBOOMIS
Encoding foramt: "X-TAM-TBOOMIS".
Definition: fs_convert.h:204
foxit::addon::conversion::TXT2PDFSettingData::page_margin
RectF page_margin
Page margin used for converted PDF document.
Definition: fs_convert.h:621
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatLatin5
Encoding foramt: "Latin5".
Definition: fs_convert.h:82
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatTAM
Encoding foramt: "TAM".
Definition: fs_convert.h:170
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatTAB
Encoding foramt: "TAB".
Definition: fs_convert.h:172
foxit::addon::conversion::HTML2PDFSettingData::headerfooter_title
foxit::WString headerfooter_title
The header-footer title which is content for center header.
Definition: fs_convert.h:492
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1256
Encoding foramt: "CP1256".
Definition: fs_convert.h:140
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatArabic
Encoding foramt: "Arabic".
Definition: fs_convert.h:88
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_UTF8UTF8
Encoding foramt: "X-UTF8UTF8".
Definition: fs_convert.h:196
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_8859_5
Encoding foramt: "ISO-8859-5".
Definition: fs_convert.h:86
foxit::addon::conversion::HTML2PDFSettingData::to_print_background
bool to_print_background
Used to decide whether to print background or not.
Definition: fs_convert.h:504
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP852
Encoding foramt: "CP852".
Definition: fs_convert.h:120
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_TAM_WEBTAMIL
Encoding foramt: "X-TAM-WEBTAMIL".
Definition: fs_convert.h:208
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1250
Encoding foramt: "CP1250".
Definition: fs_convert.h:128
foxit::addon::conversion::TXT2PDFSettingData::font
common::Font font
A font object.
Definition: fs_convert.h:624
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatTSCII
Encoding foramt: "TSCII".
Definition: fs_convert.h:168
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatJAGRAN
Encoding foramt: "JAGRAN".
Definition: fs_convert.h:174
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP1257
Encoding foramt: "CP1257".
Definition: fs_convert.h:142
fs_pdfpage.h
Header file for PDF page related definitions and classes.
foxit::addon::conversion::HTML2PDFSettingData::to_render_images
bool to_render_images
Used to decide whether to render images or not.
Definition: fs_convert.h:483
foxit::addon::conversion::TXT2PDFSettingData::text_size
float text_size
Font size. If valid, it should be above 0.
Definition: fs_convert.h:627
foxit::addon::conversion::HTML2PDFSettingData::e_ScalingModeNone
Scaling mode: Fixed page with no scale.
Definition: fs_convert.h:58
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatUTF_32BE
Encoding foramt: "UTF-32BE".
Definition: fs_convert.h:188
foxit::addon::conversion::HTML2PDFSettingData::to_set_headerfooter
bool to_set_headerfooter
Used to decide whether to set header-footer or not.
Definition: fs_convert.h:489
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatBIG5_CP950
Encoding foramt: "BIG5-CP950".
Definition: fs_convert.h:114
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_SoftBank_Shift_JIS
Encoding foramt: "X-SoftBank-Shift_JIS".
Definition: fs_convert.h:214
foxit::addon::conversion::HTML2PDFSettingData::e_PageModeMultiplePage
Multiple page mode.
Definition: fs_convert.h:48
foxit::addon::conversion::HTML2PDFSettingData::bookmark_root_name
foxit::WString bookmark_root_name
The bookmark's root name.
Definition: fs_convert.h:498
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_KDDI_Shift_JIS
Encoding foramt: "X-KDDI-Shift_JIS".
Definition: fs_convert.h:210
foxit::addon::conversion::TXT2PDFSettingData::operator=
TXT2PDFSettingData & operator=(const TXT2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:571
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatHZ_GB_2312
Encoding foramt: "HZ-GB-2312".
Definition: fs_convert.h:194
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatUTF_16BE
Encoding foramt: "UTF-16BE".
Definition: fs_convert.h:184
foxit::addon::conversion::TXT2PDFSettingData::TXT2PDFSettingData
TXT2PDFSettingData()
Constructor.
Definition: fs_convert.h:529
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_8859_8_I
Encoding foramt: "ISO-8859-8-I".
Definition: fs_convert.h:150
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP874
Encoding foramt: "CP874".
Definition: fs_convert.h:124
foxit::addon::conversion::HTML2PDFSettingData::page_mode
HTML2PDFPageMode page_mode
The page mode used for the converting. Please refer to values starting from HTML2PDFSettingData::e_Pa...
Definition: fs_convert.h:466
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
foxit::addon::conversion::TXT2PDFSettingData::TXT2PDFSettingData
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:552
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:780
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_TAM_TMNEWS
Encoding foramt: "X-TAM-TMNEWS".
Definition: fs_convert.h:206
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatX_TAM_LTTMBARANI
Encoding foramt: "X-TAM-LTTMBARANI".
Definition: fs_convert.h:200
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatEUC_CN
Encoding foramt: "EUC-CN".
Definition: fs_convert.h:104
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatEUC
Encoding foramt: "EUC".
Definition: fs_convert.h:110
foxit::addon::conversion::HTML2PDFSettingData::e_PageModeSinglePage
Single page mode.
Definition: fs_convert.h:46
foxit::addon::conversion::TXT2PDFSettingData::text_color
ARGB text_color
Font color.
Definition: fs_convert.h:630
foxit::addon::conversion::HTML2PDFSettingData::operator=
HTML2PDFSettingData & operator=(const HTML2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:329
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatLatin6
Encoding foramt: "Latin6".
Definition: fs_convert.h:84
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_2022_CN
Encoding foramt: "ISO_2022_CN".
Definition: fs_convert.h:166
foxit::addon::conversion::TXT2PDFSettingData::linespace
float linespace
Line spacing. If valid, it should be above 0.
Definition: fs_convert.h:633
foxit::addon::conversion::HTML2PDFSettingData::scaling_mode
HTML2PDFScalingMode scaling_mode
The scaling mode used for the converted PDF document. Please refer to values starting from HTML2PDFSe...
Definition: fs_convert.h:475
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatGreek
Encoding foramt: "Greek".
Definition: fs_convert.h:90
foxit::int32
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
foxit::addon::conversion::HTML2PDFSettingData::encoding_format
HTML2PDFEncodingFormat encoding_format
The HTML encoding format Please refer to values starting from HTML2PDFSettingData::e_EncodingFormatDe...
Definition: fs_convert.h:480
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCP932
Encoding foramt: "CP932".
Definition: fs_convert.h:126
foxit::addon::conversion::HTML2PDFSettingData::to_generate_bookmarks
bool to_generate_bookmarks
Used to decide whether bookmarks should be generated or not.
Definition: fs_convert.h:469
foxit::common::Font
Definition: fs_common.h:1344
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatCNS
Encoding foramt: "CNS".
Definition: fs_convert.h:112
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatLatin2
Encoding foramt: "Latin2".
Definition: fs_convert.h:76
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatUTF_32LE
Encoding foramt: "UTF-32LE".
Definition: fs_convert.h:190
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatLatin3
Encoding foramt: "Latin3".
Definition: fs_convert.h:78
foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFEncodingFormat
HTML2PDFEncodingFormat
Enumeration for encoding format used for converting HTML to PDF.
Definition: fs_convert.h:70
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFMediaStyle
HTML2PDFMediaStyle
Enumeration for media style used for converting HTML to PDF.
Definition: fs_convert.h:226
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatSJS
Encoding foramt: "SJS".
Definition: fs_convert.h:96
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatISO_8859_13
Encoding foramt: "ISO-8859-13".
Definition: fs_convert.h:156
foxit::addon::conversion::HTML2PDFSettingData::is_generate_tag
bool is_generate_tag
Used to decide whether the tag should be generated or not.
Definition: fs_convert.h:460
foxit::addon::conversion::HTML2PDFSettingData::page_height
float page_height
The page height used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:432
foxit::addon::conversion::TXT2PDFSettingData::is_break_page
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:636
foxit::addon::conversion::TXT2PDFSettingData
Definition: fs_convert.h:526
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatLatin4
Encoding foramt: "Latin4".
Definition: fs_convert.h:80
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatASCII
Encoding foramt: "ASCII".
Definition: fs_convert.h:74
foxit::addon::conversion::TXT2PDFSettingData::page_width
float page_width
Page width used for the converted PDF document.
Definition: fs_convert.h:610
foxit::Base
Definition: fs_basictypes.h:413
foxit::addon::conversion::HTML2PDFSettingData::to_resize_objects
bool to_resize_objects
Whether to enable the Javascripts related resizing of the objects during rendering process.
Definition: fs_convert.h:501
foxit::addon::conversion::Convert
Definition: fs_convert.h:1245
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatBIG5_HKSCS
Encoding foramt: "BIG5_HKSCS".
Definition: fs_convert.h:164
foxit::addon::conversion::HTML2PDFSettingData::e_EncodingFormatUTF7
Encoding foramt: "UTF7".
Definition: fs_convert.h:178
foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFSettingData
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)
Constructor, with parameters.
Definition: fs_convert.h:293