Foxit PDF SDK
fs_actioncallback.h
Go to the documentation of this file.
1 
15 #ifndef FS_ACTIONCALLBACK_H_
16 #define FS_ACTIONCALLBACK_H_
17 
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 
26 namespace foxit {
27 class MenuList;
28 class MenuItemEx;
30 FSDK_DEFINE_ARRAY(MenuListArray, MenuList)
31 FSDK_DEFINE_ARRAY(MenuItemExArray, MenuItemEx)
32 
33 
34 class MenuList FS_FINAL : public Object {
35  public:
37  MenuList() : level(0) {}
38 
46  MenuList(int level, const wchar_t* name, MenuListArray sub_menu_list_array) {
47  this->level = level;
48  if (name)
49  this->name = name;
50  this->sub_menu_list_array = sub_menu_list_array;
51  }
52 
58  MenuList(const MenuList& menu_list) {
59  level = menu_list.level;
60  name = menu_list.name;
61  sub_menu_list_array = menu_list.sub_menu_list_array;
62  }
63 
71  MenuList& operator = (const MenuList& menu_list) {
72  this->level = menu_list.level;
73  this->name = menu_list.name;
74  this->sub_menu_list_array = menu_list.sub_menu_list_array;
75  return *this;
76  }
77 
87  void Set(int level, const wchar_t* name, MenuListArray sub_menu_list_array) {
88  this->level = level;
89  if (name)
90  this->name = name;
91  this->sub_menu_list_array = sub_menu_list_array;
92  }
93 
99  int level;
104 };
105 
107 class MenuItemEx FS_FINAL : public Object {
108  public:
111 
121  MenuItemEx(const wchar_t* item_name, const wchar_t* return_name, bool is_checked, bool is_enabled, MenuItemExArray sub_menu_item_array) {
122  if (item_name)
123  this->item_name = item_name;
124  if (return_name)
125  this->return_name = return_name;
126  this->is_checked = is_checked;
127  this->is_enabled = is_enabled;
128  this->sub_menu_item_array = sub_menu_item_array;
129  }
130 
136  MenuItemEx(const MenuItemEx& menu_item) {
137  item_name = menu_item.item_name;
138  return_name = menu_item.return_name;
139  is_checked = menu_item.is_checked;
140  is_enabled = menu_item.is_enabled;
142  }
143 
151  MenuItemEx& operator = (const MenuItemEx& menu_item) {
152  this->item_name = menu_item.item_name;
153  this->return_name = menu_item.return_name;
154  this->is_checked = menu_item.is_checked;
155  this->is_enabled = menu_item.is_enabled;
156  this->sub_menu_item_array = menu_item.sub_menu_item_array;
157  return *this;
158  }
159 
171  void Set(const wchar_t* item_name, const wchar_t* return_name, bool is_checked, bool is_enabled, MenuItemExArray sub_menu_item_array) {
172  if (item_name)
173  this->item_name = item_name;
174  if (return_name)
175  this->return_name = return_name;
176  this->is_checked = is_checked;
177  this->is_enabled = is_enabled;
178  this->sub_menu_item_array = sub_menu_item_array;
179  }
180 
183 
186 
194 
202 
204  MenuItemExArray sub_menu_item_array;
205 };
206 
211 class IdentityProperties FS_FINAL : public Object {
212  public:
215 
228  IdentityProperties(const wchar_t* corporation, const wchar_t* email, const wchar_t* login_name, const wchar_t* name, const wchar_t* first_name,
229  const wchar_t* last_name, const wchar_t* title, const wchar_t* department)
231  , email(email)
233  , name(name)
236  , title(title)
238 
244  IdentityProperties(const IdentityProperties& id_properities)
245  : corporation(id_properities.corporation)
246  , email(id_properities.email)
247  , login_name(id_properities.login_name)
248  , name(id_properities.name)
249  , first_name(id_properities.first_name)
250  , last_name(id_properities.last_name)
251  , title(id_properities.title)
252  , department(id_properities.department) {}
253 
268  void Set(const wchar_t* corporation, const wchar_t* email, const wchar_t* login_name, const wchar_t* name, const wchar_t* first_name,
269  const wchar_t* last_name, const wchar_t* title, const wchar_t* department) {
270  this->corporation = corporation;
271  this->email = email;
272  this->login_name = login_name;
273  this->name = name;
274  this->first_name = first_name;
275  this->last_name = last_name;
276  this->title = title;
277  this->department = department;
278  }
279 
296 };
297 
299 class ButtonItem FS_FINAL : public Object{
300  public:
303 
316  ButtonItem(const wchar_t* name, int pos,const wchar_t* exec, const wchar_t* enable,
317  const wchar_t* marked, const wchar_t* tooltip, const wchar_t* label, const common::Bitmap& bitmap)
318  : name(name)
319  , pos(pos)
320  , exec(exec)
321  , enable(enable)
322  , marked(marked)
323  , tooltip(tooltip)
324  , label(label)
325  , bitmap(bitmap){}
326 
332  ButtonItem(const ButtonItem& button_item)
333  : name(button_item.name)
334  , pos(button_item.pos)
335  , exec(button_item.exec)
336  , enable(button_item.enable)
337  , marked(button_item.marked)
338  , tooltip(button_item.tooltip)
339  , label(button_item.label)
340  , bitmap(button_item.bitmap){}
341 
356  void Set(const wchar_t* name, int pos, const wchar_t* exec, const wchar_t* enable,
357  const wchar_t* marked, const wchar_t* tooltip, const wchar_t* label, const common::Bitmap& bitmap) {
358  this->name = name;
359  this->pos = pos;
360  this->exec = exec;
361  this->enable = enable;
362  this->marked = marked;
363  this->tooltip = tooltip;
364  this->label = label;
365  this->bitmap = bitmap;
366  }
367 
371  int pos;
384 };
386 class MenuItemConfig FS_FINAL : public Object{
387  public:
390 
404  MenuItemConfig(const wchar_t* name, const wchar_t* user, const wchar_t* parent, int pos, const char* pos_str,
405  const wchar_t* exec, const wchar_t* enable, const wchar_t* marked)
406  : name(name)
407  , user(user)
408  , parent(parent)
409  , pos(pos)
410  , pos_str(pos_str)
411  , exec(exec)
412  , enable(enable)
413  , marked(marked) {}
414 
420  MenuItemConfig(const MenuItemConfig& menu_item_config)
421  : name(menu_item_config.name)
422  , user(menu_item_config.user)
423  , parent(menu_item_config.parent)
424  , pos(menu_item_config.pos)
425  , pos_str(menu_item_config.pos_str)
426  , exec(menu_item_config.exec)
427  , enable(menu_item_config.enable)
428  , marked(menu_item_config.marked) {}
429 
445  void Set(const wchar_t* name, const wchar_t* user, const wchar_t* parent, int pos, const char* pos_str,
446  const wchar_t* exec, const wchar_t* enable, const wchar_t* marked) {
447  this->name = name;
448  this->user = user;
449  this->parent = parent;
450  this->pos = pos;
451  this->pos_str = pos_str;
452  this->exec = exec;
453  this->enable = enable;
454  this->marked = marked;
455  }
463  int pos;
476 };
477 
481 
482 
483 class DialogDescriptionElement FS_FINAL : public Object{
484  public:
487 
506  DialogDescriptionElement(const char* name, const char* item_id, const char* type, const char* next_tab, int width, int height, int char_width, int char_height,
507  const char* font, bool bold, bool italic, const char* alignment, const char* align_children, DialogDescriptionElementArray element_array)
508  : name(name)
509  , item_id(item_id)
510  , type(type)
511  , next_tab(next_tab)
512  , width(width)
513  , height(height)
514  , char_width(char_width)
515  , char_height(char_height)
516  , font(font)
517  , bold(bold)
518  , italic(italic)
519  , alignment(alignment)
520  , align_children(align_children)
521  , element_array(element_array) {}
522 
529  : name(dlg_des_element.name)
530  , item_id(dlg_des_element.item_id)
531  , type(dlg_des_element.type)
532  , next_tab(dlg_des_element.next_tab)
533  , width(dlg_des_element.width)
534  , height(dlg_des_element.height)
535  , char_width(dlg_des_element.char_width)
536  , char_height(dlg_des_element.char_height)
537  , font(dlg_des_element.font)
538  , bold(dlg_des_element.bold)
539  , italic(dlg_des_element.italic)
540  , alignment(dlg_des_element.alignment)
541  , align_children(dlg_des_element.align_children)
542  , element_array(dlg_des_element.element_array) {}
543 
551  DialogDescriptionElement& operator = (const DialogDescriptionElement& dlg_des_element) {
552  this->name = dlg_des_element.name;
553  this->item_id = dlg_des_element.item_id;
554  this->type = dlg_des_element.type;
555  this->next_tab = dlg_des_element.next_tab;
556  this->width = dlg_des_element.width;
557  this->height = dlg_des_element.height;
558  this->char_width = dlg_des_element.char_width;
559  this->char_height = dlg_des_element.char_height;
560  this->font = dlg_des_element.font;
561  this->bold = dlg_des_element.bold;
562  this->italic = dlg_des_element.italic;
563  this->alignment = dlg_des_element.alignment;
564  this->align_children = dlg_des_element.align_children;
565  this->element_array = dlg_des_element.element_array;
566  return *this;
567  }
568 
589  void Set(const char* name, const char* item_id, const char* type, const char* next_tab, int width, int height, int char_width, int char_height,
590  const char* font, bool bold, bool italic, const char* alignment, const char* align_children, DialogDescriptionElementArray element_array) {
591  this->name = name;
592  this->item_id = item_id;
593  this->type = type;
594  this->next_tab = next_tab;
595  this->width = width;
596  this->height = height;
597  this->char_width = char_width;
598  this->char_height = char_height;
599  this->font = font;
600  this->bold = bold;
601  this->italic = italic;
602  this->alignment = alignment;
603  this->align_children = align_children;
604  this->element_array = element_array;
605  }
606 
620  int width;
621 
627  int height;
652  bool bold;
654  bool italic;
661 };
662 
664 class DialogDescriptionConfig FS_FINAL : public Object{
665  public:
668 
681  DialogDescriptionConfig(const char* name, const char* first_tab, int width, int height,
683  : name(name)
685  , width(width)
686  , height(height)
691 
698  : name(dlg_des_config.name)
699  , first_tab(dlg_des_config.first_tab)
700  , width(dlg_des_config.width)
701  , height(dlg_des_config.height)
702  , char_width(dlg_des_config.char_width)
703  , char_height(dlg_des_config.char_height)
704  , align_children(dlg_des_config.align_children)
705  , element_array(dlg_des_config.element_array) {}
706 
715  this->name = dlg_des_config.name;
716  this->first_tab = dlg_des_config.first_tab;
717  this->width = dlg_des_config.width;
718  this->height = dlg_des_config.height;
719  this->char_width = dlg_des_config.char_width;
720  this->char_height = dlg_des_config.char_height;
721  this->align_children = dlg_des_config.align_children;
722  this->element_array = dlg_des_config.element_array;
723  return *this;
724  }
725 
740  void Set(const char* name, const char* first_tab, int width, int height, int char_width, int char_height,
742  this->name = name;
743  this->first_tab = first_tab;
744  this->width = width;
745  this->height = height;
746  this->char_width = char_width;
747  this->char_height = char_height;
748  this->align_children = align_children;
749  this->element_array = element_array;
750  }
751 
754 
761 
767  int width;
768 
774  int height;
775 
782 
789 
792 
795 };
796 
798 class PrintParams FS_FINAL: public Object{
799  public:
805  typedef enum _PrintContent {
812  } PrintContent;
813 
819  typedef enum _DuplexType {
826  } DuplexType;
827 
833  typedef enum _BookletDuplexMode {
841 
847  typedef enum _BookletBinding {
865  } BookletBinding;
866 
872  typedef enum _PageOrder {
879  } PageOrder;
880 
886  typedef enum _PrintHandling {
902  } PrintHandling;
903 
904 
907  : is_show_ui(false)
908  , is_reverse(false)
909  , is_print_as_image(false)
910  , is_print_auto_center(false)
911  , is_print_auto_rotate(false)
912  , is_simulate_overprinting(false)
913  , is_print_page_border(false)
914  , page_range(common::Range())
916  , printer_name(L"")
917  , output_file_name(L"")
918  , num_copies(0)
920  , is_tile_label(false)
921  , tile_mark(false)
922  , tile_overlap(0)
923  , tile_scale(0)
927  , num_pages_h(0)
928  , num_pages_v(0)
930  {}
931 
937  PrintParams(const PrintParams& print_params)
938  : is_show_ui(print_params.is_show_ui)
939  , is_reverse(print_params.is_reverse)
940  , is_print_as_image(print_params.is_print_as_image)
945  , page_range(print_params.page_range)
946  , print_content(print_params.print_content)
947  , printer_name(print_params.printer_name)
948  , output_file_name(print_params.output_file_name)
949  , num_copies(print_params.num_copies)
950  , duplex_type(print_params.duplex_type)
951  , is_tile_label(print_params.is_tile_label)
952  , tile_mark(print_params.tile_mark)
953  , tile_overlap(print_params.tile_overlap)
954  , tile_scale(print_params.tile_scale)
955  , handling(print_params.handling)
956  , binding(print_params.binding)
958  , num_pages_h(print_params.num_pages_h)
959  , num_pages_v(print_params.num_pages_v)
960  , page_order(print_params.page_order) {}
961 
969  PrintParams& operator=(const PrintParams& print_params) {
970  this->is_show_ui = print_params.is_show_ui;
971  this->is_reverse = print_params.is_reverse;
972  this->is_print_as_image = print_params.is_print_as_image;
973  this->is_print_auto_center = print_params.is_print_auto_center;
974  this->is_print_auto_rotate = print_params.is_print_auto_rotate;
976  this->is_print_page_border = print_params.is_print_page_border;
977  this->page_range = print_params.page_range;
978  this->print_content = print_params.print_content;
979  this->printer_name = print_params.printer_name;
980  this->output_file_name = print_params.output_file_name;
981  this->num_copies = print_params.num_copies;
982  this->duplex_type = print_params.duplex_type;
983  this->is_tile_label = print_params.is_tile_label;
984  this->tile_mark = print_params.tile_mark;
985  this->tile_overlap = print_params.tile_overlap;
986  this->tile_scale = print_params.tile_scale;
987  this->handling = print_params.handling;
988  this->binding = print_params.binding;
989  this->booklet_duplex_mode = print_params.booklet_duplex_mode;
990  this->num_pages_h = print_params.num_pages_h;
991  this->num_pages_v = print_params.num_pages_v;
992  this->page_order = print_params.page_order;
993  return *this;
994  }
995 
1048  float tile_scale;
1071 };
1072 
1074 class FloatingInfo FS_FINAL : public Object{
1075  public:
1081  typedef enum _WindowPosition {
1100  } WindowPosition;
1101 
1107  typedef enum _RelativeTarget {
1116  } RelativeTarget;
1117 
1123  typedef enum _ResizeType {
1130  } ResizeType;
1131 
1137  typedef enum _OffScreenAction {
1144  } OffScreenAction;
1145 
1146 
1149 
1163  bool has_close, bool has_title, const wchar_t* title, OffScreenAction off_screen, const RectF& rect)
1167  , has_close(has_close)
1168  , has_title(has_title)
1169  , title(title)
1171  , rect(rect) {}
1172 
1178  FloatingInfo(const FloatingInfo& floating_info)
1179  : window_pos(floating_info.window_pos)
1180  , relative_target(floating_info.relative_target)
1181  , resize_type(floating_info.resize_type)
1182  , has_close(floating_info.has_close)
1183  , has_title(floating_info.has_title)
1184  , title(floating_info.title)
1185  , off_screen(floating_info.off_screen)
1186  , rect(floating_info.rect) {}
1187 
1195  FloatingInfo& operator = (const FloatingInfo& floating_info) {
1196  this->window_pos = floating_info.window_pos;
1197  this->relative_target = floating_info.relative_target;
1198  this->resize_type = floating_info.resize_type;
1199  this->has_close = floating_info.has_close;
1200  this->has_title = floating_info.has_title;
1201  this->title = floating_info.title;
1202  this->off_screen = floating_info.off_screen;
1203  this->rect = floating_info.rect;
1204  return *this;
1205  }
1206 
1222  bool has_close, bool has_title, const wchar_t* title, OffScreenAction off_screen, const RectF& rect) {
1223  this->window_pos = window_pos;
1224  this->relative_target = relative_target;
1225  this->resize_type = resize_type;
1226  this->has_close = has_close;
1227  this->has_title = has_title;
1228  this->title = title;
1229  this->off_screen = off_screen;
1230  this->rect = rect;
1231  }
1232 
1238 
1244 
1250 
1253 
1256 
1259 
1265 
1268 };
1269 
1271 class MediaSettings FS_FINAL : public Object{
1272  public:
1278  typedef enum _PlayerWindowType {
1285  } PlayerWindowType;
1286 
1287 
1290 
1308  int duration, int page, int repeat, bool show_ui, bool is_visible, int volume,
1310  : auto_play(auto_play)
1311  , base_url(base_url)
1312  , bg_color(bg_color)
1314  , duration(duration)
1315  , page(page)
1316  , repeat(repeat)
1317  , show_ui(show_ui)
1319  , volume(volume)
1322 
1328  MediaSettings(const MediaSettings& media_settings)
1329  : auto_play(media_settings.auto_play)
1330  , base_url(media_settings.base_url)
1331  , bg_color(media_settings.bg_color)
1332  , bg_opacity(media_settings.bg_opacity)
1333  , duration(media_settings.duration)
1334  , page(media_settings.page)
1335  , repeat(media_settings.repeat)
1336  , show_ui(media_settings.show_ui)
1337  , is_visible(media_settings.is_visible)
1338  , volume(media_settings.volume)
1339  , window_type(media_settings.window_type)
1340  , floating_wnd_info(media_settings.floating_wnd_info) {}
1341 
1349  MediaSettings& operator = (const MediaSettings& media_settings) {
1350  this->auto_play = media_settings.auto_play;
1351  this->base_url = media_settings.base_url;
1352  this->bg_color = media_settings.bg_color;
1353  this->bg_opacity = media_settings.bg_opacity;
1354  this->duration = media_settings.duration;
1355  this->page = media_settings.page;
1356  this->repeat = media_settings.repeat;
1357  this->show_ui = media_settings.show_ui;
1358  this->is_visible = media_settings.is_visible;
1359  this->volume = media_settings.volume;
1360  this->window_type = media_settings.window_type;
1361  this->floating_wnd_info = media_settings.floating_wnd_info;
1362  return *this;
1363  }
1364 
1383  void Set(bool auto_play, const wchar_t* base_url, foxit::RGB bg_color, float bg_opacity,
1384  int duration, int page, int repeat, bool show_ui, bool is_visible, int volume,
1386  this->auto_play = auto_play;
1387  this->base_url = base_url;
1388  this->bg_color = bg_color;
1389  this->bg_opacity = bg_opacity;
1390  this->duration = duration;
1391  this->page = page;
1392  this->repeat = repeat;
1393  this->show_ui = show_ui;
1394  this->is_visible = is_visible;
1395  this->volume = volume;
1396  this->window_type = window_type;
1397  this->floating_wnd_info = floating_wnd_info;
1398  }
1399 
1406 
1414 
1417 
1419  float bg_opacity;
1420 
1423 
1428  int page;
1429 
1435  int repeat;
1436 
1438  bool show_ui;
1439 
1442 
1444  int volume;
1445 
1451 
1454 
1455 };
1456 
1458 class PlayerArgs FS_FINAL : public Object{
1459  public:
1462 
1474  const wchar_t* audio_format, const MediaSettings& player_settings)
1475  : doc(doc)
1477  , rendition(rendition)
1478  , URL(URL)
1481 
1487  PlayerArgs(const PlayerArgs& player_args)
1488  : doc(player_args.doc)
1489  , screen_annot(player_args.screen_annot)
1490  , rendition(player_args.rendition)
1491  , URL(player_args.URL)
1492  , audio_format(player_args.audio_format)
1493  , player_settings(player_args.player_settings) {}
1494 
1502  PlayerArgs& operator = (const PlayerArgs& player_args) {
1503  this->doc = player_args.doc;
1504  this->screen_annot = player_args.screen_annot;
1505  this->rendition = player_args.rendition;
1506  this->URL = player_args.URL;
1507  this->audio_format = player_args.audio_format;
1508  this->player_settings = player_args.player_settings;
1509  return *this;
1510  }
1511 
1524  void Set(const pdf::PDFDoc& doc, const pdf::annots::Screen& screen_annot, const pdf::Rendition& rendition, const wchar_t* URL,
1525  const wchar_t* audio_format, const MediaSettings& player_settings) {
1526  this->doc = doc;
1527  this->screen_annot = screen_annot;
1528  this->rendition = rendition;
1529  this->URL = URL;
1530  this->audio_format = audio_format;
1531  this->player_settings = player_settings;
1532  }
1533 
1540 
1547 
1554 
1557 
1560 
1563 };
1564 
1570  public:
1576  typedef enum _JSMediaPlayerState {
1588 
1589 
1595  virtual void Release() = 0;
1596 
1604  virtual bool Play() = 0;
1605 
1613  virtual void Close() = 0;
1614 
1622  virtual bool Stop() = 0;
1623 
1633  virtual bool Seek(int current_pos) = 0;
1634 
1642  virtual JSMediaPlayerState GetState() = 0;
1643 
1651  virtual MediaSettings GetPlayerSettings() = 0;
1652 
1653  protected:
1654  ~MediaPlayerCallback() {}
1655 };
1656 
1663  public:
1669  typedef enum _Language {
1702  } Language;
1703 
1709  typedef enum _AppInfoType {
1720  } AppInfoType;
1721 
1727  typedef enum _MailType {
1734  } MailType;
1735 
1741  typedef enum _JSFieldValueChangeType {
1749 
1755  typedef enum _JSMediaPlayerState {
1767 
1773  typedef enum _LayoutMode {
1782  } LayoutMode;
1783 
1789  typedef enum _JsMailResult {
1796  } JsMailResult;
1797 
1798 
1804  virtual void Release() = 0;
1805 
1819  virtual bool InvalidateRect(const pdf::PDFDoc& document, int page_index, const RectF& pdf_rect) = 0;
1820 
1831  virtual int GetCurrentPage(const pdf::PDFDoc& document) = 0;
1832 
1844  virtual void SetCurrentPage(const pdf::PDFDoc& document, int page_index) = 0;
1845 
1856  virtual void SetCurrentPage(const pdf::PDFDoc& document, const foxit::pdf::Destination& destination) = 0;
1857 
1871  virtual common::Rotation GetPageRotation(const pdf::PDFDoc& document, int page_index) = 0;
1872 
1886  virtual bool SetPageRotation(const pdf::PDFDoc& document, int page_index, common::Rotation rotation) = 0;
1887 
1900  virtual bool ExecuteNamedAction(const pdf::PDFDoc& document, const char* named_action) = 0;
1901 
1914  virtual bool SetDocChangeMark(const pdf::PDFDoc& document, bool change_mark) = 0;
1915 
1927  virtual bool GetDocChangeMark(const pdf::PDFDoc& document) = 0;
1928 
1937  virtual int GetOpenedDocCount() = 0;
1938 
1950  virtual pdf::PDFDoc GetOpenedDoc(int index) = 0;
1951 
1960  virtual pdf::PDFDoc GetCurrentDoc() = 0;
1961 
1970  virtual pdf::PDFDoc CreateBlankDoc() = 0;
1971 
1983  virtual void CloseDoc(const pdf::PDFDoc& document, bool is_prompt_to_save) = 0;
1984 
1996  virtual bool OpenDoc(const WString& file_path, const WString& password) = 0;
1997 
2015  virtual bool Beep(int type) = 0;
2016 
2035  virtual WString Response(const wchar_t* question, const wchar_t* title, const wchar_t* default_value,
2036  const wchar_t* label, bool is_password) = 0;
2037 
2048  virtual WString GetFilePath(const pdf::PDFDoc& document) = 0;
2049 
2060  virtual bool IsLocalFile(const pdf::PDFDoc& document) = 0;
2061 
2074  virtual WString GetAttachmentsFilePath(const pdf::PDFDoc& pdf_doc, const wchar_t* name) = 0;
2075 
2088  virtual WString GetExtractedEmbeddedFilePath(const pdf::PDFDoc& pdf_doc, const wchar_t* name) = 0;
2089 
2113  virtual bool Print(const pdf::PDFDoc& document, bool is_ui,
2114  const common::Range& page_range, bool is_silent ,
2115  bool is_shrunk_to_fit, bool is_printed_as_image,
2116  bool is_reversed, bool is_to_print_annots) = 0;
2117 
2129  virtual bool Print(const pdf::PDFDoc& document, const PrintParams& print_params) = 0;
2130 
2146  virtual bool SubmitForm(const pdf::PDFDoc& document, void* form_data, uint32 length, const char* url, common::FileFormatType file_format_type) = 0;
2147 
2158  virtual bool LaunchURL(const char* url) = 0;
2159 
2168  virtual WString BrowseFile() = 0;
2169 
2184  virtual WString BrowseFile(bool is_open_dialog, const wchar_t* file_format, const wchar_t* file_filter) = 0;
2185 
2195  virtual Language GetLanguage() = 0;
2196 
2228  virtual int Alert(const wchar_t* msg, const wchar_t* title, int type, int icon) = 0;
2229 
2239 
2249  virtual bool SetIdentityProperties(const IdentityProperties& identity_properties) = 0;
2250 
2264  virtual WString PopupMenu(const MenuListArray& menus, bool& is_selected_item) = 0;
2265 
2278  virtual MenuItemEx PopupMenuEx(const MenuItemExArray& menus, bool& is_selected_item) = 0;
2279 
2294  virtual WString GetAppInfo(AppInfoType type) = 0;
2295 
2328  virtual bool MailData(void* data, MailType data_type, bool is_ui, const wchar_t* to,
2329  const wchar_t* subject, const wchar_t* cc, const wchar_t* bcc, const wchar_t* message) = 0;
2330 
2345  virtual uint32 VerifySignature(const pdf::PDFDoc& document, const pdf::Signature& pdf_signature) = 0;
2346 
2357  virtual WString GetUntitledBookmarkName() = 0;
2358 
2368  virtual WStringArray GetPrinterNameList() = 0;
2369 
2379  virtual bool AddToolButton(const ButtonItem& button_item) = 0;
2380 
2390  virtual bool RemoveToolButtom(const wchar_t* button_name) = 0;
2391 
2399  virtual MenuListArray GetMenuItemNameList() = 0;
2400 
2421  virtual bool AddMenuItem(const MenuItemConfig& menu_item_config, bool is_prepend) = 0;
2422 
2432  virtual bool AddSubMenu(const MenuItemConfig& menu_item_config) = 0;
2433 
2443  virtual bool ShowDialog(const DialogDescriptionConfig& dlg_config) = 0;
2444 
2452  virtual bool GetFullScreen() = 0;
2453 
2463  virtual void SetFullScreen(bool is_full_screen) = 0;
2464 
2480  virtual void OnFieldValueChanged(const wchar_t* field_name, JSFieldValueChangeType type, const WStringArray &value_before_changed, const WStringArray &value_after_changed) = 0;
2481 
2491  virtual void UpdateLogicalLabel() = 0;
2492 
2511  virtual JsMailResult MailDoc(const pdf::PDFDoc& document,
2512  const wchar_t* to_address, const wchar_t* cc_address, const wchar_t* bcc_address,
2513  const wchar_t* subject, const wchar_t* message, bool is_ui) = 0;
2514 
2527  virtual WString GetTemporaryFileName(const pdf::PDFDoc& document, const wchar_t* file_suffix_name) = 0;
2528 
2538  virtual MediaPlayerCallback* OpenMediaPlayer(const PlayerArgs& player_args) = 0;
2539 
2549  virtual WString GetTemporaryDirectory() = 0;
2550 
2562  virtual void Scroll(const PointF& point) = 0;
2563 
2577  virtual void SelectPageNthWord(int page_index, int word_index, bool is_show_selection) = 0;
2578 
2588  virtual PointF GetMousePosition() = 0;
2589 
2600  virtual RectF GetPageWindowRect() = 0;
2601 
2612  virtual LayoutMode GetLayoutMode() = 0;
2613 
2627  virtual void SetLayoutMode(LayoutMode layout_mode, bool is_cover_mode) = 0;
2628 
2638  virtual float GetPageScale() = 0;
2639 
2653  virtual void SetPageScale(foxit::pdf::Destination::ZoomMode zoom_mode, const foxit::pdf::Destination& dest) = 0;
2654 
2666 
2667  protected:
2668  virtual ~ActionCallback() {}
2669 };
2670 } // namespace foxit
2671 
2672 #endif // FS_ACTIONCALLBACK_H_
2673 
WString audio_format
The audio format, such as "audio/wav".
Definition: fs_actioncallback.h:1559
virtual foxit::pdf::Destination::ZoomMode GetPageZoomMode()=0
A callback function to get the current page zoom mode.
virtual void Release()=0
A callback function used to release current callback object itself.
LayoutMode
Enumeration for layout mode.
Definition: fs_actioncallback.h:1773
Print Handling: Pages are enlarged or shrunk to fit the printe's paper.
Definition: fs_actioncallback.h:890
String type
The type of this dialog box element.
Definition: fs_actioncallback.h:612
MediaSettings()
Constructor.
Definition: fs_actioncallback.h:1289
PrintParams(const PrintParams &print_params)
Constructor, with another print parameters object.
Definition: fs_actioncallback.h:937
WString last_name
The user last name.
Definition: fs_actioncallback.h:291
WString enable
An expression string that determines whether to enable the toolbutton.
Definition: fs_actioncallback.h:375
int num_copies
The number of copies to be printed.
Definition: fs_actioncallback.h:1035
MailType
Enumeration for data type to be mailed.
Definition: fs_actioncallback.h:1727
Definition: fs_annot.h:4209
media player state: Stop.
Definition: fs_actioncallback.h:1584
virtual int Alert(const wchar_t *msg, const wchar_t *title, int type, int icon)=0
A callback function used to pop up a dialog to show warnings or hints.
virtual bool Beep(int type)=0
A callback function to cause the system to play a sound.
Mailed data type: string message.
Definition: fs_actioncallback.h:1733
French.
Definition: fs_actioncallback.h:1685
JSFieldValueChangeType
Enumeration for javascript field value change type.
Definition: fs_actioncallback.h:1741
virtual int GetOpenedDocCount()=0
A callback function to receive the count of opened documents.
Definition: fs_common.h:1179
Print Content: print the document contents and comments.
Definition: fs_actioncallback.h:809
float tile_overlap
The number of points that tiled pages have in common.
Definition: fs_actioncallback.h:1046
PrintContent
Enumeration for the values used to set the contents of the print job.
Definition: fs_actioncallback.h:805
PageOrder page_order
The value determines how the multiple pages are laid out on the sheet. Please refer to values startin...
Definition: fs_actioncallback.h:1070
Definition: fs_image.h:36
WindowPosition
Enumeration for the window position used for media player.
Definition: fs_actioncallback.h:1081
WString parent
The name of the parent menu item. Its submenu will have the new menu item added to it.
Definition: fs_actioncallback.h:461
bool is_print_auto_center
true means that each page is automatically centered relative to the paper.
Definition: fs_actioncallback.h:1009
MenuItemEx()
Constructor.
Definition: fs_actioncallback.h:110
virtual void Release()=0
A callback function used to release current callback object itself.
void Set(int level, const wchar_t *name, MenuListArray sub_menu_list_array)
Set values.
Definition: fs_actioncallback.h:87
WString name
The title of menu.
Definition: fs_actioncallback.h:101
virtual WString PopupMenu(const MenuListArray &menus, bool &is_selected_item)=0
A callback function to pop up a menu window.
virtual bool SubmitForm(const pdf::PDFDoc &document, void *form_data, uint32 length, const char *url, common::FileFormatType file_format_type)=0
A callback function to submit the form data to a specified URL.
int width
The width of the dialog box in pixels.
Definition: fs_actioncallback.h:767
Resize type: may be resized without preserving the aspect ratio.
Definition: fs_actioncallback.h:1129
WString exec
(Only used by An expression string to evaluate when the menu item is selected by the user.
Definition: fs_actioncallback.h:467
Definition: fs_actioncallback.h:30
String name
The displayed name of the dialog box element.
Definition: fs_actioncallback.h:608
common::Bitmap bitmap
A bitmap object of button.
Definition: fs_actioncallback.h:383
virtual void Scroll(const PointF &point)=0
A callback function to scroll the specified point on the current page into the middle of the current ...
MediaSettings player_settings
A MediaSettings object.
Definition: fs_actioncallback.h:1562
virtual PointF GetMousePosition()=0
A callback function to get current mouse position.
RelativeTarget
Enumeration for the values used to set relative position of floating window.
Definition: fs_actioncallback.h:1107
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
void Set(const wchar_t *name, int pos, const wchar_t *exec, const wchar_t *enable, const wchar_t *marked, const wchar_t *tooltip, const wchar_t *label, const common::Bitmap &bitmap)
Set values.
Definition: fs_actioncallback.h:356
Window position: at the bottom center.
Definition: fs_actioncallback.h:1097
virtual WString GetFilePath(const pdf::PDFDoc &document)=0
A callback function to get the file path of current PDF document.
media player state: Open.
Definition: fs_actioncallback.h:1578
BookletBinding binding
The value determines the paper binding direction and the page arrange order. Please refer to values s...
Definition: fs_actioncallback.h:1056
String font
The font to use for this element.
Definition: fs_actioncallback.h:650
virtual Language GetLanguage()=0
A callback function to get the language of the running viewer application.
Window position: at the top center.
Definition: fs_actioncallback.h:1085
MenuItemEx & operator=(const MenuItemEx &menu_item)
Assign operator.
Definition: fs_actioncallback.h:151
int level
The level of menu.
Definition: fs_actioncallback.h:99
RelativeTarget relative_target
Specify the target to which the floating window is to be aligned. Please refer to values starting fro...
Definition: fs_actioncallback.h:1243
Window position: at the bottom left corner.
Definition: fs_actioncallback.h:1095
Unknown language.
Definition: fs_actioncallback.h:1671
virtual pdf::PDFDoc GetCurrentDoc()=0
A callback function to receive current PDF document object.
Header file for PDF document related definitions and classes.
WString base_url
The base URL to be used to resolve any relative URLs used in the media clip.
Definition: fs_actioncallback.h:1413
Layout mode: two pages.
Definition: fs_actioncallback.h:1779
Definition: fs_actioncallback.h:211
WString department
The department name.
Definition: fs_actioncallback.h:295
String align_children
The alignment for all descendants.
Definition: fs_actioncallback.h:791
Booklet Binding: Left-side binding for Western-style left-to-right reading direction....
Definition: fs_actioncallback.h:849
int duration
The amount of time in seconds that playback will take.
Definition: fs_actioncallback.h:1422
Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style v...
Definition: fs_actioncallback.h:854
Definition: fs_rendition.h:38
Definition: fs_basictypes.h:224
Off screen action: take no action.
Definition: fs_actioncallback.h:1139
Resize type: may not be resized.
Definition: fs_actioncallback.h:1125
MediaSettings & operator=(const MediaSettings &media_settings)
Assign operator.
Definition: fs_actioncallback.h:1349
FloatingInfo & operator=(const FloatingInfo &floating_info)
Assign operator.
Definition: fs_actioncallback.h:1195
IdentityProperties()
Constructor.
Definition: fs_actioncallback.h:214
PlayerWindowType
Enumeration for the type of window that the media should play in.
Definition: fs_actioncallback.h:1278
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
Application's app version information.
Definition: fs_actioncallback.h:1719
Brazilian Portuguese.
Definition: fs_actioncallback.h:1697
Mailed data type: document.
Definition: fs_actioncallback.h:1729
virtual void SelectPageNthWord(int page_index, int word_index, bool is_show_selection)=0
A callback function to change the current page number and selects the specified word on the page.
Application's forms version information.
Definition: fs_actioncallback.h:1711
virtual void SetCurrentPage(const pdf::PDFDoc &document, int page_index)=0
A callback function used to set the current page by index.
Window position: at the top left corner.
Definition: fs_actioncallback.h:1083
Definition: fx_coordinates.h:30
virtual WString GetTemporaryFileName(const pdf::PDFDoc &document, const wchar_t *file_suffix_name)=0
A callback function to get the temporary file path. The temporary file name combine the document name...
void Set(const pdf::PDFDoc &doc, const pdf::annots::Screen &screen_annot, const pdf::Rendition &rendition, const wchar_t *URL, const wchar_t *audio_format, const MediaSettings &player_settings)
Set values.
Definition: fs_actioncallback.h:1524
Mailed result: mail failed.
Definition: fs_actioncallback.h:1791
Relative type: align the floating window relative to the (selected) monitor display screen.
Definition: fs_actioncallback.h:1115
int volume
Specify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume.
Definition: fs_actioncallback.h:1444
virtual bool SetPageRotation(const pdf::PDFDoc &document, int page_index, common::Rotation rotation)=0
A callback function used to set the rotation value of a page on PDF viewer.
bool auto_play
Specify whether the media clip should begin playing automatically after the player is opened.
Definition: fs_actioncallback.h:1405
PlayerArgs & operator=(const PlayerArgs &player_args)
Assign operator.
Definition: fs_actioncallback.h:1502
Booklet Duplex Mode: only prints all pages that appear on the front side of the paper.
Definition: fs_actioncallback.h:837
German.
Definition: fs_actioncallback.h:1679
Print Handling: Prints multiple pages on the same sheet of paper in the order required to read correc...
Definition: fs_actioncallback.h:901
PrintContent print_content
Specif content for printing. Please refer to values starting from PrintParams::e_PrintContentDocument...
Definition: fs_actioncallback.h:1029
virtual JSMediaPlayerState GetState()=0
A callback function to get the media player state.
virtual common::Rotation GetPageRotation(const pdf::PDFDoc &document, int page_index)=0
A callback function used to receive current displaying rotation of a page on PDF viewer.
WString title
The user title.
Definition: fs_actioncallback.h:293
virtual MenuItemEx PopupMenuEx(const MenuItemExArray &menus, bool &is_selected_item)=0
A callback function to pop up a menu window.
String name
The title bar of the dialog box.
Definition: fs_actioncallback.h:753
PrintHandling handling
The print handling type.Please refer to values starting from PrintParams::e_PrintHandlingNone and thi...
Definition: fs_actioncallback.h:1052
virtual WString Response(const wchar_t *question, const wchar_t *title, const wchar_t *default_value, const wchar_t *label, bool is_password)=0
A callback function to display a dialog box containing a question and an entry field for the user to ...
Norwegian.
Definition: fs_actioncallback.h:1695
bool has_close
true means the floating window should have a close window control button, while false means not.
Definition: fs_actioncallback.h:1252
WIDE STRING CLASS.
Definition: fx_string.h:1452
String next_tab
An ItemID for the next dialog box item in the tab order.
Definition: fs_actioncallback.h:614
media player state: Playing.
Definition: fs_actioncallback.h:1761
pdf::annots::Screen screen_annot
A pdf::annots::Screen object.
Definition: fs_actioncallback.h:1546
DialogDescriptionElementArray element_array
An array of object literals that describe the subelements of this dialog box element.
Definition: fs_actioncallback.h:660
virtual bool Seek(int current_pos)=0
A callback function to seek the media player.
FileFormatType
Enumeration for file format type.
Definition: fs_common.h:227
FloatingInfo floating_wnd_info
A FloatingInfo containing properties (listed below) that define the location and style of a floating ...
Definition: fs_actioncallback.h:1453
ButtonItem(const wchar_t *name, int pos, const wchar_t *exec, const wchar_t *enable, const wchar_t *marked, const wchar_t *tooltip, const wchar_t *label, const common::Bitmap &bitmap)
Constructor, with parameters.
Definition: fs_actioncallback.h:316
ButtonItem(const ButtonItem &button_item)
Constructor, with another button item object.
Definition: fs_actioncallback.h:332
virtual JsMailResult MailDoc(const pdf::PDFDoc &document, const wchar_t *to_address, const wchar_t *cc_address, const wchar_t *bcc_address, const wchar_t *subject, const wchar_t *message, bool is_ui)=0
A callback function to mails a document as an attachment.
Definition: fs_action.h:65
bool is_tile_label
Label each page of tiled output. Labeled pages indicate row and column, file name,...
Definition: fs_actioncallback.h:1042
MenuItemExArray sub_menu_item_array
The sub menu item array.
Definition: fs_actioncallback.h:204
Definition: fs_pdfdoc.h:508
PageOrder
Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
Definition: fs_actioncallback.h:872
int width
Specifies the width of the element in pixels.
Definition: fs_actioncallback.h:620
virtual bool Play()=0
A callback function to play the media player.
bool italic
Specify if the font is italic.
Definition: fs_actioncallback.h:654
bool is_checked
A boolean value which indicates whether the menu item is to be marked as checked.
Definition: fs_actioncallback.h:193
MediaSettings(const MediaSettings &media_settings)
Constructor, with another media settings object.
Definition: fs_actioncallback.h:1328
virtual pdf::PDFDoc CreateBlankDoc()=0
A callback function to create a blank PDF document object.
Window type: a full-screen window that obscures all other windows.
Definition: fs_actioncallback.h:1284
void Set(bool auto_play, const wchar_t *base_url, foxit::RGB bg_color, float bg_opacity, int duration, int page, int repeat, bool show_ui, bool is_visible, int volume, PlayerWindowType window_type, const FloatingInfo &floating_wnd_info)
Set values.
Definition: fs_actioncallback.h:1383
DuplexType
Enumeration for the values used to set the printing duplex mode.
Definition: fs_actioncallback.h:819
Resize type: may be resized only if the aspect ratio is preserved.
Definition: fs_actioncallback.h:1127
Chinese Simplified.
Definition: fs_actioncallback.h:1673
virtual bool OpenDoc(const WString &file_path, const WString &password)=0
A callback function to open a PDF file.
media player state: Close.
Definition: fs_actioncallback.h:1580
Definition: fs_actioncallback.h:1569
MenuItemConfig(const wchar_t *name, const wchar_t *user, const wchar_t *parent, int pos, const char *pos_str, const wchar_t *exec, const wchar_t *enable, const wchar_t *marked)
Constructor, with parameters.
Definition: fs_actioncallback.h:404
virtual void SetLayoutMode(LayoutMode layout_mode, bool is_cover_mode)=0
A callback function to set the page layout of the current document.
Layout mode: continuous page.
Definition: fs_actioncallback.h:1777
Window position: at the center right.
Definition: fs_actioncallback.h:1093
Language
Enumeration for language.
Definition: fs_actioncallback.h:1669
int char_width
Specifies the width of the element in characters.
Definition: fs_actioncallback.h:633
Definition: fs_actioncallback.h:1074
WString corporation
The corporation name.
Definition: fs_actioncallback.h:281
void Set(const wchar_t *name, const wchar_t *user, const wchar_t *parent, int pos, const char *pos_str, const wchar_t *exec, const wchar_t *enable, const wchar_t *marked)
Set values.
Definition: fs_actioncallback.h:445
BookletBinding
Enumeration for the values used to determine the duplex printing mode when printing a booklet.
Definition: fs_actioncallback.h:847
DuplexType duplex_type
Sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed....
Definition: fs_actioncallback.h:1040
virtual void SetPageScale(foxit::pdf::Destination::ZoomMode zoom_mode, const foxit::pdf::Destination &dest)=0
A callback function to set current page zoom value.
Page Order type: pages are placed from right to left, from top to bottom.
Definition: fs_actioncallback.h:876
WString enable
(Only used by An expression string that is evaluated to determine whether to enable the menu item.
Definition: fs_actioncallback.h:469
virtual void UpdateLogicalLabel()=0
A callback function to update logical label.
Definition: fs_actioncallback.h:480
PlayerArgs(const PlayerArgs &player_args)
Constructor, with another player args object.
Definition: fs_actioncallback.h:1487
media player state: Suspend.
Definition: fs_actioncallback.h:1765
AppInfoType
Enumeration for application's information type.
Definition: fs_actioncallback.h:1709
Print Handling: Pages are rescaled to print multiple pages on each printer page.
Definition: fs_actioncallback.h:894
virtual RectF GetPageWindowRect()=0
A callback function to get the rectangle for the page view window. The page view window is the area i...
MenuList(const MenuList &menu_list)
Constructor, with another menu list object.
Definition: fs_actioncallback.h:58
String pos_str
(Only used by The string is a named item in the menu (a language-independent name of a menu item).
Definition: fs_actioncallback.h:465
virtual bool AddToolButton(const ButtonItem &button_item)=0
A callback function to add a tool button.
MenuItemEx(const wchar_t *item_name, const wchar_t *return_name, bool is_checked, bool is_enabled, MenuItemExArray sub_menu_item_array)
Constructor, with parameters.
Definition: fs_actioncallback.h:121
ResizeType resize_type
Specify whether the floating window may be resized by the user. Please refer to values starting from ...
Definition: fs_actioncallback.h:1249
int char_height
The height of the dialog box in characters.
Definition: fs_actioncallback.h:788
bool tile_mark
true means to cut the page, and false means not.
Definition: fs_actioncallback.h:1044
PrintParams()
Constructor.
Definition: fs_actioncallback.h:906
Mailed result: user abort.
Definition: fs_actioncallback.h:1795
Print Handling: No page scaling is applied.
Definition: fs_actioncallback.h:888
Definition: fs_actioncallback.h:1662
WString tooltip
The text to display in the button help text when the mouse is over the toolbutton.
Definition: fs_actioncallback.h:379
virtual MenuListArray GetMenuItemNameList()=0
A callback function to get the menu item name list.
IdentityProperties(const wchar_t *corporation, const wchar_t *email, const wchar_t *login_name, const wchar_t *name, const wchar_t *first_name, const wchar_t *last_name, const wchar_t *title, const wchar_t *department)
Constructor, with parameters.
Definition: fs_actioncallback.h:228
Window position: at the bottom right corner.
Definition: fs_actioncallback.h:1099
JsMailResult
Enumeration for result of the mail.
Definition: fs_actioncallback.h:1789
PlayerWindowType window_type
That defines which type of window the media player should be created in. Please refer to values start...
Definition: fs_actioncallback.h:1450
WString title
This title to be displayed if has_title is true.
Definition: fs_actioncallback.h:1258
int repeat
The number of times the media playback should automatically repeat.
Definition: fs_actioncallback.h:1435
virtual void OnFieldValueChanged(const wchar_t *field_name, JSFieldValueChangeType type, const WStringArray &value_before_changed, const WStringArray &value_after_changed)=0
A callback function to notify the value change of the field.
Mailed result: mail success.
Definition: fs_actioncallback.h:1793
javascript field value changed type: format.
Definition: fs_actioncallback.h:1743
Window type: a docked page window.
Definition: fs_actioncallback.h:1280
PlayerArgs()
Constructor.
Definition: fs_actioncallback.h:1461
Window position: at the center left.
Definition: fs_actioncallback.h:1089
Page Order type: pages are placed from left to right, from top to bottom.
Definition: fs_actioncallback.h:874
Off screen action: move or resize the window so that it is on-screen.
Definition: fs_actioncallback.h:1141
virtual void Close()=0
A callback function to close the media player.
WString first_name
The user first name.
Definition: fs_actioncallback.h:289
Definition: fs_actioncallback.h:1271
Definition: fs_actioncallback.h:107
virtual LayoutMode GetLayoutMode()=0
A callback function to get the page layout of the current document.
virtual bool ExecuteNamedAction(const pdf::PDFDoc &document, const char *named_action)=0
A callback function to execute a named action.
virtual WString GetTemporaryDirectory()=0
A callback function to get temporary directory.
MediaSettings(bool auto_play, const wchar_t *base_url, foxit::RGB bg_color, float bg_opacity, int duration, int page, int repeat, bool show_ui, bool is_visible, int volume, PlayerWindowType window_type, const FloatingInfo &floating_wnd_info)
Constructor, with parameters.
Definition: fs_actioncallback.h:1307
Print Handling: Small pages are printed small, and large pages are shrunk to fit on the printer's pap...
Definition: fs_actioncallback.h:892
FloatingInfo(WindowPosition window_pos, RelativeTarget relative_target, ResizeType resize_type, bool has_close, bool has_title, const wchar_t *title, OffScreenAction off_screen, const RectF &rect)
Constructor, with parameters.
Definition: fs_actioncallback.h:1162
Booklet Binding: Left-side binding for Western-style left-to-right reading direction....
Definition: fs_actioncallback.h:859
bool is_enabled
A boolean value which indicates whether the menu item is to appear enabled or grayed out.
Definition: fs_actioncallback.h:201
String alignment
The alignment for this element.
Definition: fs_actioncallback.h:656
WString name
The user name.
Definition: fs_actioncallback.h:287
virtual void SetFullScreen(bool is_full_screen)=0
A callback function to set full screen mode.
FloatingInfo()
Constructor.
Definition: fs_actioncallback.h:1148
virtual bool AddSubMenu(const MenuItemConfig &menu_item_config)=0
A callback function to add a menu item with a submenu to the application.
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:72
bool is_simulate_overprinting
true means to do overprint preview when printing. false means not.
Definition: fs_actioncallback.h:1016
Booklet Duplex Mode: only prints all pages that appear on the back side of the paper.
Definition: fs_actioncallback.h:839
Definition: fs_actioncallback.h:1458
int height
Specifies the height of the element in pixels.
Definition: fs_actioncallback.h:627
DialogDescriptionConfig & operator=(const DialogDescriptionConfig &dlg_des_config)
Assign operator.
Definition: fs_actioncallback.h:714
int pos
The position within the submenu to locate the new menu item.
Definition: fs_actioncallback.h:463
media player state: Stop.
Definition: fs_actioncallback.h:1763
foxit::RGB bg_color
The background color for the media player window. Format: 0xRRGGBB.
Definition: fs_actioncallback.h:1416
bool is_visible
A boolean value that specifies whether the player should be visible.
Definition: fs_actioncallback.h:1441
float tile_scale
The amount that tiled pages are scaled.
Definition: fs_actioncallback.h:1048
MenuItemConfig()
Constructor.
Definition: fs_actioncallback.h:389
Print Handling: Small or normal pages are printed in the original size and large pages are printed on...
Definition: fs_actioncallback.h:899
String item_id
An ItemID for this dialog box.
Definition: fs_actioncallback.h:610
void Set(const char *name, const char *first_tab, int width, int height, int char_width, int char_height, const char *align_children, DialogDescriptionElementArray element_array)
Set values.
Definition: fs_actioncallback.h:740
int char_height
Specifies the height of the element in characters.
Definition: fs_actioncallback.h:639
Definition: fs_actioncallback.h:798
media player state: Suspend.
Definition: fs_actioncallback.h:1586
MenuItemConfig(const MenuItemConfig &menu_item_config)
Constructor, with another menu item config object.
Definition: fs_actioncallback.h:420
OffScreenAction off_screen
Specify what action should be taken if the floating window is positioned totally or partially offscre...
Definition: fs_actioncallback.h:1264
bool bold
Specify if the font is bold.
Definition: fs_actioncallback.h:652
ResizeType
Enumeration for the resize type, which specifies whether a floating window may be resized by the user...
Definition: fs_actioncallback.h:1123
bool is_reverse
true means that the printing order should be from parameter end to parameter start.
Definition: fs_actioncallback.h:1005
WString return_name
A string to be returned when the menu item is selected. The default is the value of item name.
Definition: fs_actioncallback.h:185
BookletDuplexMode
Enumeration for the values used to determine the duplex printing mode when printing a booklet.
Definition: fs_actioncallback.h:833
Dutch.
Definition: fs_actioncallback.h:1693
virtual bool InvalidateRect(const pdf::PDFDoc &document, int page_index, const RectF &pdf_rect)=0
A callback function to invalidate the client area within the specified rectangle.
DialogDescriptionConfig()
Constructor.
Definition: fs_actioncallback.h:667
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
Definition: fs_actioncallback.h:299
Print Content: print the contents of form fields only. Useful for printing onto pre-preprinted forms.
Definition: fs_actioncallback.h:811
JSMediaPlayerState
Enumeration for media player state.
Definition: fs_actioncallback.h:1755
Header file for common definitions and classes.
virtual MediaSettings GetPlayerSettings()=0
A callback function to get the media player settings.
Definition: fs_actioncallback.h:34
int pos
The button number to place the added button in the toolbar.
Definition: fs_actioncallback.h:371
Danish.
Definition: fs_actioncallback.h:1677
virtual float GetPageScale()=0
A callback function to get current page zoom value.
Duplex type: prints on one side of the paper.
Definition: fs_actioncallback.h:821
int num_pages_v
The number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet.
Definition: fs_actioncallback.h:1065
virtual void CloseDoc(const pdf::PDFDoc &document, bool is_prompt_to_save)=0
A callback function to close document.
FloatingInfo(const FloatingInfo &floating_info)
Constructor, with another floating infomation object.
Definition: fs_actioncallback.h:1178
WString name
A unique language-independent identifier for the button.
Definition: fs_actioncallback.h:369
virtual WString GetUntitledBookmarkName()=0
A callback function to get the new name for an untitled bookmark.
String align_children
The alignment for all descendants.
Definition: fs_actioncallback.h:658
virtual bool SetDocChangeMark(const pdf::PDFDoc &document, bool change_mark)=0
A callback function to set the change mark which indicates whether the content of document is changed...
bool show_ui
A boolean value that specifies whether the controls of the media player should be visible or not.
Definition: fs_actioncallback.h:1438
int page
For a docked media player, this property is the number of the page on which the player should be dock...
Definition: fs_actioncallback.h:1428
WString URL
Either URL or rendition is required, with URL taking precedence.
Definition: fs_actioncallback.h:1556
virtual bool GetDocChangeMark(const pdf::PDFDoc &document)=0
A callback function to receive the change mark which indicates whether the content of document is cha...
DialogDescriptionConfig(const DialogDescriptionConfig &dlg_des_config)
Constructor, with another dialog description config object.
Definition: fs_actioncallback.h:697
virtual bool IsLocalFile(const pdf::PDFDoc &document)=0
A callback function to check whether the file is local file.
DialogDescriptionElement(const char *name, const char *item_id, const char *type, const char *next_tab, int width, int height, int char_width, int char_height, const char *font, bool bold, bool italic, const char *alignment, const char *align_children, DialogDescriptionElementArray element_array)
Constructor, with parameters.
Definition: fs_actioncallback.h:506
IdentityProperties(const IdentityProperties &id_properities)
Constructor, with another identity properties object.
Definition: fs_actioncallback.h:244
WString label
A text label to be displayed on the button to the right of the icon.
Definition: fs_actioncallback.h:381
RectF rect
A rectangle specifies the location and size of the floating window in device coordinate system.
Definition: fs_actioncallback.h:1267
DialogDescriptionElement()
Constructor.
Definition: fs_actioncallback.h:486
virtual pdf::PDFDoc GetOpenedDoc(int index)=0
A callback function to receive an opened PDF document object by index.
virtual WString GetAttachmentsFilePath(const pdf::PDFDoc &pdf_doc, const wchar_t *name)=0
A callback function to get the file path of attachments file.
Mailed data type: form.
Definition: fs_actioncallback.h:1731
Off screen action: cancel playing the media clip.
Definition: fs_actioncallback.h:1143
javascript field value changed type : calculation.
Definition: fs_actioncallback.h:1745
JSMediaPlayerState
Enumeration for media player state.
Definition: fs_actioncallback.h:1576
bool has_title
true means a title should be displayed in the title bar, while false means not.
Definition: fs_actioncallback.h:1255
DialogDescriptionElementArray element_array
An array of dialog description element array object.
Definition: fs_actioncallback.h:794
int height
The height of the dialog box in pixels.
Definition: fs_actioncallback.h:774
virtual IdentityProperties GetIdentityProperties()=0
A callback function used to get identity properties of current user.
virtual bool Stop()=0
A callback function to stop the media player.
media player state: Close.
Definition: fs_actioncallback.h:1759
bool is_print_auto_rotate
true means that automatically rotates each page to match the page orientation to the available paper ...
Definition: fs_actioncallback.h:1014
virtual bool MailData(void *data, MailType data_type, bool is_ui, const wchar_t *to, const wchar_t *subject, const wchar_t *cc, const wchar_t *bcc, const wchar_t *message)=0
A callback function to mail data or message, with or without user interaction.
WString login_name
The login name. Usually, this is the name used to log in current operating system.
Definition: fs_actioncallback.h:285
virtual bool SetIdentityProperties(const IdentityProperties &identity_properties)=0
A callback function used to set identity properties of current user.
Relative type: align the floating window relative to the application window.
Definition: fs_actioncallback.h:1111
WString marked
An expression string that determines whether the toolbutton is marked.
Definition: fs_actioncallback.h:377
Korean.
Definition: fs_actioncallback.h:1689
void Set(WindowPosition window_pos, RelativeTarget relative_target, ResizeType resize_type, bool has_close, bool has_title, const wchar_t *title, OffScreenAction off_screen, const RectF &rect)
Set values.
Definition: fs_actioncallback.h:1221
MenuList(int level, const wchar_t *name, MenuListArray sub_menu_list_array)
Constructor, with parameters.
Definition: fs_actioncallback.h:46
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Page Order type: pages are placed from top to bottom, from left to right.
Definition: fs_actioncallback.h:878
virtual bool AddMenuItem(const MenuItemConfig &menu_item_config, bool is_prepend)=0
A callback function to adds a menu item to a menu.
pdf::Rendition rendition
A pdf::Rendition object (either a MediaRendition or a RenditionList).
Definition: fs_actioncallback.h:1553
Foxit namespace.
Definition: fs_taggedpdf.h:27
Booklet Duplex Mode: automatically prints both sides of the paper.
Definition: fs_actioncallback.h:835
virtual bool Print(const pdf::PDFDoc &document, bool is_ui, const common::Range &page_range, bool is_silent, bool is_shrunk_to_fit, bool is_printed_as_image, bool is_reversed, bool is_to_print_annots)=0
A callback function to print pages within a specified index range.
float bg_opacity
The background opacity for the media player window.
Definition: fs_actioncallback.h:1419
Print Content: print the document contents, not comments.
Definition: fs_actioncallback.h:807
bool is_print_page_border
A boolean value that if true, draws and prints a page boundary around each of the pages during Multip...
Definition: fs_actioncallback.h:1018
PrintHandling
Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
Definition: fs_actioncallback.h:886
MenuItemEx(const MenuItemEx &menu_item)
Constructor, with another menu item object.
Definition: fs_actioncallback.h:136
WString user
The user string (language-dependent name) to display as the menu item name.
Definition: fs_actioncallback.h:459
Window position: at the top right corner.
Definition: fs_actioncallback.h:1087
Duplex type: prints on both sides of the paper; the paper flips along the long edge.
Definition: fs_actioncallback.h:823
MenuList()
Constructor.
Definition: fs_actioncallback.h:37
Duplex type: prints on both sides of the paper; the paper flips along the short edge.
Definition: fs_actioncallback.h:825
BYTE STRING CLASS.
Definition: fx_string.h:317
Layout mode: continuous two pages.
Definition: fs_actioncallback.h:1781
int num_pages_h
The number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet.
Definition: fs_actioncallback.h:1063
WString printer_name
The default printer name for printing.
Definition: fs_actioncallback.h:1031
PlayerArgs(const pdf::PDFDoc &doc, const pdf::annots::Screen &screen_annot, const pdf::Rendition &rendition, const wchar_t *URL, const wchar_t *audio_format, const MediaSettings &player_settings)
Constructor, with parameters.
Definition: fs_actioncallback.h:1473
void Set(const wchar_t *corporation, const wchar_t *email, const wchar_t *login_name, const wchar_t *name, const wchar_t *first_name, const wchar_t *last_name, const wchar_t *title, const wchar_t *department)
Set values.
Definition: fs_actioncallback.h:268
Definition: fs_actioncallback.h:386
PrintParams & operator=(const PrintParams &print_params)
Assign operator.
Definition: fs_actioncallback.h:969
virtual WString GetAppInfo(AppInfoType type)=0
A callback function to get application information.
int char_width
The width of the dialog box in characters.
Definition: fs_actioncallback.h:781
bool is_print_as_image
true means that pages should be printed as image.
Definition: fs_actioncallback.h:1007
virtual bool RemoveToolButtom(const wchar_t *button_name)=0
A callback function to remove a tool button added by the function ActionCallback::AddToolButton.
Italian.
Definition: fs_actioncallback.h:1687
Window position: at the center.
Definition: fs_actioncallback.h:1091
MenuListArray sub_menu_list_array
The sub menu array.
Definition: fs_actioncallback.h:103
WString item_name
The menu item name, which is the string to appear on the menu item. The value of "-" is reserved to d...
Definition: fs_actioncallback.h:182
Relative type: align the floating window relative to the document (page) window.
Definition: fs_actioncallback.h:1109
WString marked
(Only used by An expression string that determines whether the menu item has a check mark next to it....
Definition: fs_actioncallback.h:475
Spanish.
Definition: fs_actioncallback.h:1683
virtual bool GetFullScreen()=0
A callback function to get whether the full screen mode is set.
Application's viewer version information.
Definition: fs_actioncallback.h:1717
void Set(const char *name, const char *item_id, const char *type, const char *next_tab, int width, int height, int char_width, int char_height, const char *font, bool bold, bool italic, const char *alignment, const char *align_children, DialogDescriptionElementArray element_array)
Set values.
Definition: fs_actioncallback.h:589
pdf::PDFDoc doc
The PDFDoc object of the document.
Definition: fs_actioncallback.h:1539
media player state: Open.
Definition: fs_actioncallback.h:1757
Definition: fs_signature.h:93
Relative type: align the floating window relative to the full virtual desktop.
Definition: fs_actioncallback.h:1113
Swedish.
Definition: fs_actioncallback.h:1701
virtual WString GetExtractedEmbeddedFilePath(const pdf::PDFDoc &pdf_doc, const wchar_t *name)=0
A callback function to get the file path of extracted embedded file.
English.
Definition: fs_actioncallback.h:1681
String first_tab
An ItemID for the dialog box item that should be first in the tab order.
Definition: fs_actioncallback.h:760
virtual bool LaunchURL(const char *url)=0
A callback function to launch to a specified URL.
Finnish.
Definition: fs_actioncallback.h:1699
media player state: Playing.
Definition: fs_actioncallback.h:1582
Application's viewer variation information.
Definition: fs_actioncallback.h:1715
virtual bool ShowDialog(const DialogDescriptionConfig &dlg_config)=0
A callback function to show the dialog.
Application's viewer type information.
Definition: fs_actioncallback.h:1713
Window type: a floating window.
Definition: fs_actioncallback.h:1282
virtual MediaPlayerCallback * OpenMediaPlayer(const PlayerArgs &player_args)=0
A callback function to open media player.
WindowPosition window_pos
Specify how the floating window is to be positioned relative to the window specified by the relative...
Definition: fs_actioncallback.h:1237
DialogDescriptionConfig(const char *name, const char *first_tab, int width, int height, int char_width, int char_height, const char *align_children, DialogDescriptionElementArray element_array)
Constructor, with parameters.
Definition: fs_actioncallback.h:681
Layout mode: single page.
Definition: fs_actioncallback.h:1775
Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style v...
Definition: fs_actioncallback.h:864
WString exec
The expression string to evaluate when the button is selected.
Definition: fs_actioncallback.h:373
WString email
The email address.
Definition: fs_actioncallback.h:283
virtual int GetCurrentPage(const pdf::PDFDoc &document)=0
A callback function used to receive current page index.
DialogDescriptionElement(const DialogDescriptionElement &dlg_des_element)
Constructor, with another dialog description element object.
Definition: fs_actioncallback.h:528
Definition: fs_actioncallback.h:483
common::Range page_range
A range object to specify the page range for printing. All the indexes represented in this range woul...
Definition: fs_actioncallback.h:1024
WString output_file_name
The device-independent path for a file name to be used instead of sending the print job to the printe...
Definition: fs_actioncallback.h:1033
ButtonItem()
Constructor.
Definition: fs_actioncallback.h:302
void Set(const wchar_t *item_name, const wchar_t *return_name, bool is_checked, bool is_enabled, MenuItemExArray sub_menu_item_array)
Set values.
Definition: fs_actioncallback.h:171
virtual WString BrowseFile()=0
A callback function to show a file selection dialog, and the selected file path should be returned.
BookletDuplexMode booklet_duplex_mode
The value determines the duplex printing mode when printing a booklet.Please refer to values starting...
Definition: fs_actioncallback.h:1061
bool is_show_ui
true means that a UI should be presented to the user to obtain printing information and confirm the a...
Definition: fs_actioncallback.h:1000
Chinese Traditional.
Definition: fs_actioncallback.h:1675
Japanese.
Definition: fs_actioncallback.h:1691
Definition: fs_actioncallback.h:664
javascript field value changed type: field set.
Definition: fs_actioncallback.h:1747
WString name
The language-independent name of the menu item.
Definition: fs_actioncallback.h:457
Definition: fx_coordinates.h:771
virtual uint32 VerifySignature(const pdf::PDFDoc &document, const pdf::Signature &pdf_signature)=0
A callback function to verify specified signature..
OffScreenAction
Enumeration for the action can be taken if the floating window is positioned totally or partially off...
Definition: fs_actioncallback.h:1137
virtual WStringArray GetPrinterNameList()=0
A callback function to get the printer name list.