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;
101 WString name;
103 MenuListArray sub_menu_list_array;
104 };
105
107 class MenuItemEx FS_FINAL : public Object {
108 public:
110 MenuItemEx() {}
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;
141 sub_menu_item_array = menu_item.sub_menu_item_array;
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
182 WString item_name;
183
185 WString return_name;
186
193 bool is_checked;
194
201 bool is_enabled;
202
204 MenuItemExArray sub_menu_item_array;
205 };
206
211 class IdentityProperties FS_FINAL : public Object {
212 public:
214 IdentityProperties() {}
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)
230 : corporation(corporation)
231 , email(email)
232 , login_name(login_name)
233 , name(name)
234 , first_name(first_name)
235 , last_name(last_name)
236 , title(title)
237 , department(department){}
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
281 WString corporation;
283 WString email;
285 WString login_name;
287 WString name;
289 WString first_name;
291 WString last_name;
293 WString title;
295 WString department;
296 };
297
299 class ButtonItem FS_FINAL : public Object{
300 public:
302 ButtonItem() {}
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
369 WString name;
371 int pos;
373 WString exec;
375 WString enable;
377 WString marked;
379 WString tooltip;
381 WString label;
383 common::Bitmap bitmap;
384 };
385
387 class MenuItemConfig FS_FINAL : public Object{
388 public:
390 MenuItemConfig() {}
391
405 MenuItemConfig(const wchar_t* name, const wchar_t* user, const wchar_t* parent, int pos, const char* pos_str,
406 const wchar_t* exec, const wchar_t* enable, const wchar_t* marked)
407 : name(name)
408 , user(user)
409 , parent(parent)
410 , pos(pos)
411 , pos_str(pos_str)
412 , exec(exec)
413 , enable(enable)
414 , marked(marked) {}
415
421 MenuItemConfig(const MenuItemConfig& menu_item_config)
422 : name(menu_item_config.name)
423 , user(menu_item_config.user)
424 , parent(menu_item_config.parent)
425 , pos(menu_item_config.pos)
426 , pos_str(menu_item_config.pos_str)
427 , exec(menu_item_config.exec)
428 , enable(menu_item_config.enable)
429 , marked(menu_item_config.marked) {}
430
446 void Set(const wchar_t* name, const wchar_t* user, const wchar_t* parent, int pos, const char* pos_str,
447 const wchar_t* exec, const wchar_t* enable, const wchar_t* marked) {
448 this->name = name;
449 this->user = user;
450 this->parent = parent;
451 this->pos = pos;
452 this->pos_str = pos_str;
453 this->exec = exec;
454 this->enable = enable;
455 this->marked = marked;
456 }
458 WString name;
460 WString user;
462 WString parent;
464 int pos;
466 String pos_str;
468 WString exec;
470 WString enable;
476 WString marked;
477 };
478
479 class DialogDescriptionElement;
481 FSDK_DEFINE_ARRAY(DialogDescriptionElementArray, DialogDescriptionElement)
482
483
484 class DialogDescriptionElement FS_FINAL : public Object{
485 public:
487 DialogDescriptionElement() {}
488
507 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,
508 const char* font, bool bold, bool italic, const char* alignment, const char* align_children, DialogDescriptionElementArray element_array)
509 : name(name)
510 , item_id(item_id)
511 , type(type)
512 , next_tab(next_tab)
513 , width(width)
514 , height(height)
515 , char_width(char_width)
516 , char_height(char_height)
517 , font(font)
518 , bold(bold)
519 , italic(italic)
520 , alignment(alignment)
521 , align_children(align_children)
522 , element_array(element_array) {}
523
529 DialogDescriptionElement(const DialogDescriptionElement& dlg_des_element)
530 : name(dlg_des_element.name)
531 , item_id(dlg_des_element.item_id)
532 , type(dlg_des_element.type)
533 , next_tab(dlg_des_element.next_tab)
534 , width(dlg_des_element.width)
535 , height(dlg_des_element.height)
536 , char_width(dlg_des_element.char_width)
537 , char_height(dlg_des_element.char_height)
538 , font(dlg_des_element.font)
539 , bold(dlg_des_element.bold)
540 , italic(dlg_des_element.italic)
541 , alignment(dlg_des_element.alignment)
542 , align_children(dlg_des_element.align_children)
543 , element_array(dlg_des_element.element_array) {}
544
552 DialogDescriptionElement& operator = (const DialogDescriptionElement& dlg_des_element) {
553 this->name = dlg_des_element.name;
554 this->item_id = dlg_des_element.item_id;
555 this->type = dlg_des_element.type;
556 this->next_tab = dlg_des_element.next_tab;
557 this->width = dlg_des_element.width;
558 this->height = dlg_des_element.height;
559 this->char_width = dlg_des_element.char_width;
560 this->char_height = dlg_des_element.char_height;
561 this->font = dlg_des_element.font;
562 this->bold = dlg_des_element.bold;
563 this->italic = dlg_des_element.italic;
564 this->alignment = dlg_des_element.alignment;
565 this->align_children = dlg_des_element.align_children;
566 this->element_array = dlg_des_element.element_array;
567 return *this;
568 }
569
590 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,
591 const char* font, bool bold, bool italic, const char* alignment, const char* align_children, DialogDescriptionElementArray element_array) {
592 this->name = name;
593 this->item_id = item_id;
594 this->type = type;
595 this->next_tab = next_tab;
596 this->width = width;
597 this->height = height;
598 this->char_width = char_width;
599 this->char_height = char_height;
600 this->font = font;
601 this->bold = bold;
602 this->italic = italic;
603 this->alignment = alignment;
604 this->align_children = align_children;
605 this->element_array = element_array;
606 }
607
609 String name;
611 String item_id;
613 String type;
615 String next_tab;
621 int width;
622
628 int height;
634 int char_width;
640 int char_height;
651 String font;
653 bool bold;
655 bool italic;
657 String alignment;
659 String align_children;
661 DialogDescriptionElementArray element_array;
662 };
663
665 class DialogDescriptionConfig FS_FINAL : public Object{
666 public:
668 DialogDescriptionConfig() {}
669
682 DialogDescriptionConfig(const char* name, const char* first_tab, int width, int height,
683 int char_width, int char_height, const char* align_children, DialogDescriptionElementArray element_array)
684 : name(name)
685 , first_tab(first_tab)
686 , width(width)
687 , height(height)
688 , char_width(char_width)
689 , char_height(char_height)
690 , align_children(align_children)
691 , element_array(element_array) {}
692
698 DialogDescriptionConfig(const DialogDescriptionConfig& dlg_des_config)
699 : name(dlg_des_config.name)
700 , first_tab(dlg_des_config.first_tab)
701 , width(dlg_des_config.width)
702 , height(dlg_des_config.height)
703 , char_width(dlg_des_config.char_width)
704 , char_height(dlg_des_config.char_height)
705 , align_children(dlg_des_config.align_children)
706 , element_array(dlg_des_config.element_array) {}
707
715 DialogDescriptionConfig& operator = (const DialogDescriptionConfig& dlg_des_config) {
716 this->name = dlg_des_config.name;
717 this->first_tab = dlg_des_config.first_tab;
718 this->width = dlg_des_config.width;
719 this->height = dlg_des_config.height;
720 this->char_width = dlg_des_config.char_width;
721 this->char_height = dlg_des_config.char_height;
722 this->align_children = dlg_des_config.align_children;
723 this->element_array = dlg_des_config.element_array;
724 return *this;
725 }
726
741 void Set(const char* name, const char* first_tab, int width, int height, int char_width, int char_height,
742 const char* align_children, DialogDescriptionElementArray element_array) {
743 this->name = name;
744 this->first_tab = first_tab;
745 this->width = width;
746 this->height = height;
747 this->char_width = char_width;
748 this->char_height = char_height;
749 this->align_children = align_children;
750 this->element_array = element_array;
751 }
752
754 String name;
755
761 String first_tab;
762
768 int width;
769
775 int height;
776
782 int char_width;
783
789 int char_height;
790
792 String align_children;
793
795 DialogDescriptionElementArray element_array;
796 };
797
799 class SOAPAuthenticateInfo FS_FINAL : public Object {
800 public:
802 SOAPAuthenticateInfo() {}
803
811 SOAPAuthenticateInfo(const wchar_t* username, const wchar_t* password, bool is_use_platform_auth)
812 : username(username)
813 , password(password)
814 , is_use_platform_auth(is_use_platform_auth){}
815
821 SOAPAuthenticateInfo(const SOAPAuthenticateInfo& soap_authenticate)
822 : username(soap_authenticate.username)
823 , password(soap_authenticate.password)
824 , is_use_platform_auth(soap_authenticate.is_use_platform_auth) {}
825
835 void Set(const wchar_t* username, const wchar_t* password, bool is_use_platform_auth) {
836 this->username = username;
837 this->password = password;
838 this->is_use_platform_auth = is_use_platform_auth;
839 }
840
842 WString username;
844 WString password;
853 bool is_use_platform_auth;
854 };
855
857 class SOAPRequestProperties FS_FINAL : public Object {
858 public:
860 SOAPRequestProperties() {}
861
879 SOAPRequestProperties(const wchar_t* request_url, const char* request_content, const wchar_t* soap_action,
880 const wchar_t* soap_namespace, const wchar_t* soap_version, const wchar_t* content_type, bool is_encode,
881 bool is_wiredump, const char* request_header, const SOAPAuthenticateInfo& authenticate)
882 : request_url(request_url)
883 , request_content(request_content)
884 , soap_action(soap_action)
885 , soap_namespace(soap_namespace)
886 , soap_version(soap_version)
887 , content_type(content_type)
888 , is_encode(is_encode)
889 , is_wiredump(is_wiredump)
890 , request_header(request_header)
891 , authenticate(authenticate) {}
892
898 SOAPRequestProperties(const SOAPRequestProperties& request_properties)
899 : request_url(request_properties.request_url)
900 , request_content(request_properties.request_content)
901 , soap_action(request_properties.soap_action)
902 , soap_namespace(request_properties.soap_namespace)
903 , soap_version(request_properties.soap_version)
904 , content_type(request_properties.content_type)
905 , is_encode(request_properties.is_encode)
906 , is_wiredump(request_properties.is_wiredump)
907 , request_header(request_properties.request_header)
908 , authenticate(request_properties.authenticate) {}
909
931 void Set(const wchar_t* request_url, const char* request_content, const wchar_t* soap_action, const wchar_t* soap_namespace,
932 const wchar_t* soap_version, const wchar_t* content_type, bool is_encode, bool is_wiredump, const char* request_header,
933 const SOAPAuthenticateInfo& authenticate) {
934 this->request_url = request_url;
935 this->request_content = request_content;
936 this->soap_action = soap_action;
937 this->soap_namespace = soap_namespace;
938 this->soap_version = soap_version;
939 this->content_type = content_type;
940 this->is_encode = is_encode;
941 this->is_wiredump = is_wiredump;
942 this->request_header = request_header;
943 this->authenticate = authenticate;
944 }
945
947 WString request_url;
949 String request_content;
951 WString soap_action;
958 WString soap_namespace;
960 WString soap_version;
962 WString content_type;
967 bool is_encode;
969 bool is_wiredump;
974 String request_header;
976 SOAPAuthenticateInfo authenticate;
977 };
978
980 class SOAPResponseInfo FS_FINAL : public Object {
981 public:
983 SOAPResponseInfo() {}
984
994 SOAPResponseInfo(const wchar_t* response_header, const wchar_t* response_body, const wchar_t* network_error, uint32 status_code)
995 : response_header(response_header)
996 , response_body(response_body)
997 , network_error(network_error)
998 , status_code(status_code) {}
999
1005 SOAPResponseInfo(const SOAPResponseInfo& soap_response)
1006 : response_header(soap_response.response_header)
1007 , response_body(soap_response.response_body)
1008 , network_error(soap_response.network_error)
1009 , status_code(soap_response.status_code) {}
1010
1021 void Set(const wchar_t* response_header, const wchar_t* response_body, const wchar_t* network_error, uint32 status_code) {
1022 this->response_header = response_header;
1023 this->response_body = response_body;
1024 this->network_error = network_error;
1025 this->status_code = status_code;
1026 }
1027
1029 WString response_header;
1031 WString response_body;
1033 WString network_error;
1035 uint32 status_code;
1036 };
1037
1039 class PrintParams FS_FINAL: public Object{
1040 public:
1046 typedef enum _PrintContent {
1048 e_PrintContentDocument = 0,
1050 e_PrintContentDocAndAnnots = 1,
1052 e_PrintContentFormFieldsOnly = 2
1053 } PrintContent;
1054
1060 typedef enum _DuplexType {
1062 e_DuplexTypeSimplex = 0,
1064 e_DuplexTypeDuplexFlipLongEdge = 1,
1066 e_DuplexTypeDuplexFlipShortEdge = 2
1067 } DuplexType;
1068
1074 typedef enum _BookletDuplexMode {
1076 e_BookletDuplexModeBothSides = 0,
1078 e_BookletDuplexModeFrontSideOnly = 1,
1080 e_BookletDuplexModeBackSideOnly = 2
1081 } BookletDuplexMode;
1082
1088 typedef enum _BookletBinding {
1090 e_BookletBindingRight = 0,
1095 e_BookletBindingLeft = 1,
1100 e_BookletBindingLeftTall = 2,
1105 e_BookletBindingRightTall = 3
1106 } BookletBinding;
1107
1113 typedef enum _PageOrder {
1115 e_PageOrderHorizontal = 0,
1117 e_PageOrderHorizontalReversed = 1,
1119 e_PageOrderVertical = 2
1120 } PageOrder;
1121
1127 typedef enum _PrintHandling {
1129 e_PrintHandlingNone = 0,
1131 e_PrintHandlingFitPaper = 1,
1133 e_PrintHandlingReducePaper = 2,
1135 e_PrintHandlingMultiplePages = 3,
1140 e_PrintHandlingTileLargePages = 4,
1142 e_PrintHandlingBooklet = 5
1143 } PrintHandling;
1144
1145
1147 PrintParams()
1148 : is_show_ui(false)
1149 , is_reverse(false)
1150 , is_print_as_image(false)
1151 , is_print_auto_center(false)
1152 , is_print_auto_rotate(false)
1153 , is_simulate_overprinting(false)
1154 , is_print_page_border(false)
1155 , page_range(common::Range())
1156 , print_content(PrintParams::e_PrintContentDocument)
1157 , printer_name(L"")
1158 , output_file_name(L"")
1159 , num_copies(0)
1160 , duplex_type(PrintParams::e_DuplexTypeSimplex)
1161 , is_tile_label(false)
1162 , tile_mark(false)
1163 , tile_overlap(0)
1164 , tile_scale(0)
1165 , handling(PrintParams::e_PrintHandlingNone)
1166 , binding(PrintParams::e_BookletBindingRight)
1167 , booklet_duplex_mode(PrintParams::e_BookletDuplexModeBothSides)
1168 , num_pages_h(0)
1169 , num_pages_v(0)
1170 , page_order(PrintParams::e_PageOrderHorizontal)
1171 {}
1172
1178 PrintParams(const PrintParams& print_params)
1179 : is_show_ui(print_params.is_show_ui)
1180 , is_reverse(print_params.is_reverse)
1181 , is_print_as_image(print_params.is_print_as_image)
1182 , is_print_auto_center(print_params.is_print_auto_center)
1183 , is_print_auto_rotate(print_params.is_print_auto_rotate)
1184 , is_simulate_overprinting(print_params.is_simulate_overprinting)
1185 , is_print_page_border(print_params.is_print_page_border)
1186 , page_range(print_params.page_range)
1187 , print_content(print_params.print_content)
1188 , printer_name(print_params.printer_name)
1189 , output_file_name(print_params.output_file_name)
1190 , num_copies(print_params.num_copies)
1191 , duplex_type(print_params.duplex_type)
1192 , is_tile_label(print_params.is_tile_label)
1193 , tile_mark(print_params.tile_mark)
1194 , tile_overlap(print_params.tile_overlap)
1195 , tile_scale(print_params.tile_scale)
1196 , handling(print_params.handling)
1197 , binding(print_params.binding)
1198 , booklet_duplex_mode(print_params.booklet_duplex_mode)
1199 , num_pages_h(print_params.num_pages_h)
1200 , num_pages_v(print_params.num_pages_v)
1201 , page_order(print_params.page_order) {}
1202
1210 PrintParams& operator=(const PrintParams& print_params) {
1211 this->is_show_ui = print_params.is_show_ui;
1212 this->is_reverse = print_params.is_reverse;
1213 this->is_print_as_image = print_params.is_print_as_image;
1214 this->is_print_auto_center = print_params.is_print_auto_center;
1215 this->is_print_auto_rotate = print_params.is_print_auto_rotate;
1216 this->is_simulate_overprinting = print_params.is_simulate_overprinting;
1217 this->is_print_page_border = print_params.is_print_page_border;
1218 this->page_range = print_params.page_range;
1219 this->print_content = print_params.print_content;
1220 this->printer_name = print_params.printer_name;
1221 this->output_file_name = print_params.output_file_name;
1222 this->num_copies = print_params.num_copies;
1223 this->duplex_type = print_params.duplex_type;
1224 this->is_tile_label = print_params.is_tile_label;
1225 this->tile_mark = print_params.tile_mark;
1226 this->tile_overlap = print_params.tile_overlap;
1227 this->tile_scale = print_params.tile_scale;
1228 this->handling = print_params.handling;
1229 this->binding = print_params.binding;
1230 this->booklet_duplex_mode = print_params.booklet_duplex_mode;
1231 this->num_pages_h = print_params.num_pages_h;
1232 this->num_pages_v = print_params.num_pages_v;
1233 this->page_order = print_params.page_order;
1234 return *this;
1235 }
1236
1241 bool is_show_ui;
1246 bool is_reverse;
1248 bool is_print_as_image;
1250 bool is_print_auto_center;
1255 bool is_print_auto_rotate;
1257 bool is_simulate_overprinting;
1259 bool is_print_page_border;
1265 common::Range page_range;
1270 PrintContent print_content;
1272 WString printer_name;
1274 WString output_file_name;
1276 int num_copies;
1281 DuplexType duplex_type;
1283 bool is_tile_label;
1285 bool tile_mark;
1287 float tile_overlap;
1289 float tile_scale;
1293 PrintHandling handling;
1297 BookletBinding binding;
1302 BookletDuplexMode booklet_duplex_mode;
1304 int num_pages_h;
1306 int num_pages_v;
1311 PageOrder page_order;
1312 };
1313
1315 class FloatingInfo FS_FINAL : public Object{
1316 public:
1322 typedef enum _WindowPosition {
1324 e_WindowPositionTopLeft = 0,
1326 e_WindowPositionTopCenter = 1,
1328 e_WindowPositionTopRight = 2,
1330 e_WindowPositionCenterLeft = 3,
1332 e_WindowPositionCenter = 4,
1334 e_WindowPositionCenterRight = 5,
1336 e_WindowPositionBottomLeft = 6,
1338 e_WindowPositionBottomCenter = 7,
1340 e_WindowPositionBottomRight = 8
1341 } WindowPosition;
1342
1348 typedef enum _RelativeTarget {
1350 e_RelativeTargetPageWindow = 0,
1352 e_RelativeTargetAppWindow = 1,
1354 e_RelativeTargetDesktop = 2,
1356 e_RelativeTargetMonitor = 3
1357 } RelativeTarget;
1358
1364 typedef enum _ResizeType {
1366 e_ResizeTypeNo = 0,
1368 e_ResizeTypeKeepRatio = 1,
1370 e_ResizeTypeYes = 2
1371 } ResizeType;
1372
1378 typedef enum _OffScreenAction {
1380 e_OffScreenAllow = 0,
1382 e_OffScreenForceOnScreen = 1,
1384 e_OffScreenCancel = 2
1385 } OffScreenAction;
1386
1387
1389 FloatingInfo() {}
1390
1403 FloatingInfo(WindowPosition window_pos, RelativeTarget relative_target, ResizeType resize_type,
1404 bool has_close, bool has_title, const wchar_t* title, OffScreenAction off_screen, const RectF& rect)
1405 : window_pos(window_pos)
1406 , relative_target(relative_target)
1407 , resize_type(resize_type)
1408 , has_close(has_close)
1409 , has_title(has_title)
1410 , title(title)
1411 , off_screen(off_screen)
1412 , rect(rect) {}
1413
1419 FloatingInfo(const FloatingInfo& floating_info)
1420 : window_pos(floating_info.window_pos)
1421 , relative_target(floating_info.relative_target)
1422 , resize_type(floating_info.resize_type)
1423 , has_close(floating_info.has_close)
1424 , has_title(floating_info.has_title)
1425 , title(floating_info.title)
1426 , off_screen(floating_info.off_screen)
1427 , rect(floating_info.rect) {}
1428
1436 FloatingInfo& operator = (const FloatingInfo& floating_info) {
1437 this->window_pos = floating_info.window_pos;
1438 this->relative_target = floating_info.relative_target;
1439 this->resize_type = floating_info.resize_type;
1440 this->has_close = floating_info.has_close;
1441 this->has_title = floating_info.has_title;
1442 this->title = floating_info.title;
1443 this->off_screen = floating_info.off_screen;
1444 this->rect = floating_info.rect;
1445 return *this;
1446 }
1447
1462 void Set(WindowPosition window_pos, RelativeTarget relative_target, ResizeType resize_type,
1463 bool has_close, bool has_title, const wchar_t* title, OffScreenAction off_screen, const RectF& rect) {
1464 this->window_pos = window_pos;
1465 this->relative_target = relative_target;
1466 this->resize_type = resize_type;
1467 this->has_close = has_close;
1468 this->has_title = has_title;
1469 this->title = title;
1470 this->off_screen = off_screen;
1471 this->rect = rect;
1472 }
1473
1478 WindowPosition window_pos;
1479
1484 RelativeTarget relative_target;
1485
1490 ResizeType resize_type;
1491
1493 bool has_close;
1494
1496 bool has_title;
1497
1499 WString title;
1500
1505 OffScreenAction off_screen;
1506
1508 RectF rect;
1509 };
1510
1512 class MediaSettings FS_FINAL : public Object{
1513 public:
1519 typedef enum _PlayerWindowType {
1521 e_PlayerWindowTypeDockedPage = 1,
1523 e_PlayerWindowTypeFloating = 2,
1525 e_PlayerWindowTypeFullScreen = 4
1526 } PlayerWindowType;
1527
1528
1530 MediaSettings(){}
1531
1548 MediaSettings(bool auto_play, const wchar_t* base_url, foxit::RGB bg_color, float bg_opacity,
1549 int duration, int page, int repeat, bool show_ui, bool is_visible, int volume,
1550 PlayerWindowType window_type,const FloatingInfo& floating_wnd_info)
1551 : auto_play(auto_play)
1552 , base_url(base_url)
1553 , bg_color(bg_color)
1554 , bg_opacity(bg_opacity)
1555 , duration(duration)
1556 , page(page)
1557 , repeat(repeat)
1558 , show_ui(show_ui)
1559 , is_visible(is_visible)
1560 , volume(volume)
1561 , window_type(window_type)
1562 , floating_wnd_info(floating_wnd_info) {}
1563
1569 MediaSettings(const MediaSettings& media_settings)
1570 : auto_play(media_settings.auto_play)
1571 , base_url(media_settings.base_url)
1572 , bg_color(media_settings.bg_color)
1573 , bg_opacity(media_settings.bg_opacity)
1574 , duration(media_settings.duration)
1575 , page(media_settings.page)
1576 , repeat(media_settings.repeat)
1577 , show_ui(media_settings.show_ui)
1578 , is_visible(media_settings.is_visible)
1579 , volume(media_settings.volume)
1580 , window_type(media_settings.window_type)
1581 , floating_wnd_info(media_settings.floating_wnd_info) {}
1582
1590 MediaSettings& operator = (const MediaSettings& media_settings) {
1591 this->auto_play = media_settings.auto_play;
1592 this->base_url = media_settings.base_url;
1593 this->bg_color = media_settings.bg_color;
1594 this->bg_opacity = media_settings.bg_opacity;
1595 this->duration = media_settings.duration;
1596 this->page = media_settings.page;
1597 this->repeat = media_settings.repeat;
1598 this->show_ui = media_settings.show_ui;
1599 this->is_visible = media_settings.is_visible;
1600 this->volume = media_settings.volume;
1601 this->window_type = media_settings.window_type;
1602 this->floating_wnd_info = media_settings.floating_wnd_info;
1603 return *this;
1604 }
1605
1624 void Set(bool auto_play, const wchar_t* base_url, foxit::RGB bg_color, float bg_opacity,
1625 int duration, int page, int repeat, bool show_ui, bool is_visible, int volume,
1626 PlayerWindowType window_type, const FloatingInfo& floating_wnd_info) {
1627 this->auto_play = auto_play;
1628 this->base_url = base_url;
1629 this->bg_color = bg_color;
1630 this->bg_opacity = bg_opacity;
1631 this->duration = duration;
1632 this->page = page;
1633 this->repeat = repeat;
1634 this->show_ui = show_ui;
1635 this->is_visible = is_visible;
1636 this->volume = volume;
1637 this->window_type = window_type;
1638 this->floating_wnd_info = floating_wnd_info;
1639 }
1640
1646 bool auto_play;
1647
1654 WString base_url;
1655
1657 foxit::RGB bg_color;
1658
1660 float bg_opacity;
1661
1663 int duration;
1664
1669 int page;
1670
1676 int repeat;
1677
1679 bool show_ui;
1680
1682 bool is_visible;
1683
1685 int volume;
1686
1691 PlayerWindowType window_type;
1692
1694 FloatingInfo floating_wnd_info;
1695
1696 };
1697
1699 class PlayerArgs FS_FINAL : public Object{
1700 public:
1702 PlayerArgs() {}
1703
1714 PlayerArgs(const pdf::PDFDoc& doc, const pdf::annots::Screen& screen_annot, const pdf::Rendition& rendition, const wchar_t* URL,
1715 const wchar_t* audio_format, const MediaSettings& player_settings)
1716 : doc(doc)
1717 , screen_annot(screen_annot)
1718 , rendition(rendition)
1719 , URL(URL)
1720 , audio_format(audio_format)
1721 , player_settings(player_settings) {}
1722
1728 PlayerArgs(const PlayerArgs& player_args)
1729 : doc(player_args.doc)
1730 , screen_annot(player_args.screen_annot)
1731 , rendition(player_args.rendition)
1732 , URL(player_args.URL)
1733 , audio_format(player_args.audio_format)
1734 , player_settings(player_args.player_settings) {}
1735
1743 PlayerArgs& operator = (const PlayerArgs& player_args) {
1744 this->doc = player_args.doc;
1745 this->screen_annot = player_args.screen_annot;
1746 this->rendition = player_args.rendition;
1747 this->URL = player_args.URL;
1748 this->audio_format = player_args.audio_format;
1749 this->player_settings = player_args.player_settings;
1750 return *this;
1751 }
1752
1765 void Set(const pdf::PDFDoc& doc, const pdf::annots::Screen& screen_annot, const pdf::Rendition& rendition, const wchar_t* URL,
1766 const wchar_t* audio_format, const MediaSettings& player_settings) {
1767 this->doc = doc;
1768 this->screen_annot = screen_annot;
1769 this->rendition = rendition;
1770 this->URL = URL;
1771 this->audio_format = audio_format;
1772 this->player_settings = player_settings;
1773 }
1774
1780 pdf::PDFDoc doc;
1781
1787 pdf::annots::Screen screen_annot;
1788
1794 pdf::Rendition rendition;
1795
1797 WString URL;
1798
1800 WString audio_format;
1801
1803 MediaSettings player_settings;
1804 };
1805
1807 class SearchOption FS_FINAL : public Object{
1808 public:
1814 typedef enum _WordMatching {
1816 e_WordMatchingMatchPhrase = 0,
1818 e_WordMatchingMatchAllWords = 1,
1820 e_WordMatchingMatchAnyWord = 2
1821 } WordMatching;
1822
1823
1825 SearchOption() {}
1826
1845 SearchOption(bool is_whole_word, bool is_case_sensitive, bool is_search_bookmarks, bool is_search_in_marup,
1846 bool is_search_in_attachments, bool is_ignore_accents, bool is_proximity, bool is_stemming, bool is_ignore_full_width,
1847 int max_docs, WordMatching word_matching, bool is_search_doc_text)
1848 : is_whole_word(is_whole_word)
1849 , is_case_sensitive(is_case_sensitive)
1850 , is_search_bookmarks(is_search_bookmarks)
1851 , is_search_in_markup(is_search_in_marup)
1852 , is_search_in_attachments(is_search_in_attachments)
1853 , is_ignore_accents(is_ignore_accents)
1854 , is_proximity(is_proximity)
1855 , is_stemming(is_stemming)
1856 , is_ignore_full_width(is_ignore_full_width)
1857 , max_docs(max_docs)
1858 , word_matching(word_matching)
1859 , is_search_doc_text(is_search_doc_text) {}
1860
1866 SearchOption(const SearchOption& search_option)
1867 : is_whole_word(search_option.is_whole_word)
1868 , is_case_sensitive(search_option.is_case_sensitive)
1869 , is_search_bookmarks(search_option.is_search_bookmarks)
1870 , is_search_in_markup(search_option.is_search_in_markup)
1871 , is_search_in_attachments(search_option.is_search_in_attachments)
1872 , is_ignore_accents(search_option.is_ignore_accents)
1873 , is_proximity(search_option.is_proximity)
1874 , is_stemming(search_option.is_stemming)
1875 , is_ignore_full_width(search_option.is_ignore_full_width)
1876 , max_docs(search_option.max_docs)
1877 , word_matching(search_option.word_matching)
1878 , is_search_doc_text(search_option.is_search_doc_text) {}
1879
1887 SearchOption& operator = (const SearchOption& search_option) {
1888 this->is_whole_word = search_option.is_whole_word;
1889 this->is_case_sensitive = search_option.is_case_sensitive;
1890 this->is_search_bookmarks = search_option.is_search_bookmarks;
1891 this->is_search_in_markup = search_option.is_search_in_markup;
1892 this->is_search_in_attachments = search_option.is_search_in_attachments;
1893 this->is_ignore_accents = search_option.is_ignore_accents;
1894 this->is_proximity = search_option.is_proximity;
1895 this->is_stemming = search_option.is_stemming;
1896 this->is_ignore_full_width = search_option.is_ignore_full_width;
1897 this->max_docs = search_option.max_docs;
1898 this->word_matching = search_option.word_matching;
1899 this->is_search_doc_text = search_option.is_search_doc_text;
1900 return *this;
1901 }
1902
1923 void Set(bool is_whole_word, bool is_case_sensitive, bool is_search_bookmarks, bool is_search_in_marup,
1924 bool is_search_in_attachments, bool is_ignore_accents, bool is_proximity, bool is_stemming, bool is_ignore_full_width,
1925 int max_docs, WordMatching word_matching, bool is_search_doc_text) {
1926 this->is_whole_word = is_whole_word;
1927 this->is_case_sensitive = is_case_sensitive;
1928 this->is_search_bookmarks = is_search_bookmarks;
1929 this->is_search_in_markup = is_search_in_marup;
1930 this->is_search_in_attachments = is_search_in_attachments;
1931 this->is_ignore_accents = is_ignore_accents;
1932 this->is_proximity = is_proximity;
1933 this->is_stemming = is_stemming;
1934 this->is_ignore_full_width = is_ignore_full_width;
1935 this->max_docs = max_docs;
1936 this->word_matching = word_matching;
1937 this->is_search_doc_text = is_search_doc_text;
1938 }
1939
1941 bool is_whole_word;
1943 bool is_case_sensitive;
1945 bool is_search_bookmarks;
1947 bool is_search_in_markup;
1949 bool is_search_in_attachments;
1951 bool is_ignore_accents;
1956 bool is_proximity;
1961 bool is_stemming;
1967 bool is_ignore_full_width;
1969 int max_docs;
1975 WordMatching word_matching;
1977 bool is_search_doc_text;
1978 };
1979
1981 class SearchIndexConfig FS_FINAL : public Object{
1982 public:
1984 SearchIndexConfig() {}
1985
1994 SearchIndexConfig(WString name, bool is_available, WString path, bool is_selected)
1995 : name(name)
1996 , is_available(is_available)
1997 , path(path)
1998 , is_selected(is_selected) {}
1999
2005 SearchIndexConfig(const SearchIndexConfig& search_index_config)
2006 : name(search_index_config.name)
2007 , is_available(search_index_config.is_available)
2008 , path(search_index_config.path)
2009 , is_selected(search_index_config.is_selected) {}
2010
2018 SearchIndexConfig& operator = (const SearchIndexConfig& search_index_config) {
2019 this->name = search_index_config.name;
2020 this->is_available = search_index_config.is_available;
2021 this->path = search_index_config.path;
2022 this->is_selected = search_index_config.is_selected;
2023 return *this;
2024 }
2025
2036 void Set(WString name, bool is_available, WString path, bool is_selected) {
2037 this->name = name;
2038 this->is_available = is_available;
2039 this->path = path;
2040 this->is_selected = is_selected;
2041 }
2043 WString name;
2044
2049 bool is_available;
2050
2052 WString path;
2053
2058 bool is_selected;
2059 };
2060
2065 class MediaPlayerCallback {
2066 public:
2072 typedef enum _JSMediaPlayerState {
2074 e_JSMediaPlayerStateOpen = 0,
2076 e_JSMediaPlayerStateClose = 1,
2078 e_JSMediaPlayerStatePlaying = 2,
2080 e_JSMediaPlayerStateStop = 3,
2082 e_JSMediaPlayerStateSuspend = 4
2083 } JSMediaPlayerState;
2084
2085
2091 virtual void Release() = 0;
2092
2100 virtual bool Play() = 0;
2101
2109 virtual void Close() = 0;
2110
2118 virtual bool Stop() = 0;
2119
2129 virtual bool Seek(int current_pos) = 0;
2130
2138 virtual JSMediaPlayerState GetState() = 0;
2139
2147 virtual MediaSettings GetPlayerSettings() = 0;
2148
2149 protected:
2150 ~MediaPlayerCallback() {}
2151 };
2152
2154 class JavascriptModifyItemInfo FS_FINAL : public Object {
2155 public:
2161 typedef enum _JavascriptEventType {
2163 e_JavascriptEventTypeUnknown = 0,
2165 e_JavascriptEventTypeAppInit = 1,
2167 e_JavascriptEventTypeHtmlCallback = 2,
2169 e_JavascriptEventTypeDocOpen = 3,
2171 e_JavascriptEventTypeDocWillPrint = 4,
2173 e_JavascriptEventTypeDocDidprint = 5,
2175 e_JavascriptEventTypeDocWillSave = 6,
2177 e_JavascriptEventTypeDocDidSave = 7,
2179 e_JavascriptEventTypeDocWillClose = 8,
2181 e_JavascriptEventTypePageOpen = 9,
2183 e_JavascriptEventTypePageClose = 10,
2185 e_JavascriptEventTypePageInView = 11,
2187 e_JavascriptEventTypePageOutView = 12,
2189 e_JavascriptEventTypeFieldMouseDown = 13,
2191 e_JavascriptEventTypeFieldMouseUp = 14,
2193 e_JavascriptEventTypeFieldMouseEnter = 15,
2195 e_JavascriptEventTypeFieldMouseExit = 16,
2197 e_JavascriptEventTypeFieldFocus = 17,
2199 e_JavascriptEventTypeFieldBlur= 18,
2201 e_JavascriptEventTypeFieldKeyStroke= 19,
2203 e_JavascriptEventTypeFieldValidate= 21,
2205 e_JavascriptEventTypeFieldCalculate= 22,
2207 e_JavascriptEventTypeFieldFormat= 23,
2209 e_JavascriptEventTypeScreenFocus = 24,
2211 e_JavascriptEventTypeScreenBlur = 25,
2213 e_JavascriptEventTypeScreenOpen = 26,
2215 e_JavascriptEventTypeScreenClose = 27,
2217 e_JavascriptEventTypeScreenMouseDown = 28,
2219 e_JavascriptEventTypeScreenMouseUp = 29,
2221 e_JavascriptEventTypeScreenMouseEnter = 30,
2223 e_JavascriptEventTypeScreenMouseExit = 31,
2225 e_JavascriptEventTypeScreenInview = 32,
2227 e_JavascriptEventTypeScreenOutview = 33,
2229 e_JavascriptEventTypeBatchExec = 34,
2231 e_JavascriptEventTypeMenuExec = 35,
2233 e_JavascriptEventTypeConsoleExec = 36,
2235 e_JavascriptEventTypeExternalExec = 37,
2237 e_JavascriptEventTypeBookmarkMouseUp = 38,
2239 e_JavascriptEventTypeLinkMouseUp = 39,
2241 e_JavascriptEventTypeMediaBlur = 40,
2243 e_JavascriptEventTypeMediaClose = 41,
2245 e_JavascriptEventTypeMediaDone = 42,
2247 e_JavascriptEventTypeMediaPlay = 43,
2249 e_JavascriptEventTypeMediaReady = 44,
2251 e_JavascriptEventTypeMediaSeek = 45,
2253 e_JavascriptEventTypeMediaStop = 46
2254 } JavascriptEventType;
2255
2261 typedef enum _JavascriptModifyItemType {
2263 e_JavascriptModifyItemTypeNone = 0,
2265 e_JavascriptModifyItemTypeField = 1,
2267 e_JavascriptModifyItemTypeAnnot = 2,
2269 e_JavascriptModifyItemTypePage = 3,
2271 e_JavascriptModifyItemTypeDoc= 4
2272 } JavascriptModifyItemType;
2273
2279 typedef enum _JavascriptModifyPropertyType {
2281 e_JavascriptModifyPropertyTypeNone = 0,
2283 e_JavascriptModifyPropertyTypeBorderColor = 1,
2285 e_JavascriptModifyPropertyTypeFillColor = 2,
2287 e_JavascriptModifyPropertyTypeTextColor = 3,
2289 e_JavascriptModifyPropertyTypeValue = 4,
2291 e_JavascriptModifyPropertyTypeCharLimit = 5,
2293 e_JavascriptModifyPropertyTypeButtonPosition = 6,
2295 e_JavascriptModifyPropertyTypeSelectChange = 7,
2297 e_JavascriptModifyPropertyTypeAlignment = 8,
2299 e_JavascriptModifyPropertyTypeBorderStyle = 9,
2301 e_JavascriptModifyPropertyTypeButtonAlignX = 10,
2303 e_JavascriptModifyPropertyTypeButtonAlignY = 11,
2305 e_JavascriptModifyPropertyTypeButtonFitBounds = 12,
2307 e_JavascriptModifyPropertyTypeButtonScaleHow = 13,
2309 e_JavascriptModifyPropertyTypeButtonScaleWhen = 14,
2311 e_JavascriptModifyPropertyTypeComb = 15,
2313 e_JavascriptModifyPropertyTypeDefaultStyle = 16,
2315 e_JavascriptModifyPropertyTypeDefaultValue = 17,
2317 e_JavascriptModifyPropertyTypeDoNotScroll = 18,
2319 e_JavascriptModifyPropertyTypeDelay= 19,
2321 e_JavascriptModifyPropertyTypeDisplay = 20,
2323 e_JavascriptModifyPropertyTypeEditable = 21,
2325 e_JavascriptModifyPropertyTypeNotSpellCheck = 22,
2327 e_JavascriptModifyPropertyTypeHidden = 23,
2329 e_JavascriptModifyPropertyTypeHighlight= 24,
2331 e_JavascriptModifyPropertyTypeLineWidth = 25,
2333 e_JavascriptModifyPropertyTypeMultiline = 26,
2335 e_JavascriptModifyPropertyTypePassword = 27,
2337 e_JavascriptModifyPropertyTypeRect = 28,
2339 e_JavascriptModifyPropertyTypeRequired = 29,
2341 e_JavascriptModifyPropertyTypeRichText = 30,
2343 e_JavascriptModifyPropertyTypeRichValue = 31,
2345 e_JavascriptModifyPropertyTypeRotation = 32,
2347 e_JavascriptModifyPropertyTypeNormalCaption = 33,
2349 e_JavascriptModifyPropertyTypeDownCaption = 34,
2351 e_JavascriptModifyPropertyTypeRolloverCaption = 35,
2353 e_JavascriptModifyPropertyTypeTextFont = 36,
2355 e_JavascriptModifyPropertyTypeUserName = 37,
2357 e_JavascriptModifyPropertyTypeButtonSetIcon = 38,
2359 e_JavascriptModifyPropertyTypeCheckThisBox = 39,
2361 e_JavascriptModifyPropertyTypeClearItems = 40,
2363 e_JavascriptModifyPropertyTypeDefaultIsChecked = 41,
2365 e_JavascriptModifyPropertyTypeDeleteItemAt = 42,
2367 e_JavascriptModifyPropertyTypeInsertItemAt = 43,
2369 e_JavascriptModifyPropertyTypeSetItems = 44,
2371 e_JavascriptModifyPropertyTypeActivated = 45,
2373 e_JavascriptModifyPropertyTypeArrowBegin = 46,
2375 e_JavascriptModifyPropertyTypeArrowEnd = 47,
2377 e_JavascriptModifyPropertyTypeAttachIcon = 48,
2379 e_JavascriptModifyPropertyTypeBorderEffectIntensity = 49,
2381 e_JavascriptModifyPropertyTypeBorderEffectStyle = 50,
2383 e_JavascriptModifyPropertyTypeCallout = 51,
2385 e_JavascriptModifyPropertyTypeCaretSymbol = 52,
2387 e_JavascriptModifyPropertyTypeContents = 53,
2389 e_JavascriptModifyPropertyTypeDash = 54,
2391 e_JavascriptModifyPropertyTypeDoCaption = 55,
2393 e_JavascriptModifyPropertyTypeGestures = 56,
2395 e_JavascriptModifyPropertyTypeIntent = 57,
2397 e_JavascriptModifyPropertyTypeLeaderExtend = 58,
2399 e_JavascriptModifyPropertyTypeLeaderLength = 59,
2401 e_JavascriptModifyPropertyTypeLineEnding = 60,
2403 e_JavascriptModifyPropertyTypeNoteIcon = 61,
2405 e_JavascriptModifyPropertyTypeToggleNoView = 62,
2407 e_JavascriptModifyPropertyTypeOpacity = 63,
2409 e_JavascriptModifyPropertyTypePoints = 64,
2411 e_JavascriptModifyPropertyTypeQuads = 65,
2413 e_JavascriptModifyPropertyTypeTextSize = 66,
2415 e_JavascriptModifyPropertyTypeRichContents = 67,
2417 e_JavascriptModifyPropertyTypeRichDefaults = 68,
2419 e_JavascriptModifyPropertyTypeSoundIcon = 69,
2421 e_JavascriptModifyPropertyTypeSubject = 70,
2423 e_JavascriptModifyPropertyTypeVertices = 71,
2425 e_JavascriptModifyPropertyTypeImport = 72,
2427 e_JavascriptModifyPropertyTypeRemoveDataObject = 73,
2429 e_JavascriptModifyPropertyTypeImportDataObject = 74,
2431 e_JavascriptModifyPropertyTypeRemoveTemplate = 75,
2433 e_JavascriptModifyPropertyTypeAddPageTemplate = 76,
2435 e_JavascriptModifyPropertyTypeRsetForms = 77,
2437 e_JavascriptModifyPropertyTypeRsetAllForms = 78,
2439 e_JavascriptModifyPropertyTypeTitle = 79,
2441 e_JavascriptModifyPropertyTypeResizePage = 80,
2443 e_JavascriptModifyPropertyTypeSpawnPageFromTemplate = 81,
2445 e_JavascriptModifyPropertyTypeAddWeblinks = 82,
2447 e_JavascriptModifyPropertyTypeRemoveWeblinks = 83,
2449 e_JavascriptModifyPropertyTypeRemoveLinks = 84,
2451 e_JavascriptModifyPropertyTypePageRotations = 85,
2453 e_JavascriptModifyPropertyTypeNewPage = 86,
2455 e_JavascriptModifyPropertyTypeMovePage = 87,
2457 e_JavascriptModifyPropertyTypeInsertPages = 88,
2459 e_JavascriptModifyPropertyTypeReplacePages = 89,
2461 e_JavascriptModifyPropertyTypeImportAnnotFromXFDF = 90,
2463 e_JavascriptModifyPropertyTypeDeleteAnnot = 91,
2465 e_JavascriptModifyPropertyTypeAddWatermark = 92,
2467 e_JavascriptModifyPropertyTypeFlatDocument = 93,
2469 e_JavascriptModifyPropertyTypeAddFileAttachment = 94,
2471 e_JavascriptModifyPropertyTypeRuntimeHighlight = 95,
2473 e_JavascriptModifyPropertyTypeRuntimeHighlightColor = 96,
2475 e_JavascriptModifyPropertyTypeInsertFromTemplates = 97,
2477 e_JavascriptModifyPropertyTypeAddLink = 98,
2479 e_JavascriptModifyPropertyTypeMultipleSelection = 99,
2481 e_JavascriptModifyPropertyTypeSetPageTemplateVisible = 100
2482 } JavascriptModifyPropertyType;
2483
2489 typedef enum _JavascriptModifyType {
2491 e_JavascriptModifyTypeNone = 0,
2493 e_JavascriptModifyTypeAdd = 1,
2495 e_JavascriptModifyTypeModify = 2,
2497 e_JavascriptModifyTypeDelete = 3
2498 } JavascriptModifyType;
2499
2500
2502 JavascriptModifyItemInfo()
2503 : event_type(JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown)
2504 , page_index(-1)
2505 , field_control_index(-1)
2506 , modify_item_type(JavascriptModifyItemInfo::e_JavascriptModifyItemTypeNone)
2507 , modify_type(JavascriptModifyItemInfo::e_JavascriptModifyTypeNone)
2508 , modify_property_type(JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeNone)
2509 , field_or_annot_name(L"")
2510 , new_value(L"")
2511 , old_value(L"") {}
2512
2526 JavascriptModifyItemInfo(JavascriptEventType event_type,
2527 int page_index, int field_control_index, JavascriptModifyItemType modify_item_type,
2528 JavascriptModifyType modify_type, JavascriptModifyPropertyType modify_property_type,
2529 WString field_or_annot_name, WString new_value, WString old_value)
2530 : event_type(JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown)
2531 , page_index(page_index)
2532 , field_control_index(field_control_index)
2533 , modify_item_type(modify_item_type)
2534 , modify_type(modify_type)
2535 , modify_property_type(modify_property_type)
2536 , field_or_annot_name(field_or_annot_name)
2537 , new_value(new_value)
2538 , old_value(old_value) { }
2539
2545 JavascriptModifyItemInfo (const JavascriptModifyItemInfo& other)
2546 : event_type(other.event_type)
2547 , page_index(other.page_index)
2548 , field_control_index(other.field_control_index)
2549 , modify_item_type(other.modify_item_type)
2550 , modify_type(other.modify_type)
2551 , modify_property_type(other.modify_property_type)
2552 , field_or_annot_name(other.field_or_annot_name)
2553 , new_value(other.new_value)
2554 , old_value(other.old_value) {
2555 }
2556
2564 JavascriptModifyItemInfo& operator = (const JavascriptModifyItemInfo& other) {
2565 if (this != &other) {
2566 event_type = other.event_type;
2567 page_index = other.page_index;
2568 field_control_index = other.field_control_index;
2569 modify_item_type = other.modify_item_type;
2570 modify_type = other.modify_type;
2571 modify_property_type = other.modify_property_type;
2572 field_or_annot_name = other.field_or_annot_name;
2573 new_value = other.new_value;
2574 old_value = other.old_value;
2575 }
2576 return *this;
2577 }
2578
2583 JavascriptEventType event_type;
2584
2586 int page_index;
2587
2589 int field_control_index;
2590
2595 JavascriptModifyItemType modify_item_type;
2596
2601 JavascriptModifyType modify_type;
2602
2607 JavascriptModifyPropertyType modify_property_type;
2608
2610 WString field_or_annot_name;
2611
2613 WString new_value;
2614
2616 WString old_value;
2617 };
2618
2624 class ActionCallback {
2625 public:
2631 typedef enum _Language {
2633 e_LanguageUnknown = 0,
2635 e_LanguageCHS = 1,
2637 e_LanguageCHT = 2,
2639 e_LanguageDAN = 3,
2641 e_LanguageDEU = 4,
2643 e_LanguageENU = 5,
2645 e_LanguageESP = 6,
2647 e_LanguageFRA = 7,
2649 e_LanguageITA = 8,
2651 e_LanguageKOR = 9,
2653 e_LanguageJPN = 10,
2655 e_LanguageNLD = 11,
2657 e_LanguageNOR = 12,
2659 e_LanguagePTB = 13,
2661 e_LanguageSUO = 14,
2663 e_LanguageSVE = 15
2664 } Language;
2665
2671 typedef enum _AppInfoType {
2673 e_AppInfoTypeFormsVersion = 0x0,
2675 e_AppInfoTypeViewerType = 0x01,
2677 e_AppInfoTypeViewerVariation = 0x02,
2679 e_AppInfoTypeViewerVersion = 0x03,
2681 e_AppInfoTypeAppVersion = 0x04
2682 } AppInfoType;
2683
2689 typedef enum _MailType {
2691 e_MailTypeDoc = 0,
2693 e_MailTypeForm = 1,
2695 e_MailTypeMsg = 2
2696 } MailType;
2697
2703 typedef enum _JSFieldValueChangeType {
2705 e_JSFieldValueChangedByFormat = 0,
2707 e_JSFieldValueChangedByCalculation = 1,
2709 e_JSFieldValueChangedBySetValue = 2,
2711 e_JSFieldValueChangedBySetReadOnly = 3,
2713 e_JSFieldValueChangedByFillColor = 4
2714 } JSFieldValueChangeType;
2715
2721 typedef enum _JSMediaPlayerState {
2723 e_JSMediaPlayerStateOpen = 0,
2725 e_JSMediaPlayerStateClose = 1,
2727 e_JSMediaPlayerStatePlaying = 2,
2729 e_JSMediaPlayerStateStop = 3,
2731 e_JSMediaPlayerStateSuspend = 4
2732 } JSMediaPlayerState;
2733
2739 typedef enum _LayoutMode {
2741 e_LayoutModeSinglePage = 0,
2743 e_LayoutModeContinuous = 1,
2745 e_LayoutModeFacing = 2,
2747 e_LayoutModeContinuousFacing = 3
2748 } LayoutMode;
2749
2755 typedef enum _JsMailResult {
2757 e_JSMailResultFailed = 0,
2759 e_JSMailResultSuccess = 1,
2761 e_JSMailResultUserAbort = 2
2762 } JsMailResult;
2763
2769 typedef enum _SearchScope {
2771 e_SearchScopeActiveDoc = 0,
2773 e_SearchScopeFolder = 1,
2775 e_SearchScopeIndex = 2,
2777 e_SearchScopeActiveIndexes = 3
2778 } SearchScope;
2779
2785 typedef enum _ModifyItemType {
2787 e_ModifyItemTypeNone = 0,
2789 e_ModifyItemTypeField = 1,
2791 e_ModifyItemTypeAnnot = 2,
2793 e_ModifyItemTypePage = 3,
2795 e_ModifyItemTypeDoc = 4
2796 } ModifyItemType;
2797
2798
2804 virtual void Release() = 0;
2805
2819 virtual bool InvalidateRect(const pdf::PDFDoc& document, int page_index, const RectF& pdf_rect) = 0;
2820
2831 virtual int GetCurrentPage(const pdf::PDFDoc& document) = 0;
2832
2844 virtual void SetCurrentPage(const pdf::PDFDoc& document, int page_index) = 0;
2845
2856 virtual void SetCurrentPage(const pdf::PDFDoc& document, const foxit::pdf::Destination& destination) = 0;
2857
2871 virtual common::Rotation GetPageRotation(const pdf::PDFDoc& document, int page_index) = 0;
2872
2886 virtual bool SetPageRotation(const pdf::PDFDoc& document, int page_index, common::Rotation rotation) = 0;
2887
2900 virtual bool ExecuteNamedAction(const pdf::PDFDoc& document, const char* named_action) = 0;
2901
2914 virtual bool SetDocChangeMark(const pdf::PDFDoc& document, bool change_mark) = 0;
2915
2927 virtual bool GetDocChangeMark(const pdf::PDFDoc& document) = 0;
2928
2937 virtual int GetOpenedDocCount() = 0;
2938
2950 virtual pdf::PDFDoc GetOpenedDoc(int index) = 0;
2951
2960 virtual pdf::PDFDoc GetCurrentDoc() = 0;
2961
2970 virtual pdf::PDFDoc CreateBlankDoc() = 0;
2971
2983 virtual void CloseDoc(const pdf::PDFDoc& document, bool is_prompt_to_save) = 0;
2984
2996 virtual pdf::PDFDoc OpenDoc(const WString& file_path, const WString& password) = 0;
2997
3015 virtual bool Beep(int type) = 0;
3016
3035 virtual WString Response(const wchar_t* question, const wchar_t* title, const wchar_t* default_value,
3036 const wchar_t* label, bool is_password) = 0;
3037
3048 virtual WString GetFilePath(const pdf::PDFDoc& document) = 0;
3049
3060 virtual bool IsLocalFile(const pdf::PDFDoc& document) = 0;
3061
3074 virtual WString GetAttachmentsFilePath(const pdf::PDFDoc& pdf_doc, const wchar_t* name) = 0;
3075
3088 virtual WString GetExtractedEmbeddedFilePath(const pdf::PDFDoc& pdf_doc, const wchar_t* name) = 0;
3089
3113 virtual bool Print(const pdf::PDFDoc& document, bool is_ui,
3114 const common::Range& page_range, bool is_silent ,
3115 bool is_shrunk_to_fit, bool is_printed_as_image,
3116 bool is_reversed, bool is_to_print_annots) = 0;
3117
3129 virtual bool Print(const pdf::PDFDoc& document, const PrintParams& print_params) = 0;
3130
3146 virtual bool SubmitForm(const pdf::PDFDoc& document, void* form_data, uint32 length, const char* url, common::FileFormatType file_format_type) = 0;
3147
3158 virtual bool LaunchURL(const char* url) = 0;
3159
3168 virtual WString BrowseFile() = 0;
3169
3184 virtual WString BrowseFile(bool is_open_dialog, const wchar_t* file_format, const wchar_t* file_filter) = 0;
3185
3195 virtual Language GetLanguage() = 0;
3196
3228 virtual int Alert(const wchar_t* msg, const wchar_t* title, int type, int icon) = 0;
3229
3238 virtual IdentityProperties GetIdentityProperties() = 0;
3239
3249 virtual bool SetIdentityProperties(const IdentityProperties& identity_properties) = 0;
3250
3264 virtual WString PopupMenu(const MenuListArray& menus, bool& is_selected_item) = 0;
3265
3278 virtual MenuItemEx PopupMenuEx(const MenuItemExArray& menus, bool& is_selected_item) = 0;
3279
3294 virtual WString GetAppInfo(AppInfoType type) = 0;
3295
3328 virtual bool MailData(void* data, MailType data_type, bool is_ui, const wchar_t* to,
3329 const wchar_t* subject, const wchar_t* cc, const wchar_t* bcc, const wchar_t* message) = 0;
3330
3345 virtual uint32 VerifySignature(const pdf::PDFDoc& document, const pdf::Signature& pdf_signature) = 0;
3346
3357 virtual WString GetUntitledBookmarkName() = 0;
3358
3368 virtual WStringArray GetPrinterNameList() = 0;
3369
3379 virtual bool AddToolButton(const ButtonItem& button_item) = 0;
3380
3390 virtual bool RemoveToolButtom(const wchar_t* button_name) = 0;
3391
3399 virtual MenuListArray GetMenuItemNameList() = 0;
3400
3421 virtual bool AddMenuItem(const MenuItemConfig& menu_item_config, bool is_prepend) = 0;
3422
3432 virtual bool AddSubMenu(const MenuItemConfig& menu_item_config) = 0;
3433
3443 virtual bool ShowDialog(const DialogDescriptionConfig& dlg_config) = 0;
3444
3452 virtual bool GetFullScreen() = 0;
3453
3463 virtual void SetFullScreen(bool is_full_screen) = 0;
3464
3480 virtual void OnFieldValueChanged(const wchar_t* field_name, JSFieldValueChangeType type, const WStringArray &value_before_changed, const WStringArray &value_after_changed) = 0;
3481
3491 virtual void UpdateLogicalLabel() = 0;
3492
3511 virtual JsMailResult MailDoc(const pdf::PDFDoc& document,
3512 const wchar_t* to_address, const wchar_t* cc_address, const wchar_t* bcc_address,
3513 const wchar_t* subject, const wchar_t* message, bool is_ui) = 0;
3514
3527 virtual WString GetTemporaryFileName(const pdf::PDFDoc& document, const wchar_t* file_suffix_name) = 0;
3528
3538 virtual MediaPlayerCallback* OpenMediaPlayer(const PlayerArgs& player_args) = 0;
3539
3549 virtual WString GetTemporaryDirectory() = 0;
3550
3562 virtual void Scroll(const PointF& point) = 0;
3563
3578 virtual void SelectPageNthWord(int page_index, int start_offset, int end_offset, bool is_show_selection) = 0;
3579
3589 virtual PointF GetMousePosition() = 0;
3590
3604 virtual RectF GetPageWindowRect(const foxit::pdf::PDFDoc& document, int page_index) = 0;
3605
3616 virtual LayoutMode GetLayoutMode() = 0;
3617
3631 virtual void SetLayoutMode(LayoutMode layout_mode, bool is_cover_mode) = 0;
3632
3642 virtual float GetPageScale() = 0;
3643
3657 virtual void SetPageScale(foxit::pdf::Destination::ZoomMode zoom_mode, const foxit::pdf::Destination& dest) = 0;
3658
3669 virtual foxit::pdf::Destination::ZoomMode GetPageZoomMode() = 0;
3670
3687 virtual void Query(const wchar_t* keywords, SearchScope search_scope, const SearchOption& search_option, const wchar_t* di_path) = 0;
3688
3700 virtual SearchIndexConfig AddSearchIndex(const wchar_t* di_path, bool is_selected) = 0;
3701
3712 virtual bool RemoveSearchIndex(const SearchIndexConfig& search_index_config) = 0;
3713
3722 virtual WStringArray GetSignatureAPStyleNameList() = 0;
3723
3736 virtual SOAPResponseInfo SoapRequest(const SOAPRequestProperties& request_params) = 0;
3737
3749 virtual void EnablePageLoop(bool is_loop) = 0;
3750
3760 virtual bool IsPageLoop() = 0;
3761
3781 virtual void SetDefaultPageTransitionMode(const wchar_t* trans_type, const wchar_t* trans_di) = 0;
3782
3791 virtual bool IsCurrentDocOpenedInBrowser() = 0;
3792
3805 virtual void PostMessageToHtml(WStringArray message) = 0;
3806
3818 virtual void NotifyBeginDoJob(const pdf::PDFDoc& document, JavascriptModifyItemInfo::JavascriptEventType event_type) = 0;
3819
3830 virtual void NotifyAfterDataChange(const pdf::PDFDoc& document, JavascriptModifyItemInfo modify_item_info) = 0;
3831
3843 virtual void NotifyEndDoJob(const pdf::PDFDoc& document, JavascriptModifyItemInfo::JavascriptEventType event_type) = 0;
3844
3858 virtual bool InitModifyItem(const pdf::PDFDoc& document, ModifyItemType item_type, int page_index, const WString& dict_name) = 0;
3859
3869 virtual void ResetModifyItem(const pdf::PDFDoc& document) = 0;
3870
3881 virtual int GetVisiblePageCount(const pdf::PDFDoc& document) = 0;
3882
3895 virtual int GetVisiblePage(const pdf::PDFDoc& document, int index) = 0;
3896
3897 protected:
3898 virtual ~ActionCallback() {}
3899 };
3900 } // namespace foxit
3901
3902 #endif // FS_ACTIONCALLBACK_H_
3903
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeCallout
Javascript event item type: callout.
Definition: fs_actioncallback.h:2383
foxit::SearchOption::is_search_in_attachments
bool is_search_in_attachments
Specifies whether any PDF file attachments should be searched along with the base document....
Definition: fs_actioncallback.h:1949
foxit::PlayerArgs::audio_format
WString audio_format
The audio format, such as "audio/wav".
Definition: fs_actioncallback.h:1800
foxit::ActionCallback::GetPageZoomMode
virtual foxit::pdf::Destination::ZoomMode GetPageZoomMode()=0
A callback function to get the current page zoom mode.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRichText
Javascript event item type: rich text.
Definition: fs_actioncallback.h:2341
foxit::ActionCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAddPageTemplate
Javascript event item type: add page template.
Definition: fs_actioncallback.h:2433
foxit::SearchIndexConfig::operator=
SearchIndexConfig & operator=(const SearchIndexConfig &search_index_config)
Assign operator.
Definition: fs_actioncallback.h:2018
foxit::JavascriptModifyItemInfo
Definition: fs_actioncallback.h:2154
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRemoveLinks
Javascript event item type: remove links.
Definition: fs_actioncallback.h:2449
foxit::ActionCallback::LayoutMode
LayoutMode
Enumeration for layout mode.
Definition: fs_actioncallback.h:2739
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeDocDidSave
Javascript event: Document did save.
Definition: fs_actioncallback.h:2177
foxit::PrintParams::e_PrintHandlingFitPaper
Print Handling: Pages are enlarged or shrunk to fit the printe's paper.
Definition: fs_actioncallback.h:1131
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDefaultValue
Javascript event item type: default value.
Definition: fs_actioncallback.h:2315
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDefaultIsChecked
Javascript event item type: default is checked.
Definition: fs_actioncallback.h:2363
foxit::DialogDescriptionElement::type
String type
The type of this dialog box element.
Definition: fs_actioncallback.h:613
foxit::MediaSettings::MediaSettings
MediaSettings()
Constructor.
Definition: fs_actioncallback.h:1530
foxit::PrintParams::PrintParams
PrintParams(const PrintParams &print_params)
Constructor, with another print parameters object.
Definition: fs_actioncallback.h:1178
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonScaleHow
Javascript event item type: button scale how.
Definition: fs_actioncallback.h:2307
foxit::IdentityProperties::last_name
WString last_name
The user last name.
Definition: fs_actioncallback.h:291
foxit::ButtonItem::enable
WString enable
An expression string that determines whether to enable the toolbutton.
Definition: fs_actioncallback.h:375
foxit::PrintParams::num_copies
int num_copies
The number of copies to be printed.
Definition: fs_actioncallback.h:1276
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDeleteAnnot
Javascript event item type: delete annot.
Definition: fs_actioncallback.h:2463
foxit::ActionCallback::ModifyItemType
ModifyItemType
Enumeration for modify item type.
Definition: fs_actioncallback.h:2785
foxit::ActionCallback::MailType
MailType
Enumeration for data type to be mailed.
Definition: fs_actioncallback.h:2689
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldBlur
Javascript event: Form field blur.
Definition: fs_actioncallback.h:2199
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenMouseUp
Javascript event: Screen mouse up.
Definition: fs_actioncallback.h:2219
foxit::JavascriptModifyItemInfo::e_JavascriptModifyTypeDelete
Javascript modify type: Delete.
Definition: fs_actioncallback.h:2497
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenClose
Javascript event: Screen close.
Definition: fs_actioncallback.h:2215
foxit::pdf::annots::Screen
Definition: fs_annot.h:4372
foxit::MediaPlayerCallback::e_JSMediaPlayerStateStop
media player state: Stop.
Definition: fs_actioncallback.h:2080
foxit::ActionCallback::Alert
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.
foxit::ActionCallback::Beep
virtual bool Beep(int type)=0
A callback function to cause the system to play a sound.
foxit::ActionCallback::e_MailTypeMsg
Mailed data type: string message.
Definition: fs_actioncallback.h:2695
foxit::ActionCallback::e_LanguageFRA
French.
Definition: fs_actioncallback.h:2647
foxit::SOAPResponseInfo::SOAPResponseInfo
SOAPResponseInfo()
Constructor.
Definition: fs_actioncallback.h:983
foxit::JavascriptModifyItemInfo::page_index
int page_index
The page index.
Definition: fs_actioncallback.h:2586
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeBorderStyle
Javascript event item type: border style.
Definition: fs_actioncallback.h:2299
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaBlur
Javascript event: Media blur.
Definition: fs_actioncallback.h:2241
foxit::ActionCallback::JSFieldValueChangeType
JSFieldValueChangeType
Enumeration for javascript field value change type.
Definition: fs_actioncallback.h:2703
foxit::ActionCallback::GetOpenedDocCount
virtual int GetOpenedDocCount()=0
A callback function to receive the count of opened documents.
foxit::common::Range
Definition: fs_common.h:1368
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypePageOpen
Javascript event: Page open.
Definition: fs_actioncallback.h:2181
foxit::PrintParams::e_PrintContentDocAndAnnots
Print Content: print the document contents and comments.
Definition: fs_actioncallback.h:1050
foxit::PrintParams::tile_overlap
float tile_overlap
The number of points that tiled pages have in common.
Definition: fs_actioncallback.h:1287
foxit::PrintParams::PrintContent
PrintContent
Enumeration for the values used to set the contents of the print job.
Definition: fs_actioncallback.h:1046
foxit::PrintParams::page_order
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:1311
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeQuads
Javascript event item type: quadspoints.
Definition: fs_actioncallback.h:2411
foxit::common::Bitmap
Definition: fs_image.h:36
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeLeaderLength
Javascript event item type: leader length.
Definition: fs_actioncallback.h:2399
foxit::FloatingInfo::WindowPosition
WindowPosition
Enumeration for the window position used for media player.
Definition: fs_actioncallback.h:1322
foxit::ActionCallback::NotifyEndDoJob
virtual void NotifyEndDoJob(const pdf::PDFDoc &document, JavascriptModifyItemInfo::JavascriptEventType event_type)=0
A callback function to notify that javascript execution has ended.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeEditable
Javascript event item type: editable.
Definition: fs_actioncallback.h:2323
foxit::PrintParams::is_print_auto_center
bool is_print_auto_center
true means that each page is automatically centered relative to the paper.
Definition: fs_actioncallback.h:1250
foxit::MediaPlayerCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeImport
Javascript event item type: import.
Definition: fs_actioncallback.h:2425
foxit::ActionCallback::PopupMenu
virtual WString PopupMenu(const MenuListArray &menus, bool &is_selected_item)=0
A callback function to pop up a menu window.
foxit::ActionCallback::SubmitForm
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.
foxit::DialogDescriptionConfig::width
int width
The width of the dialog box in pixels.
Definition: fs_actioncallback.h:768
foxit::JavascriptModifyItemInfo::modify_property_type
JavascriptModifyPropertyType modify_property_type
The modify property type. Please refer to values starting from JavascriptModifyItemInfo::e_Javascript...
Definition: fs_actioncallback.h:2607
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDisplay
Javascript event item type: display.
Definition: fs_actioncallback.h:2321
foxit::FloatingInfo::e_ResizeTypeYes
Resize type: may be resized without preserving the aspect ratio.
Definition: fs_actioncallback.h:1370
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeDocOpen
Javascript event: Document open.
Definition: fs_actioncallback.h:2169
foxit::DialogDescriptionElement::name
String name
The displayed name of the dialog box element.
Definition: fs_actioncallback.h:609
foxit::ButtonItem::bitmap
common::Bitmap bitmap
A bitmap object of button.
Definition: fs_actioncallback.h:383
foxit::ActionCallback::Scroll
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 ...
foxit::PlayerArgs::player_settings
MediaSettings player_settings
A MediaSettings object.
Definition: fs_actioncallback.h:1803
foxit::ActionCallback::GetMousePosition
virtual PointF GetMousePosition()=0
A callback function to get current mouse position.
foxit::FloatingInfo::RelativeTarget
RelativeTarget
Enumeration for the values used to set relative position of floating window.
Definition: fs_actioncallback.h:1348
foxit::Object
CFX_Object Object
Object type.
Definition: fs_basictypes.h:220
foxit::ButtonItem::Set
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
foxit::FloatingInfo::e_WindowPositionBottomCenter
Window position: at the bottom center.
Definition: fs_actioncallback.h:1338
foxit::ActionCallback::GetFilePath
virtual WString GetFilePath(const pdf::PDFDoc &document)=0
A callback function to get the file path of current PDF document.
foxit::SOAPResponseInfo::response_body
WString response_body
Body of the SOAP response.
Definition: fs_actioncallback.h:1031
foxit::JavascriptModifyItemInfo::e_JavascriptModifyItemTypeDoc
Javascript modify item type: Doc.
Definition: fs_actioncallback.h:2271
foxit::SOAPRequestProperties::is_wiredump
bool is_wiredump
Whether to output debug information for SOAP requests and responses, defaults to true.
Definition: fs_actioncallback.h:969
foxit::ActionCallback::RemoveSearchIndex
virtual bool RemoveSearchIndex(const SearchIndexConfig &search_index_config)=0
(Reserved, unsupported yet) A callback function to remove a search index.
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeHtmlCallback
Javascript event: Html callback.
Definition: fs_actioncallback.h:2167
foxit::MediaPlayerCallback::e_JSMediaPlayerStateOpen
media player state: Open.
Definition: fs_actioncallback.h:2074
foxit::PrintParams::binding
BookletBinding binding
The value determines the paper binding direction and the page arrange order. Please refer to values s...
Definition: fs_actioncallback.h:1297
foxit::DialogDescriptionElement::font
String font
The font to use for this element.
Definition: fs_actioncallback.h:651
foxit::ActionCallback::GetLanguage
virtual Language GetLanguage()=0
A callback function to get the language of the running viewer application.
foxit::FloatingInfo::e_WindowPositionTopCenter
Window position: at the top center.
Definition: fs_actioncallback.h:1326
foxit::SOAPAuthenticateInfo::Set
void Set(const wchar_t *username, const wchar_t *password, bool is_use_platform_auth)
Set values.
Definition: fs_actioncallback.h:835
foxit::ActionCallback::e_SearchScopeActiveIndexes
Search scope: active indexes.
Definition: fs_actioncallback.h:2777
foxit::FloatingInfo::relative_target
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:1484
foxit::FloatingInfo::e_WindowPositionBottomLeft
Window position: at the bottom left corner.
Definition: fs_actioncallback.h:1336
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenOutview
Javascript event: Screen out view.
Definition: fs_actioncallback.h:2227
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaPlay
Javascript event: Media play.
Definition: fs_actioncallback.h:2247
foxit::ActionCallback::e_LanguageUnknown
Unknown language.
Definition: fs_actioncallback.h:2633
foxit::ActionCallback::GetCurrentDoc
virtual pdf::PDFDoc GetCurrentDoc()=0
A callback function to receive current PDF document object.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeComb
Javascript event item type: Comb.
Definition: fs_actioncallback.h:2311
foxit::ActionCallback::e_ModifyItemTypeAnnot
Modify item type: Annot.
Definition: fs_actioncallback.h:2791
foxit::ActionCallback::AddSearchIndex
virtual SearchIndexConfig AddSearchIndex(const wchar_t *di_path, bool is_selected)=0
A callback function to add a search index.
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
foxit::MediaSettings::base_url
WString base_url
The base URL to be used to resolve any relative URLs used in the media clip.
Definition: fs_actioncallback.h:1654
foxit::ActionCallback::e_LayoutModeFacing
Layout mode: two pages.
Definition: fs_actioncallback.h:2745
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAttachIcon
Javascript event item type: attach icon.
Definition: fs_actioncallback.h:2377
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRemoveTemplate
Javascript event item type: remove template.
Definition: fs_actioncallback.h:2431
foxit::IdentityProperties
Definition: fs_actioncallback.h:211
foxit::IdentityProperties::department
WString department
The department name.
Definition: fs_actioncallback.h:295
foxit::SearchOption::is_ignore_accents
bool is_ignore_accents
Specifies whether accents and diacriticals are ignored while searching the query term....
Definition: fs_actioncallback.h:1951
foxit::DialogDescriptionConfig::align_children
String align_children
The alignment for all descendants.
Definition: fs_actioncallback.h:792
foxit::PrintParams::e_BookletBindingRight
Booklet Binding: Left-side binding for Western-style left-to-right reading direction....
Definition: fs_actioncallback.h:1090
foxit::MediaSettings::duration
int duration
The amount of time in seconds that playback will take.
Definition: fs_actioncallback.h:1663
foxit::PrintParams::e_BookletBindingLeft
Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style v...
Definition: fs_actioncallback.h:1095
foxit::pdf::Rendition
Definition: fs_rendition.h:38
foxit::WStringArray
Definition: fs_basictypes.h:227
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeArrowBegin
Javascript event item type: arrow begin.
Definition: fs_actioncallback.h:2373
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeTextFont
Javascript event item type: text font.
Definition: fs_actioncallback.h:2353
foxit::FloatingInfo::e_OffScreenAllow
Off screen action: take no action.
Definition: fs_actioncallback.h:1380
foxit::FloatingInfo::e_ResizeTypeNo
Resize type: may not be resized.
Definition: fs_actioncallback.h:1366
foxit::MediaSettings::operator=
MediaSettings & operator=(const MediaSettings &media_settings)
Assign operator.
Definition: fs_actioncallback.h:1590
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypePageRotations
Javascript event item type: page rotations.
Definition: fs_actioncallback.h:2451
foxit::SOAPResponseInfo
Definition: fs_actioncallback.h:980
foxit::SearchOption::max_docs
int max_docs
The maximum number of documents that will be returned as part of the search query....
Definition: fs_actioncallback.h:1969
foxit::FloatingInfo::operator=
FloatingInfo & operator=(const FloatingInfo &floating_info)
Assign operator.
Definition: fs_actioncallback.h:1436
foxit::IdentityProperties::IdentityProperties
IdentityProperties()
Constructor.
Definition: fs_actioncallback.h:214
foxit::ActionCallback::GetSignatureAPStyleNameList
virtual WStringArray GetSignatureAPStyleNameList()=0
A callback function to get the name list of signature appearance style.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeNone
Javascript pre-sign item type: none.
Definition: fs_actioncallback.h:2281
foxit::MediaSettings::PlayerWindowType
PlayerWindowType
Enumeration for the type of window that the media should play in.
Definition: fs_actioncallback.h:1519
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldMouseEnter
Javascript event: Form field mouse enter.
Definition: fs_actioncallback.h:2193
foxit::RGB
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
foxit::ActionCallback::e_AppInfoTypeAppVersion
Application's app version information.
Definition: fs_actioncallback.h:2681
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeDocWillPrint
Javascript event: Document will print.
Definition: fs_actioncallback.h:2171
foxit::ActionCallback::e_LanguagePTB
Brazilian Portuguese.
Definition: fs_actioncallback.h:2659
foxit::ActionCallback::e_MailTypeDoc
Mailed data type: document.
Definition: fs_actioncallback.h:2691
foxit::ActionCallback::e_AppInfoTypeFormsVersion
Application's forms version information.
Definition: fs_actioncallback.h:2673
foxit::ActionCallback::SetCurrentPage
virtual void SetCurrentPage(const pdf::PDFDoc &document, int page_index)=0
A callback function used to set the current page by index.
foxit::FloatingInfo::e_WindowPositionTopLeft
Window position: at the top left corner.
Definition: fs_actioncallback.h:1324
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenMouseExit
Javascript event: Screen mouse exit.
Definition: fs_actioncallback.h:2223
foxit::ActionCallback::GetVisiblePage
virtual int GetVisiblePage(const pdf::PDFDoc &document, int index)=0
A callback function to get the visible page index.
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::ActionCallback::GetTemporaryFileName
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...
foxit::PlayerArgs::Set
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:1765
foxit::ActionCallback::e_JSMailResultFailed
Mailed result: mail failed.
Definition: fs_actioncallback.h:2757
foxit::FloatingInfo::e_RelativeTargetMonitor
Relative type: align the floating window relative to the (selected) monitor display screen.
Definition: fs_actioncallback.h:1356
foxit::MediaSettings::volume
int volume
Specify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume.
Definition: fs_actioncallback.h:1685
foxit::ActionCallback::SetPageRotation
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.
foxit::MediaSettings::auto_play
bool auto_play
Specify whether the media clip should begin playing automatically after the player is opened.
Definition: fs_actioncallback.h:1646
foxit::JavascriptModifyItemInfo::JavascriptModifyPropertyType
JavascriptModifyPropertyType
Enumeration for javascript pre-sign item type.
Definition: fs_actioncallback.h:2279
foxit::PlayerArgs::operator=
PlayerArgs & operator=(const PlayerArgs &player_args)
Assign operator.
Definition: fs_actioncallback.h:1743
foxit::PrintParams::e_BookletDuplexModeFrontSideOnly
Booklet Duplex Mode: only prints all pages that appear on the front side of the paper.
Definition: fs_actioncallback.h:1078
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeResizePage
Javascript event item type: resize page.
Definition: fs_actioncallback.h:2441
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDash
Javascript event item type: dash.
Definition: fs_actioncallback.h:2389
foxit::ActionCallback::e_LanguageDEU
German.
Definition: fs_actioncallback.h:2641
foxit::SearchOption::is_search_bookmarks
bool is_search_bookmarks
Specifies whether bookmarks are searched for the query. Defaule value: false.
Definition: fs_actioncallback.h:1945
foxit::PrintParams::e_PrintHandlingBooklet
Print Handling: Prints multiple pages on the same sheet of paper in the order required to read correc...
Definition: fs_actioncallback.h:1142
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeTextColor
Javascript event item type: text color.
Definition: fs_actioncallback.h:2287
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRuntimeHighlight
Javascript event item type: runtime highlight.
Definition: fs_actioncallback.h:2471
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenBlur
Javascript event: Screen blur.
Definition: fs_actioncallback.h:2211
foxit::PrintParams::print_content
PrintContent print_content
Specif content for printing. Please refer to values starting from PrintParams::e_PrintContentDocument...
Definition: fs_actioncallback.h:1270
foxit::SearchOption::operator=
SearchOption & operator=(const SearchOption &search_option)
Assign operator.
Definition: fs_actioncallback.h:1887
foxit::MediaPlayerCallback::GetState
virtual JSMediaPlayerState GetState()=0
A callback function to get the media player state.
foxit::ActionCallback::GetPageRotation
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.
foxit::IdentityProperties::title
WString title
The user title.
Definition: fs_actioncallback.h:293
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeFillColor
Javascript pre-sign item type: fill color.
Definition: fs_actioncallback.h:2285
foxit::ActionCallback::PopupMenuEx
virtual MenuItemEx PopupMenuEx(const MenuItemExArray &menus, bool &is_selected_item)=0
A callback function to pop up a menu window.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeActivated
Javascript event item type: activated.
Definition: fs_actioncallback.h:2371
foxit::ActionCallback::e_JSFieldValueChangedBySetValue
javascript field value changed type: field set value.
Definition: fs_actioncallback.h:2709
foxit::DialogDescriptionConfig::name
String name
The title bar of the dialog box.
Definition: fs_actioncallback.h:754
foxit::PrintParams::handling
PrintHandling handling
The print handling type.Please refer to values starting from PrintParams::e_PrintHandlingNone and thi...
Definition: fs_actioncallback.h:1293
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonAlignX
Javascript event item type: button align x.
Definition: fs_actioncallback.h:2301
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldKeyStroke
Javascript event: Form field key stroke.
Definition: fs_actioncallback.h:2201
foxit::SearchIndexConfig::is_available
bool is_available
Specifies whether the serch index is available for selection and searching. true means the index is a...
Definition: fs_actioncallback.h:2049
foxit::ActionCallback::Response
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 ...
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRemoveWeblinks
Javascript event item type: remove web links.
Definition: fs_actioncallback.h:2447
foxit::ActionCallback::e_LanguageNOR
Norwegian.
Definition: fs_actioncallback.h:2657
foxit::ActionCallback::e_JSFieldValueChangedByFillColor
javascript field value changed type: field fill color.
Definition: fs_actioncallback.h:2713
foxit::FloatingInfo::has_close
bool has_close
true means the floating window should have a close window control button, while false means not.
Definition: fs_actioncallback.h:1493
foxit::ActionCallback::e_SearchScopeIndex
Search scope: index.
Definition: fs_actioncallback.h:2775
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::DialogDescriptionElement::next_tab
String next_tab
An ItemID for the next dialog box item in the tab order.
Definition: fs_actioncallback.h:615
foxit::ActionCallback::e_JSMediaPlayerStatePlaying
media player state: Playing.
Definition: fs_actioncallback.h:2727
foxit::PlayerArgs::screen_annot
pdf::annots::Screen screen_annot
A pdf::annots::Screen object.
Definition: fs_actioncallback.h:1787
foxit::SOAPResponseInfo::SOAPResponseInfo
SOAPResponseInfo(const wchar_t *response_header, const wchar_t *response_body, const wchar_t *network_error, uint32 status_code)
Constructor, with parameters.
Definition: fs_actioncallback.h:994
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDoCaption
Javascript event item type: do caption.
Definition: fs_actioncallback.h:2391
foxit::DialogDescriptionElement::element_array
DialogDescriptionElementArray element_array
An array of object literals that describe the subelements of this dialog box element.
Definition: fs_actioncallback.h:661
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDeleteItemAt
Javascript event item type: delete item at.
Definition: fs_actioncallback.h:2365
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRequired
Javascript event item type: required.
Definition: fs_actioncallback.h:2339
foxit::JavascriptModifyItemInfo::e_JavascriptModifyTypeAdd
Javascript modify type: add.
Definition: fs_actioncallback.h:2493
foxit::MediaPlayerCallback::Seek
virtual bool Seek(int current_pos)=0
A callback function to seek the media player.
foxit::common::FileFormatType
FileFormatType
Enumeration for file format type.
Definition: fs_common.h:264
foxit::MediaSettings::floating_wnd_info
FloatingInfo floating_wnd_info
A FloatingInfo containing properties (listed below) that define the location and style of a floating ...
Definition: fs_actioncallback.h:1694
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldFormat
Javascript event: Form field format.
Definition: fs_actioncallback.h:2207
foxit::ButtonItem::ButtonItem
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
foxit::SOAPRequestProperties
Definition: fs_actioncallback.h:857
foxit::SearchOption::is_search_in_markup
bool is_search_in_markup
Specifies whether markup (annotations) are searched for the query. Defaule value: false.
Definition: fs_actioncallback.h:1947
foxit::SearchOption
Definition: fs_actioncallback.h:1807
foxit::ButtonItem::ButtonItem
ButtonItem(const ButtonItem &button_item)
Constructor, with another button item object.
Definition: fs_actioncallback.h:332
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldMouseDown
Javascript event: Form field mouse down.
Definition: fs_actioncallback.h:2189
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRichContents
Javascript event item type: rich contents.
Definition: fs_actioncallback.h:2415
foxit::SOAPRequestProperties::Set
void Set(const wchar_t *request_url, const char *request_content, const wchar_t *soap_action, const wchar_t *soap_namespace, const wchar_t *soap_version, const wchar_t *content_type, bool is_encode, bool is_wiredump, const char *request_header, const SOAPAuthenticateInfo &authenticate)
Set values.
Definition: fs_actioncallback.h:931
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRsetAllForms
Javascript event item type: reset all forms.
Definition: fs_actioncallback.h:2437
foxit::ActionCallback::MailDoc
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.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeHighlight
Javascript event item type: highlight.
Definition: fs_actioncallback.h:2329
foxit::pdf::Destination
Definition: fs_action.h:65
foxit::PrintParams::is_tile_label
bool is_tile_label
Label each page of tiled output. Labeled pages indicate row and column, file name,...
Definition: fs_actioncallback.h:1283
foxit::JavascriptModifyItemInfo::e_JavascriptModifyItemTypeAnnot
Javascript modify item type: Annot.
Definition: fs_actioncallback.h:2267
foxit::ActionCallback::PostMessageToHtml
virtual void PostMessageToHtml(WStringArray message)=0
A callback function to send message asynchronously to the message handler for the host container of t...
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRuntimeHighlightColor
Javascript event item type: runtime highlight color.
Definition: fs_actioncallback.h:2473
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRotation
Javascript event item type: rotation.
Definition: fs_actioncallback.h:2345
foxit::SearchOption::word_matching
WordMatching word_matching
How individual words in the query will be matched to words in the document. This property is relevant...
Definition: fs_actioncallback.h:1975
foxit::ActionCallback::e_ModifyItemTypeDoc
Modify item type: Doc.
Definition: fs_actioncallback.h:2795
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRolloverCaption
Javascript event item type: rollover caption.
Definition: fs_actioncallback.h:2351
foxit::PrintParams::PageOrder
PageOrder
Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
Definition: fs_actioncallback.h:1113
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeNotSpellCheck
Javascript event item type: not spell check.
Definition: fs_actioncallback.h:2325
foxit::DialogDescriptionElement::width
int width
Specifies the width of the element in pixels.
Definition: fs_actioncallback.h:621
foxit::MediaPlayerCallback::Play
virtual bool Play()=0
A callback function to play the media player.
foxit::DialogDescriptionElement::italic
bool italic
Specify if the font is italic.
Definition: fs_actioncallback.h:655
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeCheckThisBox
Javascript event item type: check this box.
Definition: fs_actioncallback.h:2359
foxit::SOAPRequestProperties::content_type
WString content_type
Allows the HTTP content-type header to be specified. The default is to use the SOAP messaging HTTP co...
Definition: fs_actioncallback.h:962
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAddFileAttachment
Javascript event item type: add fileattachment.
Definition: fs_actioncallback.h:2469
foxit::MediaSettings::MediaSettings
MediaSettings(const MediaSettings &media_settings)
Constructor, with another media settings object.
Definition: fs_actioncallback.h:1569
foxit::JavascriptModifyItemInfo::JavascriptModifyType
JavascriptModifyType
Enumeration for javascript modify type.
Definition: fs_actioncallback.h:2489
foxit::ActionCallback::CreateBlankDoc
virtual pdf::PDFDoc CreateBlankDoc()=0
A callback function to create a blank PDF document object.
foxit::MediaSettings::e_PlayerWindowTypeFullScreen
Window type: a full-screen window that obscures all other windows.
Definition: fs_actioncallback.h:1525
foxit::SearchOption::WordMatching
WordMatching
Enumeration for word matching.
Definition: fs_actioncallback.h:1814
foxit::MediaSettings::Set
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:1624
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeCaretSymbol
Javascript event item type: caret symbol.
Definition: fs_actioncallback.h:2385
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeGestures
Javascript event item type: gestures.
Definition: fs_actioncallback.h:2393
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeNoteIcon
Javascript event item type: note icon.
Definition: fs_actioncallback.h:2403
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaClose
Javascript event: Media close.
Definition: fs_actioncallback.h:2243
foxit::PrintParams::DuplexType
DuplexType
Enumeration for the values used to set the printing duplex mode.
Definition: fs_actioncallback.h:1060
foxit::FloatingInfo::e_ResizeTypeKeepRatio
Resize type: may be resized only if the aspect ratio is preserved.
Definition: fs_actioncallback.h:1368
foxit::ActionCallback::e_LanguageCHS
Chinese Simplified.
Definition: fs_actioncallback.h:2635
foxit::MediaPlayerCallback::e_JSMediaPlayerStateClose
media player state: Close.
Definition: fs_actioncallback.h:2076
foxit::MediaPlayerCallback
Definition: fs_actioncallback.h:2065
foxit::ActionCallback::SetLayoutMode
virtual void SetLayoutMode(LayoutMode layout_mode, bool is_cover_mode)=0
A callback function to set the page layout of the current document.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeNormalCaption
Javascript event item type: normal caption.
Definition: fs_actioncallback.h:2347
foxit::SOAPAuthenticateInfo::SOAPAuthenticateInfo
SOAPAuthenticateInfo(const SOAPAuthenticateInfo &soap_authenticate)
Constructor, with another SOAP authenticate object.
Definition: fs_actioncallback.h:821
foxit::ActionCallback::e_LayoutModeContinuous
Layout mode: continuous page.
Definition: fs_actioncallback.h:2743
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeVertices
Javascript event item type: vertices.
Definition: fs_actioncallback.h:2423
foxit::FloatingInfo::e_WindowPositionCenterRight
Window position: at the center right.
Definition: fs_actioncallback.h:1334
foxit::JavascriptModifyItemInfo::e_JavascriptModifyItemTypeNone
Javascript modify item type: none.
Definition: fs_actioncallback.h:2263
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeValue
Javascript event item type: value.
Definition: fs_actioncallback.h:2289
foxit::ActionCallback::Language
Language
Enumeration for language.
Definition: fs_actioncallback.h:2631
foxit::DialogDescriptionElement::char_width
int char_width
Specifies the width of the element in characters.
Definition: fs_actioncallback.h:634
foxit::FloatingInfo
Definition: fs_actioncallback.h:1315
foxit::SOAPResponseInfo::Set
void Set(const wchar_t *response_header, const wchar_t *response_body, const wchar_t *network_error, uint32 status_code)
Set values.
Definition: fs_actioncallback.h:1021
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDefaultStyle
Javascript event item type: default style.
Definition: fs_actioncallback.h:2313
foxit::SOAPRequestProperties::authenticate
SOAPAuthenticateInfo authenticate
An object that specifies how to handle HTTP authentication or credentials to use for Web Service Secu...
Definition: fs_actioncallback.h:976
foxit::IdentityProperties::corporation
WString corporation
The corporation name.
Definition: fs_actioncallback.h:281
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRichDefaults
Javascript event item type: rich defaults.
Definition: fs_actioncallback.h:2417
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAddWatermark
Javascript event item type: add watermark.
Definition: fs_actioncallback.h:2465
foxit::PrintParams::BookletBinding
BookletBinding
Enumeration for the values used to determine the duplex printing mode when printing a booklet.
Definition: fs_actioncallback.h:1088
foxit::PrintParams::duplex_type
DuplexType duplex_type
Sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed....
Definition: fs_actioncallback.h:1281
foxit::ActionCallback::SetPageScale
virtual void SetPageScale(foxit::pdf::Destination::ZoomMode zoom_mode, const foxit::pdf::Destination &dest)=0
A callback function to set current page zoom value.
foxit::PrintParams::e_PageOrderHorizontalReversed
Page Order type: pages are placed from right to left, from top to bottom.
Definition: fs_actioncallback.h:1117
foxit::SearchOption::SearchOption
SearchOption(const SearchOption &search_option)
Constructor, with another search option object.
Definition: fs_actioncallback.h:1866
foxit::ActionCallback::UpdateLogicalLabel
virtual void UpdateLogicalLabel()=0
A callback function to update logical label.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDelay
Javascript event item type: delay.
Definition: fs_actioncallback.h:2319
foxit::DialogDescriptionElementArray
Definition: fs_actioncallback.h:481
foxit::PlayerArgs::PlayerArgs
PlayerArgs(const PlayerArgs &player_args)
Constructor, with another player args object.
Definition: fs_actioncallback.h:1728
foxit::ActionCallback::e_JSMediaPlayerStateSuspend
media player state: Suspend.
Definition: fs_actioncallback.h:2731
foxit::SOAPRequestProperties::request_content
String request_content
An object that specifies the remote procedure name and parameters or the XML message to send.
Definition: fs_actioncallback.h:949
foxit::SearchOption::is_whole_word
bool is_whole_word
Specifies whether search finds only occurrences of complete words that are specified in the query....
Definition: fs_actioncallback.h:1941
foxit::ActionCallback::AppInfoType
AppInfoType
Enumeration for application's information type.
Definition: fs_actioncallback.h:2671
foxit::SearchIndexConfig::is_selected
bool is_selected
Specifies whether the search index participates in the search. true means the index is searched as pa...
Definition: fs_actioncallback.h:2058
foxit::PrintParams::e_PrintHandlingMultiplePages
Print Handling: Pages are rescaled to print multiple pages on each printer page.
Definition: fs_actioncallback.h:1135
foxit::SOAPRequestProperties::SOAPRequestProperties
SOAPRequestProperties()
Constructor.
Definition: fs_actioncallback.h:860
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeImportDataObject
Javascript event item type: import data object.
Definition: fs_actioncallback.h:2429
foxit::SOAPRequestProperties::SOAPRequestProperties
SOAPRequestProperties(const wchar_t *request_url, const char *request_content, const wchar_t *soap_action, const wchar_t *soap_namespace, const wchar_t *soap_version, const wchar_t *content_type, bool is_encode, bool is_wiredump, const char *request_header, const SOAPAuthenticateInfo &authenticate)
Constructor, with parameters.
Definition: fs_actioncallback.h:879
foxit::ActionCallback::AddToolButton
virtual bool AddToolButton(const ButtonItem &button_item)=0
A callback function to add a tool button.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonSetIcon
Javascript event item type: set button icon.
Definition: fs_actioncallback.h:2357
foxit::FloatingInfo::resize_type
ResizeType resize_type
Specify whether the floating window may be resized by the user. Please refer to values starting from ...
Definition: fs_actioncallback.h:1490
foxit::SearchIndexConfig::SearchIndexConfig
SearchIndexConfig(WString name, bool is_available, WString path, bool is_selected)
Constructor, with parameters.
Definition: fs_actioncallback.h:1994
foxit::DialogDescriptionConfig::char_height
int char_height
The height of the dialog box in characters.
Definition: fs_actioncallback.h:789
foxit::SOAPAuthenticateInfo::username
WString username
A string containing the user name to use for authentication.
Definition: fs_actioncallback.h:842
foxit::PrintParams::tile_mark
bool tile_mark
true means to cut the page, and false means not.
Definition: fs_actioncallback.h:1285
foxit::PrintParams::PrintParams
PrintParams()
Constructor.
Definition: fs_actioncallback.h:1147
foxit::SearchOption::Set
void Set(bool is_whole_word, bool is_case_sensitive, bool is_search_bookmarks, bool is_search_in_marup, bool is_search_in_attachments, bool is_ignore_accents, bool is_proximity, bool is_stemming, bool is_ignore_full_width, int max_docs, WordMatching word_matching, bool is_search_doc_text)
Set values.
Definition: fs_actioncallback.h:1923
foxit::ActionCallback::e_JSMailResultUserAbort
Mailed result: user abort.
Definition: fs_actioncallback.h:2761
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeTitle
Javascript event item type: title.
Definition: fs_actioncallback.h:2439
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldCalculate
Javascript event: Form field calculate.
Definition: fs_actioncallback.h:2205
foxit::PrintParams::e_PrintHandlingNone
Print Handling: No page scaling is applied.
Definition: fs_actioncallback.h:1129
foxit::ActionCallback
Definition: fs_actioncallback.h:2624
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeLineWidth
Javascript event item type: line width.
Definition: fs_actioncallback.h:2331
foxit::ButtonItem::tooltip
WString tooltip
The text to display in the button help text when the mouse is over the toolbutton.
Definition: fs_actioncallback.h:379
foxit::SOAPResponseInfo::response_header
WString response_header
Header of the SOAP response.
Definition: fs_actioncallback.h:1029
foxit::ActionCallback::GetMenuItemNameList
virtual MenuListArray GetMenuItemNameList()=0
A callback function to get the menu item name list.
foxit::IdentityProperties::IdentityProperties
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
foxit::FloatingInfo::e_WindowPositionBottomRight
Window position: at the bottom right corner.
Definition: fs_actioncallback.h:1340
foxit::ActionCallback::JsMailResult
JsMailResult
Enumeration for result of the mail.
Definition: fs_actioncallback.h:2755
foxit::MediaSettings::window_type
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:1691
foxit::FloatingInfo::title
WString title
This title to be displayed if has_title is true.
Definition: fs_actioncallback.h:1499
foxit::MediaSettings::repeat
int repeat
The number of times the media playback should automatically repeat.
Definition: fs_actioncallback.h:1676
foxit::ActionCallback::OnFieldValueChanged
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.
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldValidate
Javascript event: Form field validate.
Definition: fs_actioncallback.h:2203
foxit::ActionCallback::e_JSMailResultSuccess
Mailed result: mail success.
Definition: fs_actioncallback.h:2759
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDoNotScroll
Javascript event item type: do not scroll.
Definition: fs_actioncallback.h:2317
foxit::SearchOption::SearchOption
SearchOption()
Constructor.
Definition: fs_actioncallback.h:1825
foxit::ActionCallback::e_JSFieldValueChangedByFormat
javascript field value changed type: format.
Definition: fs_actioncallback.h:2705
foxit::MediaSettings::e_PlayerWindowTypeDockedPage
Window type: a docked page window.
Definition: fs_actioncallback.h:1521
foxit::PlayerArgs::PlayerArgs
PlayerArgs()
Constructor.
Definition: fs_actioncallback.h:1702
foxit::FloatingInfo::e_WindowPositionCenterLeft
Window position: at the center left.
Definition: fs_actioncallback.h:1330
foxit::JavascriptModifyItemInfo::old_value
WString old_value
The old value.
Definition: fs_actioncallback.h:2616
foxit::PrintParams::e_PageOrderHorizontal
Page Order type: pages are placed from left to right, from top to bottom.
Definition: fs_actioncallback.h:1115
foxit::FloatingInfo::e_OffScreenForceOnScreen
Off screen action: move or resize the window so that it is on-screen.
Definition: fs_actioncallback.h:1382
foxit::MediaPlayerCallback::Close
virtual void Close()=0
A callback function to close the media player.
foxit::IdentityProperties::first_name
WString first_name
The user first name.
Definition: fs_actioncallback.h:289
foxit::MediaSettings
Definition: fs_actioncallback.h:1512
foxit::SearchOption::e_WordMatchingMatchAllWords
Word matching: match all words.
Definition: fs_actioncallback.h:1818
foxit::ActionCallback::OpenDoc
virtual pdf::PDFDoc OpenDoc(const WString &file_path, const WString &password)=0
A callback function to open a PDF file.
foxit::JavascriptModifyItemInfo::field_control_index
int field_control_index
The control index of form field.
Definition: fs_actioncallback.h:2589
foxit::SOAPResponseInfo::network_error
WString network_error
Network error information of the SOAP response.
Definition: fs_actioncallback.h:1033
foxit::ActionCallback::GetLayoutMode
virtual LayoutMode GetLayoutMode()=0
A callback function to get the page layout of the current document.
foxit::ActionCallback::ExecuteNamedAction
virtual bool ExecuteNamedAction(const pdf::PDFDoc &document, const char *named_action)=0
A callback function to execute a named action.
foxit::ActionCallback::GetTemporaryDirectory
virtual WString GetTemporaryDirectory()=0
A callback function to get temporary directory.
foxit::MediaSettings::MediaSettings
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:1548
foxit::PrintParams::e_PrintHandlingReducePaper
Print Handling: Small pages are printed small, and large pages are shrunk to fit on the printer's pap...
Definition: fs_actioncallback.h:1133
foxit::FloatingInfo::FloatingInfo
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:1403
foxit::PrintParams::e_BookletBindingLeftTall
Booklet Binding: Left-side binding for Western-style left-to-right reading direction....
Definition: fs_actioncallback.h:1100
foxit::ActionCallback::e_SearchScopeFolder
Search scope: folder.
Definition: fs_actioncallback.h:2773
foxit::DialogDescriptionElement::alignment
String alignment
The alignment for this element.
Definition: fs_actioncallback.h:657
foxit::IdentityProperties::name
WString name
The user name.
Definition: fs_actioncallback.h:287
foxit::ActionCallback::SetFullScreen
virtual void SetFullScreen(bool is_full_screen)=0
A callback function to set full screen mode.
foxit::FloatingInfo::FloatingInfo
FloatingInfo()
Constructor.
Definition: fs_actioncallback.h:1389
foxit::ActionCallback::AddSubMenu
virtual bool AddSubMenu(const MenuItemConfig &menu_item_config)=0
A callback function to add a menu item with a submenu to the application.
foxit::pdf::Destination::ZoomMode
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:72
foxit::SearchOption::is_stemming
bool is_stemming
Specifies whether the search query will take the stemming of words (for example, run,...
Definition: fs_actioncallback.h:1961
foxit::PrintParams::is_simulate_overprinting
bool is_simulate_overprinting
true means to do overprint preview when printing. false means not.
Definition: fs_actioncallback.h:1257
foxit::JavascriptModifyItemInfo::JavascriptModifyItemInfo
JavascriptModifyItemInfo(JavascriptEventType event_type, int page_index, int field_control_index, JavascriptModifyItemType modify_item_type, JavascriptModifyType modify_type, JavascriptModifyPropertyType modify_property_type, WString field_or_annot_name, WString new_value, WString old_value)
Constructor, with parameters.
Definition: fs_actioncallback.h:2526
foxit::ActionCallback::GetVisiblePageCount
virtual int GetVisiblePageCount(const pdf::PDFDoc &document)=0
A callback function to get the visible pages count.
foxit::JavascriptModifyItemInfo::modify_type
JavascriptModifyType modify_type
The modify type. Please refer to values starting from JavascriptModifyItemInfo::e_JavascriptModifyTyp...
Definition: fs_actioncallback.h:2601
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRichValue
Javascript event item type: rich value.
Definition: fs_actioncallback.h:2343
foxit::PrintParams::e_BookletDuplexModeBackSideOnly
Booklet Duplex Mode: only prints all pages that appear on the back side of the paper.
Definition: fs_actioncallback.h:1080
foxit::SearchOption::is_proximity
bool is_proximity
Specifies whether the search query will reflect the proximity of words in the results ranking when pe...
Definition: fs_actioncallback.h:1956
foxit::PlayerArgs
Definition: fs_actioncallback.h:1699
foxit::DialogDescriptionElement::height
int height
Specifies the height of the element in pixels.
Definition: fs_actioncallback.h:628
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypePageInView
Javascript event: Page inview.
Definition: fs_actioncallback.h:2185
foxit::DialogDescriptionConfig::operator=
DialogDescriptionConfig & operator=(const DialogDescriptionConfig &dlg_des_config)
Assign operator.
Definition: fs_actioncallback.h:715
foxit::SOAPRequestProperties::request_header
String request_header
An object that specifies a SOAP header to be included with the request. The default is to send a requ...
Definition: fs_actioncallback.h:974
foxit::ActionCallback::e_JSMediaPlayerStateStop
media player state: Stop.
Definition: fs_actioncallback.h:2729
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeDocDidprint
Javascript event: Document did print.
Definition: fs_actioncallback.h:2173
foxit::MediaSettings::bg_color
foxit::RGB bg_color
The background color for the media player window. Format: 0xRRGGBB.
Definition: fs_actioncallback.h:1657
foxit::JavascriptModifyItemInfo::JavascriptModifyItemInfo
JavascriptModifyItemInfo()
Constructor.
Definition: fs_actioncallback.h:2502
foxit::MediaSettings::is_visible
bool is_visible
A boolean value that specifies whether the player should be visible.
Definition: fs_actioncallback.h:1682
foxit::PrintParams::tile_scale
float tile_scale
The amount that tiled pages are scaled.
Definition: fs_actioncallback.h:1289
foxit::SearchIndexConfig::SearchIndexConfig
SearchIndexConfig(const SearchIndexConfig &search_index_config)
Constructor, with another search index config object.
Definition: fs_actioncallback.h:2005
foxit::PrintParams::e_PrintHandlingTileLargePages
Print Handling: Small or normal pages are printed in the original size and large pages are printed on...
Definition: fs_actioncallback.h:1140
foxit::ActionCallback::EnablePageLoop
virtual void EnablePageLoop(bool is_loop)=0
A callback function to set the flag specifies whether the document will loop around to the beginning ...
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeSpawnPageFromTemplate
Javascript event item type: spawn page from template.
Definition: fs_actioncallback.h:2443
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeFlatDocument
Javascript event item type: flat document.
Definition: fs_actioncallback.h:2467
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeExternalExec
Javascript event: External execute.
Definition: fs_actioncallback.h:2235
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeDocWillClose
Javascript event: Document will close.
Definition: fs_actioncallback.h:2179
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAlignment
Javascript event item type: alignment.
Definition: fs_actioncallback.h:2297
foxit::DialogDescriptionElement::item_id
String item_id
An ItemID for this dialog box.
Definition: fs_actioncallback.h:611
foxit::DialogDescriptionConfig::Set
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:741
foxit::SOAPRequestProperties::SOAPRequestProperties
SOAPRequestProperties(const SOAPRequestProperties &request_properties)
Constructor, with another SOAP request properties object.
Definition: fs_actioncallback.h:898
foxit::DialogDescriptionElement::char_height
int char_height
Specifies the height of the element in characters.
Definition: fs_actioncallback.h:640
foxit::PrintParams
Definition: fs_actioncallback.h:1039
foxit::MediaPlayerCallback::e_JSMediaPlayerStateSuspend
media player state: Suspend.
Definition: fs_actioncallback.h:2082
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypePassword
Javascript event item type: password.
Definition: fs_actioncallback.h:2335
foxit::SearchOption::e_WordMatchingMatchAnyWord
Word matching: match any word.
Definition: fs_actioncallback.h:1820
foxit::SOAPResponseInfo::SOAPResponseInfo
SOAPResponseInfo(const SOAPResponseInfo &soap_response)
Constructor, with another SOAP response object.
Definition: fs_actioncallback.h:1005
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypePageClose
Javascript event: Page close.
Definition: fs_actioncallback.h:2183
foxit::JavascriptModifyItemInfo::operator=
JavascriptModifyItemInfo & operator=(const JavascriptModifyItemInfo &other)
Assign operator.
Definition: fs_actioncallback.h:2564
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonScaleWhen
Javascript event item type: button scale when.
Definition: fs_actioncallback.h:2309
foxit::FloatingInfo::off_screen
OffScreenAction off_screen
Specify what action should be taken if the floating window is positioned totally or partially offscre...
Definition: fs_actioncallback.h:1505
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeOpacity
Javascript event item type: opacity.
Definition: fs_actioncallback.h:2407
foxit::DialogDescriptionElement::bold
bool bold
Specify if the font is bold.
Definition: fs_actioncallback.h:653
foxit::FloatingInfo::ResizeType
ResizeType
Enumeration for the resize type, which specifies whether a floating window may be resized by the user...
Definition: fs_actioncallback.h:1364
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonAlignY
Javascript event item type: button align Y.
Definition: fs_actioncallback.h:2303
foxit::PrintParams::is_reverse
bool is_reverse
true means that the printing order should be from parameter end to parameter start.
Definition: fs_actioncallback.h:1246
foxit::PrintParams::BookletDuplexMode
BookletDuplexMode
Enumeration for the values used to determine the duplex printing mode when printing a booklet.
Definition: fs_actioncallback.h:1074
foxit::ActionCallback::e_LanguageNLD
Dutch.
Definition: fs_actioncallback.h:2655
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeCharLimit
Javascript event item type: char limit.
Definition: fs_actioncallback.h:2291
foxit::ActionCallback::InvalidateRect
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.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeToggleNoView
Javascript event item type: toggle no view.
Definition: fs_actioncallback.h:2405
foxit::SOAPAuthenticateInfo
Definition: fs_actioncallback.h:799
foxit::DialogDescriptionConfig::DialogDescriptionConfig
DialogDescriptionConfig()
Constructor.
Definition: fs_actioncallback.h:668
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
foxit::ButtonItem
Definition: fs_actioncallback.h:299
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeMovePage
Javascript event item type: move page.
Definition: fs_actioncallback.h:2455
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenOpen
Javascript event: Screen open.
Definition: fs_actioncallback.h:2213
foxit::PrintParams::e_PrintContentFormFieldsOnly
Print Content: print the contents of form fields only. Useful for printing onto pre-preprinted forms.
Definition: fs_actioncallback.h:1052
foxit::SOAPAuthenticateInfo::SOAPAuthenticateInfo
SOAPAuthenticateInfo()
Constructor.
Definition: fs_actioncallback.h:802
foxit::ActionCallback::JSMediaPlayerState
JSMediaPlayerState
Enumeration for media player state.
Definition: fs_actioncallback.h:2721
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenFocus
Javascript event: Screen focus.
Definition: fs_actioncallback.h:2209
foxit::ActionCallback::NotifyAfterDataChange
virtual void NotifyAfterDataChange(const pdf::PDFDoc &document, JavascriptModifyItemInfo modify_item_info)=0
A callback function to notify that data has been modified.
foxit::SearchOption::is_case_sensitive
bool is_case_sensitive
Specifies whether the search query is case sensitive. Defaule value: false.
Definition: fs_actioncallback.h:1943
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeBorderEffectStyle
Javascript event item type: border effect style.
Definition: fs_actioncallback.h:2381
fs_common.h
Header file for common definitions and classes.
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeAppInit
Javascript event: App initialize.
Definition: fs_actioncallback.h:2165
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeBookmarkMouseUp
Javascript event: Bookmark mouse up.
Definition: fs_actioncallback.h:2237
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeImportAnnotFromXFDF
Javascript event item type: import annot from xfdf.
Definition: fs_actioncallback.h:2461
foxit::MediaPlayerCallback::GetPlayerSettings
virtual MediaSettings GetPlayerSettings()=0
A callback function to get the media player settings.
foxit::SearchOption::is_search_doc_text
bool is_search_doc_text
Specifies whether the document text is searched for the query. Defaule value: true.
Definition: fs_actioncallback.h:1977
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMenuExec
Javascript event: Menu execute.
Definition: fs_actioncallback.h:2231
foxit::ButtonItem::pos
int pos
The button number to place the added button in the toolbar.
Definition: fs_actioncallback.h:371
foxit::ActionCallback::e_LanguageDAN
Danish.
Definition: fs_actioncallback.h:2639
foxit::ActionCallback::GetPageScale
virtual float GetPageScale()=0
A callback function to get current page zoom value.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeReplacePages
Javascript event item type: replace pages.
Definition: fs_actioncallback.h:2459
foxit::PrintParams::e_DuplexTypeSimplex
Duplex type: prints on one side of the paper.
Definition: fs_actioncallback.h:1062
foxit::PrintParams::num_pages_v
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:1306
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeUnknown
Javascript event: unknown.
Definition: fs_actioncallback.h:2163
foxit::ActionCallback::CloseDoc
virtual void CloseDoc(const pdf::PDFDoc &document, bool is_prompt_to_save)=0
A callback function to close document.
foxit::ActionCallback::SetDefaultPageTransitionMode
virtual void SetDefaultPageTransitionMode(const wchar_t *trans_type, const wchar_t *trans_di)=0
A callback function to set the default page trastion mode for full screen mode.
foxit::FloatingInfo::FloatingInfo
FloatingInfo(const FloatingInfo &floating_info)
Constructor, with another floating infomation object.
Definition: fs_actioncallback.h:1419
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeDocWillSave
Javascript event: Document will save.
Definition: fs_actioncallback.h:2175
foxit::ButtonItem::name
WString name
A unique language-independent identifier for the button.
Definition: fs_actioncallback.h:369
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypePageOutView
Javascript event: Page outview.
Definition: fs_actioncallback.h:2187
foxit::ActionCallback::GetUntitledBookmarkName
virtual WString GetUntitledBookmarkName()=0
A callback function to get the new name for an untitled bookmark.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeHidden
Javascript event item type: hidden.
Definition: fs_actioncallback.h:2327
foxit::DialogDescriptionElement::align_children
String align_children
The alignment for all descendants.
Definition: fs_actioncallback.h:659
foxit::ActionCallback::SetDocChangeMark
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...
foxit::MediaSettings::show_ui
bool show_ui
A boolean value that specifies whether the controls of the media player should be visible or not.
Definition: fs_actioncallback.h:1679
foxit::SearchIndexConfig::SearchIndexConfig
SearchIndexConfig()
Constructor.
Definition: fs_actioncallback.h:1984
foxit::MediaSettings::page
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:1669
foxit::PlayerArgs::URL
WString URL
Either URL or rendition is required, with URL taking precedence.
Definition: fs_actioncallback.h:1797
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRect
Javascript event item type: rect.
Definition: fs_actioncallback.h:2337
foxit::ActionCallback::GetDocChangeMark
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...
foxit::ActionCallback::NotifyBeginDoJob
virtual void NotifyBeginDoJob(const pdf::PDFDoc &document, JavascriptModifyItemInfo::JavascriptEventType event_type)=0
A callback function used to notify javascript execution to begin.
foxit::DialogDescriptionConfig::DialogDescriptionConfig
DialogDescriptionConfig(const DialogDescriptionConfig &dlg_des_config)
Constructor, with another dialog description config object.
Definition: fs_actioncallback.h:698
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeContents
Javascript event item type: contents.
Definition: fs_actioncallback.h:2387
foxit::SOAPRequestProperties::request_url
WString request_url
The URL for a SOAP HTTP endpoint.
Definition: fs_actioncallback.h:947
foxit::ActionCallback::IsLocalFile
virtual bool IsLocalFile(const pdf::PDFDoc &document)=0
A callback function to check whether the file is local file.
foxit::DialogDescriptionElement::DialogDescriptionElement
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:507
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeBorderEffectIntensity
Javascript event item type: border effect intensity.
Definition: fs_actioncallback.h:2379
foxit::IdentityProperties::IdentityProperties
IdentityProperties(const IdentityProperties &id_properities)
Constructor, with another identity properties object.
Definition: fs_actioncallback.h:244
foxit::ButtonItem::label
WString label
A text label to be displayed on the button to the right of the icon.
Definition: fs_actioncallback.h:381
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeUserName
Javascript event item type: user name.
Definition: fs_actioncallback.h:2355
foxit::FloatingInfo::rect
RectF rect
A rectangle specifies the location and size of the floating window in device coordinate system.
Definition: fs_actioncallback.h:1508
foxit::ActionCallback::SelectPageNthWord
virtual void SelectPageNthWord(int page_index, int start_offset, int end_offset, bool is_show_selection)=0
A callback function to change the current page number and selects the specified word on the page.
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldMouseUp
Javascript event: Form field mouse up.
Definition: fs_actioncallback.h:2191
foxit::SearchIndexConfig
Definition: fs_actioncallback.h:1981
foxit::DialogDescriptionElement::DialogDescriptionElement
DialogDescriptionElement()
Constructor.
Definition: fs_actioncallback.h:487
foxit::ActionCallback::GetOpenedDoc
virtual pdf::PDFDoc GetOpenedDoc(int index)=0
A callback function to receive an opened PDF document object by index.
foxit::ActionCallback::GetAttachmentsFilePath
virtual WString GetAttachmentsFilePath(const pdf::PDFDoc &pdf_doc, const wchar_t *name)=0
A callback function to get the file path of attachments file.
foxit::ActionCallback::e_MailTypeForm
Mailed data type: form.
Definition: fs_actioncallback.h:2693
foxit::FloatingInfo::e_OffScreenCancel
Off screen action: cancel playing the media clip.
Definition: fs_actioncallback.h:1384
foxit::ActionCallback::e_JSFieldValueChangedByCalculation
javascript field value changed type : calculation.
Definition: fs_actioncallback.h:2707
foxit::MediaPlayerCallback::JSMediaPlayerState
JSMediaPlayerState
Enumeration for media player state.
Definition: fs_actioncallback.h:2072
foxit::FloatingInfo::has_title
bool has_title
true means a title should be displayed in the title bar, while false means not.
Definition: fs_actioncallback.h:1496
foxit::DialogDescriptionConfig::element_array
DialogDescriptionElementArray element_array
An array of dialog description element array object.
Definition: fs_actioncallback.h:795
foxit::ActionCallback::ResetModifyItem
virtual void ResetModifyItem(const pdf::PDFDoc &document)=0
A callback function to reset modify item.
foxit::DialogDescriptionConfig::height
int height
The height of the dialog box in pixels.
Definition: fs_actioncallback.h:775
foxit::ActionCallback::GetIdentityProperties
virtual IdentityProperties GetIdentityProperties()=0
A callback function used to get identity properties of current user.
foxit::MediaPlayerCallback::Stop
virtual bool Stop()=0
A callback function to stop the media player.
foxit::SOAPAuthenticateInfo::SOAPAuthenticateInfo
SOAPAuthenticateInfo(const wchar_t *username, const wchar_t *password, bool is_use_platform_auth)
Constructor, with parameters.
Definition: fs_actioncallback.h:811
foxit::ActionCallback::e_JSMediaPlayerStateClose
media player state: Close.
Definition: fs_actioncallback.h:2725
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonFitBounds
Javascript event item type: button fit bounds.
Definition: fs_actioncallback.h:2305
foxit::PrintParams::is_print_auto_rotate
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:1255
foxit::ActionCallback::MailData
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.
foxit::IdentityProperties::login_name
WString login_name
The login name. Usually, this is the name used to log in current operating system.
Definition: fs_actioncallback.h:285
foxit::ActionCallback::SetIdentityProperties
virtual bool SetIdentityProperties(const IdentityProperties &identity_properties)=0
A callback function used to set identity properties of current user.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeBorderColor
Javascript pre-sign item type: border color.
Definition: fs_actioncallback.h:2283
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeIntent
Javascript event item type: intent.
Definition: fs_actioncallback.h:2395
foxit::ActionCallback::SearchScope
SearchScope
Enumeration for search scope.
Definition: fs_actioncallback.h:2769
foxit::JavascriptModifyItemInfo::field_or_annot_name
WString field_or_annot_name
The form field full name or annot subtype name.
Definition: fs_actioncallback.h:2610
foxit::FloatingInfo::e_RelativeTargetAppWindow
Relative type: align the floating window relative to the application window.
Definition: fs_actioncallback.h:1352
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeLeaderExtend
Javascript event item type: leader extend.
Definition: fs_actioncallback.h:2397
foxit::ButtonItem::marked
WString marked
An expression string that determines whether the toolbutton is marked.
Definition: fs_actioncallback.h:377
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeMultipleSelection
Javascript event item type: multiple selection.
Definition: fs_actioncallback.h:2479
foxit::ActionCallback::e_LanguageKOR
Korean.
Definition: fs_actioncallback.h:2651
foxit::SOAPAuthenticateInfo::is_use_platform_auth
bool is_use_platform_auth
A Boolean value indicating that platform authentication should be used.
Definition: fs_actioncallback.h:853
foxit::FloatingInfo::Set
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:1462
foxit::common::Rotation
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
foxit::PrintParams::e_PageOrderVertical
Page Order type: pages are placed from top to bottom, from left to right.
Definition: fs_actioncallback.h:1119
foxit::ActionCallback::AddMenuItem
virtual bool AddMenuItem(const MenuItemConfig &menu_item_config, bool is_prepend)=0
A callback function to adds a menu item to a menu.
foxit::PlayerArgs::rendition
pdf::Rendition rendition
A pdf::Rendition object (either a MediaRendition or a RenditionList).
Definition: fs_actioncallback.h:1794
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeSelectChange
Javascript event item type: select change.
Definition: fs_actioncallback.h:2295
foxit::PrintParams::e_BookletDuplexModeBothSides
Booklet Duplex Mode: automatically prints both sides of the paper.
Definition: fs_actioncallback.h:1076
foxit::ActionCallback::Print
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.
foxit::SOAPRequestProperties::is_encode
bool is_encode
Encoded the request using the SOAP Encoding described in the SOAP Specification. Otherwise,...
Definition: fs_actioncallback.h:967
foxit::SOAPAuthenticateInfo::password
WString password
A string containing the password to use for authentication.
Definition: fs_actioncallback.h:844
foxit::SearchIndexConfig::name
WString name
The name of search index.
Definition: fs_actioncallback.h:2043
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeInsertFromTemplates
Javascript event item type: insert from templates.
Definition: fs_actioncallback.h:2475
foxit::MediaSettings::bg_opacity
float bg_opacity
The background opacity for the media player window.
Definition: fs_actioncallback.h:1660
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenInview
Javascript event: Screen in view.
Definition: fs_actioncallback.h:2225
foxit::SearchOption::is_ignore_full_width
bool is_ignore_full_width
Specifies whether full width and half width characters in the document exactly match the search query...
Definition: fs_actioncallback.h:1967
foxit::PrintParams::e_PrintContentDocument
Print Content: print the document contents, not comments.
Definition: fs_actioncallback.h:1048
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeLinkMouseUp
Javascript event: Link mouse up.
Definition: fs_actioncallback.h:2239
foxit::JavascriptModifyItemInfo::e_JavascriptModifyTypeNone
Javascript modify type: none.
Definition: fs_actioncallback.h:2491
foxit::PrintParams::is_print_page_border
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:1259
foxit::PrintParams::PrintHandling
PrintHandling
Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
Definition: fs_actioncallback.h:1127
foxit::FloatingInfo::e_WindowPositionTopRight
Window position: at the top right corner.
Definition: fs_actioncallback.h:1328
foxit::PrintParams::e_DuplexTypeDuplexFlipLongEdge
Duplex type: prints on both sides of the paper; the paper flips along the long edge.
Definition: fs_actioncallback.h:1064
foxit::PrintParams::e_DuplexTypeDuplexFlipShortEdge
Duplex type: prints on both sides of the paper; the paper flips along the short edge.
Definition: fs_actioncallback.h:1066
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::ActionCallback::e_LayoutModeContinuousFacing
Layout mode: continuous two pages.
Definition: fs_actioncallback.h:2747
foxit::PrintParams::num_pages_h
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:1304
foxit::PrintParams::printer_name
WString printer_name
The default printer name for printing.
Definition: fs_actioncallback.h:1272
foxit::PlayerArgs::PlayerArgs
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:1714
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeInsertPages
Javascript event item type: insert pages.
Definition: fs_actioncallback.h:2457
foxit::IdentityProperties::Set
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
foxit::PrintParams::operator=
PrintParams & operator=(const PrintParams &print_params)
Assign operator.
Definition: fs_actioncallback.h:1210
foxit::ActionCallback::GetAppInfo
virtual WString GetAppInfo(AppInfoType type)=0
A callback function to get application information.
foxit::JavascriptModifyItemInfo::e_JavascriptModifyItemTypeField
Javascript modify item type: field.
Definition: fs_actioncallback.h:2265
foxit::DialogDescriptionConfig::char_width
int char_width
The width of the dialog box in characters.
Definition: fs_actioncallback.h:782
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenMouseDown
Javascript event: Screen mouse down.
Definition: fs_actioncallback.h:2217
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaDone
Javascript event: Media done.
Definition: fs_actioncallback.h:2245
foxit::PrintParams::is_print_as_image
bool is_print_as_image
true means that pages should be printed as image.
Definition: fs_actioncallback.h:1248
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAddLink
Javascript event item type: add link.
Definition: fs_actioncallback.h:2477
foxit::ActionCallback::RemoveToolButtom
virtual bool RemoveToolButtom(const wchar_t *button_name)=0
A callback function to remove a tool button added by the function ActionCallback::AddToolButton.
foxit::ActionCallback::e_LanguageITA
Italian.
Definition: fs_actioncallback.h:2649
foxit::FloatingInfo::e_WindowPositionCenter
Window position: at the center.
Definition: fs_actioncallback.h:1332
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeClearItems
Javascript event item type: clear items.
Definition: fs_actioncallback.h:2361
foxit::JavascriptModifyItemInfo::JavascriptModifyItemInfo
JavascriptModifyItemInfo(const JavascriptModifyItemInfo &other)
Constructor, with another javascript modify item information object.
Definition: fs_actioncallback.h:2545
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeMultiline
Javascript event item type: multiline.
Definition: fs_actioncallback.h:2333
foxit::FloatingInfo::e_RelativeTargetPageWindow
Relative type: align the floating window relative to the document (page) window.
Definition: fs_actioncallback.h:1350
foxit::ActionCallback::e_LanguageESP
Spanish.
Definition: fs_actioncallback.h:2645
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRsetForms
Javascript event item type: reset forms.
Definition: fs_actioncallback.h:2435
foxit::ActionCallback::GetFullScreen
virtual bool GetFullScreen()=0
A callback function to get whether the full screen mode is set.
foxit::ActionCallback::e_AppInfoTypeViewerVersion
Application's viewer version information.
Definition: fs_actioncallback.h:2679
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeButtonPosition
Javascript event item type: button position.
Definition: fs_actioncallback.h:2293
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeInsertItemAt
Javascript event item type: insert item at.
Definition: fs_actioncallback.h:2367
foxit::SearchIndexConfig::Set
void Set(WString name, bool is_available, WString path, bool is_selected)
Set values.
Definition: fs_actioncallback.h:2036
foxit::DialogDescriptionElement::Set
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:590
foxit::ActionCallback::IsCurrentDocOpenedInBrowser
virtual bool IsCurrentDocOpenedInBrowser()=0
A callback function to get the flag specifies whether current document is opened in browser.
foxit::PlayerArgs::doc
pdf::PDFDoc doc
The PDFDoc object of the document.
Definition: fs_actioncallback.h:1780
foxit::ActionCallback::e_JSMediaPlayerStateOpen
media player state: Open.
Definition: fs_actioncallback.h:2723
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeTextSize
Javascript event item type: text size.
Definition: fs_actioncallback.h:2413
foxit::pdf::Signature
Definition: fs_signature.h:99
foxit::FloatingInfo::e_RelativeTargetDesktop
Relative type: align the floating window relative to the full virtual desktop.
Definition: fs_actioncallback.h:1354
foxit::ActionCallback::e_LanguageSVE
Swedish.
Definition: fs_actioncallback.h:2663
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaSeek
Javascript event: Media seek.
Definition: fs_actioncallback.h:2251
foxit::ActionCallback::GetExtractedEmbeddedFilePath
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.
foxit::ActionCallback::IsPageLoop
virtual bool IsPageLoop()=0
A callback function to get the flag specifies whether the document will loop around to the beginning ...
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaStop
Javascript event: Media stop.
Definition: fs_actioncallback.h:2253
foxit::ActionCallback::e_LanguageENU
English.
Definition: fs_actioncallback.h:2643
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldMouseExit
Javascript event: Form field mouse exit.
Definition: fs_actioncallback.h:2195
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeSubject
Javascript event item type: subject.
Definition: fs_actioncallback.h:2421
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeNewPage
Javascript event item type: new page.
Definition: fs_actioncallback.h:2453
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeLineEnding
Javascript event item type: line ending.
Definition: fs_actioncallback.h:2401
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeRemoveDataObject
Javascript event item type: remove data object.
Definition: fs_actioncallback.h:2427
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypePoints
Javascript event item type: points.
Definition: fs_actioncallback.h:2409
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeSetPageTemplateVisible
Javascript event item type: set page template visible.
Definition: fs_actioncallback.h:2481
foxit::DialogDescriptionConfig::first_tab
String first_tab
An ItemID for the dialog box item that should be first in the tab order.
Definition: fs_actioncallback.h:761
foxit::JavascriptModifyItemInfo::e_JavascriptModifyItemTypePage
Javascript modify item type: Page.
Definition: fs_actioncallback.h:2269
foxit::ActionCallback::LaunchURL
virtual bool LaunchURL(const char *url)=0
A callback function to launch to a specified URL.
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeFieldFocus
Javascript event: Form field focus.
Definition: fs_actioncallback.h:2197
foxit::ActionCallback::e_LanguageSUO
Finnish.
Definition: fs_actioncallback.h:2661
foxit::MediaPlayerCallback::e_JSMediaPlayerStatePlaying
media player state: Playing.
Definition: fs_actioncallback.h:2078
foxit::SOAPRequestProperties::soap_namespace
WString soap_namespace
A namespace for the message schema when the request does not use the SOAP Encoding.
Definition: fs_actioncallback.h:958
foxit::SOAPResponseInfo::status_code
uint32 status_code
Status code of the response.
Definition: fs_actioncallback.h:1035
foxit::ActionCallback::e_ModifyItemTypeNone
Modify item type: none.
Definition: fs_actioncallback.h:2787
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeMediaReady
Javascript event: Media ready.
Definition: fs_actioncallback.h:2249
foxit::JavascriptModifyItemInfo::JavascriptEventType
JavascriptEventType
Enumeration for javascript event type.
Definition: fs_actioncallback.h:2161
foxit::ActionCallback::GetPageWindowRect
virtual RectF GetPageWindowRect(const foxit::pdf::PDFDoc &document, int page_index)=0
A callback function to get the rectangle for the page view window. The page view window is the area i...
foxit::JavascriptModifyItemInfo::e_JavascriptModifyTypeModify
Javascript modify type: modify.
Definition: fs_actioncallback.h:2495
foxit::ActionCallback::e_AppInfoTypeViewerVariation
Application's viewer variation information.
Definition: fs_actioncallback.h:2677
foxit::ActionCallback::ShowDialog
virtual bool ShowDialog(const DialogDescriptionConfig &dlg_config)=0
A callback function to show the dialog.
foxit::ActionCallback::e_AppInfoTypeViewerType
Application's viewer type information.
Definition: fs_actioncallback.h:2675
foxit::MediaSettings::e_PlayerWindowTypeFloating
Window type: a floating window.
Definition: fs_actioncallback.h:1523
foxit::ActionCallback::OpenMediaPlayer
virtual MediaPlayerCallback * OpenMediaPlayer(const PlayerArgs &player_args)=0
A callback function to open media player.
foxit::FloatingInfo::window_pos
WindowPosition window_pos
Specify how the floating window is to be positioned relative to the window specified by the relative...
Definition: fs_actioncallback.h:1478
foxit::JavascriptModifyItemInfo::JavascriptModifyItemType
JavascriptModifyItemType
Enumeration for javascript modify item type.
Definition: fs_actioncallback.h:2261
foxit::DialogDescriptionConfig::DialogDescriptionConfig
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:682
foxit::ActionCallback::e_ModifyItemTypeField
Modify item type: Field.
Definition: fs_actioncallback.h:2789
foxit::ActionCallback::e_LayoutModeSinglePage
Layout mode: single page.
Definition: fs_actioncallback.h:2741
foxit::SearchOption::e_WordMatchingMatchPhrase
Word matching: match phrase.
Definition: fs_actioncallback.h:1816
foxit::PrintParams::e_BookletBindingRightTall
Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style v...
Definition: fs_actioncallback.h:1105
foxit::ButtonItem::exec
WString exec
The expression string to evaluate when the button is selected.
Definition: fs_actioncallback.h:373
foxit::IdentityProperties::email
WString email
The email address.
Definition: fs_actioncallback.h:283
foxit::ActionCallback::GetCurrentPage
virtual int GetCurrentPage(const pdf::PDFDoc &document)=0
A callback function used to receive current page index.
foxit::ActionCallback::e_JSFieldValueChangedBySetReadOnly
javascript field value changed type: field set read-only property.
Definition: fs_actioncallback.h:2711
foxit::DialogDescriptionElement::DialogDescriptionElement
DialogDescriptionElement(const DialogDescriptionElement &dlg_des_element)
Constructor, with another dialog description element object.
Definition: fs_actioncallback.h:529
foxit::JavascriptModifyItemInfo::event_type
JavascriptEventType event_type
The javascript event type. Please refer to values starting from JavascriptModifyItemInfo::e_Javascrip...
Definition: fs_actioncallback.h:2583
foxit::DialogDescriptionElement
Definition: fs_actioncallback.h:484
foxit::PrintParams::page_range
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:1265
foxit::ActionCallback::e_SearchScopeActiveDoc
Search scope: active document.
Definition: fs_actioncallback.h:2771
foxit::PrintParams::output_file_name
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:1274
foxit::ButtonItem::ButtonItem
ButtonItem()
Constructor.
Definition: fs_actioncallback.h:302
foxit::SOAPRequestProperties::soap_action
WString soap_action
The SOAP action is a URN written to an HTTP header used by firewalls and servers to filter SOAP reque...
Definition: fs_actioncallback.h:951
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeDownCaption
Javascript event item type: down caption.
Definition: fs_actioncallback.h:2349
foxit::ActionCallback::BrowseFile
virtual WString BrowseFile()=0
A callback function to show a file selection dialog, and the selected file path should be returned.
foxit::JavascriptModifyItemInfo::new_value
WString new_value
The new value.
Definition: fs_actioncallback.h:2613
foxit::PrintParams::booklet_duplex_mode
BookletDuplexMode booklet_duplex_mode
The value determines the duplex printing mode when printing a booklet.Please refer to values starting...
Definition: fs_actioncallback.h:1302
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeConsoleExec
Javascript event: Console execute.
Definition: fs_actioncallback.h:2233
foxit::PrintParams::is_show_ui
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:1241
foxit::ActionCallback::e_LanguageCHT
Chinese Traditional.
Definition: fs_actioncallback.h:2637
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeArrowEnd
Javascript event item type: arrow end.
Definition: fs_actioncallback.h:2375
foxit::ActionCallback::InitModifyItem
virtual bool InitModifyItem(const pdf::PDFDoc &document, ModifyItemType item_type, int page_index, const WString &dict_name)=0
A callback function to init modify item.
foxit::ActionCallback::e_LanguageJPN
Japanese.
Definition: fs_actioncallback.h:2653
foxit::DialogDescriptionConfig
Definition: fs_actioncallback.h:665
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeSetItems
Javascript event item type: set items.
Definition: fs_actioncallback.h:2369
foxit::ActionCallback::SoapRequest
virtual SOAPResponseInfo SoapRequest(const SOAPRequestProperties &request_params)=0
Initiates a remote procedure call (RPC) or sends an XML message to a SOAP HTTP endpoint.
foxit::ActionCallback::Query
virtual void Query(const wchar_t *keywords, SearchScope search_scope, const SearchOption &search_option, const wchar_t *di_path)=0
A callback function to query the text keywords.
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeScreenMouseEnter
Javascript event: Screen mouse enter.
Definition: fs_actioncallback.h:2221
foxit::JavascriptModifyItemInfo::e_JavascriptEventTypeBatchExec
Javascript event: Batch execute.
Definition: fs_actioncallback.h:2229
foxit::SearchOption::SearchOption
SearchOption(bool is_whole_word, bool is_case_sensitive, bool is_search_bookmarks, bool is_search_in_marup, bool is_search_in_attachments, bool is_ignore_accents, bool is_proximity, bool is_stemming, bool is_ignore_full_width, int max_docs, WordMatching word_matching, bool is_search_doc_text)
Constructor, with parameters.
Definition: fs_actioncallback.h:1845
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeSoundIcon
Javascript event item type: sound icon.
Definition: fs_actioncallback.h:2419
foxit::JavascriptModifyItemInfo::modify_item_type
JavascriptModifyItemType modify_item_type
The modify item type. Please refer to values starting from JavascriptModifyItemInfo::e_JavascriptModi...
Definition: fs_actioncallback.h:2595
foxit::ActionCallback::e_ModifyItemTypePage
Modify item type: Page.
Definition: fs_actioncallback.h:2793
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::JavascriptModifyItemInfo::e_JavascriptModifyPropertyTypeAddWeblinks
Javascript event item type: add web links.
Definition: fs_actioncallback.h:2445
foxit::SOAPRequestProperties::soap_version
WString soap_version
The version of the SOAP protocol to use when generating the XML Message.
Definition: fs_actioncallback.h:960
foxit::ActionCallback::VerifySignature
virtual uint32 VerifySignature(const pdf::PDFDoc &document, const pdf::Signature &pdf_signature)=0
A callback function to verify specified signature..
foxit::FloatingInfo::OffScreenAction
OffScreenAction
Enumeration for the action can be taken if the floating window is positioned totally or partially off...
Definition: fs_actioncallback.h:1378
foxit::SearchIndexConfig::path
WString path
The path of the search index.
Definition: fs_actioncallback.h:2052
foxit::ActionCallback::GetPrinterNameList
virtual WStringArray GetPrinterNameList()=0
A callback function to get the printer name list.