Go to the documentation of this file.
15 #ifndef FS_ACTIONCALLBACK_H_
16 #define FS_ACTIONCALLBACK_H_
50 this->sub_menu_list_array = sub_menu_list_array;
59 level = menu_list.
level;
60 name = menu_list.
name;
72 this->level = menu_list.
level;
73 this->name = menu_list.
name;
91 this->sub_menu_list_array = sub_menu_list_array;
425 ,
pos(menu_item_config.
pos)
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,
515 , char_width(char_width)
516 , char_height(char_height)
520 , alignment(alignment)
521 , align_children(align_children)
522 , element_array(element_array) {}
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) {}
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;
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;
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,
593 this->item_id = item_id;
595 this->next_tab = next_tab;
597 this->height = height;
598 this->char_width = char_width;
599 this->char_height = char_height;
602 this->italic = italic;
603 this->alignment = alignment;
604 this->align_children = align_children;
605 this->element_array = element_array;
1046 typedef enum _PrintContent {
1060 typedef enum _DuplexType {
1074 typedef enum _BookletDuplexMode {
1088 typedef enum _BookletBinding {
1113 typedef enum _PageOrder {
1127 typedef enum _PrintHandling {
1322 typedef enum _WindowPosition {
1348 typedef enum _RelativeTarget {
1364 typedef enum _ResizeType {
1378 typedef enum _OffScreenAction {
1469 this->title =
title;
1519 typedef enum _PlayerWindowType {
1744 this->
doc = player_args.
doc;
1747 this->
URL = player_args.
URL;
1814 typedef enum _WordMatching {
2019 this->
name = search_index_config.
name;
2021 this->
path = search_index_config.
path;
2072 typedef enum _JSMediaPlayerState {
2100 virtual bool Play() = 0;
2109 virtual void Close() = 0;
2118 virtual bool Stop() = 0;
2129 virtual bool Seek(
int current_pos) = 0;
2165 typedef enum _Language {
2205 typedef enum _AppInfoType {
2223 typedef enum _MailType {
2237 typedef enum _JSFieldValueChangeType {
2255 typedef enum _JSMediaPlayerState {
2273 typedef enum _LayoutMode {
2289 typedef enum _JsMailResult {
2303 typedef enum _SearchScope {
2531 virtual bool Beep(
int type) = 0;
2551 virtual WString Response(
const wchar_t* question,
const wchar_t* title,
const wchar_t* default_value,
2552 const wchar_t* label,
bool is_password) = 0;
2631 bool is_shrunk_to_fit,
bool is_printed_as_image,
2632 bool is_reversed,
bool is_to_print_annots) = 0;
2674 virtual bool LaunchURL(
const char* url) = 0;
2700 virtual WString BrowseFile(
bool is_open_dialog,
const wchar_t* file_format,
const wchar_t* file_filter) = 0;
2744 virtual int Alert(
const wchar_t* msg,
const wchar_t* title,
int type,
int icon) = 0;
2844 virtual bool MailData(
void* data,
MailType data_type,
bool is_ui,
const wchar_t* to,
2845 const wchar_t* subject,
const wchar_t* cc,
const wchar_t* bcc,
const wchar_t* message) = 0;
3028 const wchar_t* to_address,
const wchar_t* cc_address,
const wchar_t* bcc_address,
3029 const wchar_t* subject,
const wchar_t* message,
bool is_ui) = 0;
3094 virtual void SelectPageNthWord(
int page_index,
int start_offset,
int end_offset,
bool is_show_selection) = 0;
3325 #endif // FS_ACTIONCALLBACK_H_
virtual bool SetIdentityProperties(const IdentityProperties &identity_properties)=0
A callback function used to set identity properties of current user.
Unknown language.
Definition: fs_actioncallback.h:2167
WString name
The user name.
Definition: fs_actioncallback.h:287
virtual WString PopupMenu(const MenuListArray &menus, bool &is_selected_item)=0
A callback function to pop up a menu window.
bool is_print_as_image
true means that pages should be printed as image.
Definition: fs_actioncallback.h:1248
Definition: fs_annot.h:4312
String align_children
The alignment for all descendants.
Definition: fs_actioncallback.h:792
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
virtual void SetLayoutMode(LayoutMode layout_mode, bool is_cover_mode)=0
A callback function to set the page layout of the current document.
bool is_ignore_accents
Specifies whether accents and diacriticals are ignored while searching the query term....
Definition: fs_actioncallback.h:1951
Chinese Traditional.
Definition: fs_actioncallback.h:2171
Print Content: print the document contents, not comments.
Definition: fs_actioncallback.h:1048
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
Print Handling: No page scaling is applied.
Definition: fs_actioncallback.h:1129
virtual void UpdateLogicalLabel()=0
A callback function to update logical label.
int max_docs
The maximum number of documents that will be returned as part of the search query....
Definition: fs_actioncallback.h:1969
virtual int GetOpenedDocCount()=0
A callback function to receive the count of opened documents.
Definition: fs_actioncallback.h:211
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
int width
Specifies the width of the element in pixels.
Definition: fs_actioncallback.h:621
FileFormatType
Enumeration for file format type.
Definition: fs_common.h:237
RectF rect
A rectangle specifies the location and size of the floating window in device coordinate system.
Definition: fs_actioncallback.h:1508
virtual bool IsCurrentDocOpenedInBrowser()=0
A callback function to get the flag specifies whether current document is opened in browser.
Booklet Duplex Mode: only prints all pages that appear on the front side of the paper.
Definition: fs_actioncallback.h:1078
SearchOption & operator=(const SearchOption &search_option)
Assign operator.
Definition: fs_actioncallback.h:1887
virtual bool AddMenuItem(const MenuItemConfig &menu_item_config, bool is_prepend)=0
A callback function to adds a menu item to a menu.
Definition: fs_actioncallback.h:484
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
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.
Definition: fs_actioncallback.h:481
Definition: fs_actioncallback.h:2158
Off screen action: move or resize the window so that it is on-screen.
Definition: fs_actioncallback.h:1382
virtual pdf::PDFDoc OpenDoc(const WString &file_path, const WString &password)=0
A callback function to open a PDF file.
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
WString response_body
Body of the SOAP response.
Definition: fs_actioncallback.h:1031
Print Content: print the document contents and comments.
Definition: fs_actioncallback.h:1050
bool is_encode
Encoded the request using the SOAP Encoding described in the SOAP Specification. Otherwise,...
Definition: fs_actioncallback.h:967
javascript field value changed type : calculation.
Definition: fs_actioncallback.h:2241
Print Handling: Small pages are printed small, and large pages are shrunk to fit on the printer's pap...
Definition: fs_actioncallback.h:1133
Korean.
Definition: fs_actioncallback.h:2185
media player state: Playing.
Definition: fs_actioncallback.h:2261
virtual void SetPageScale(foxit::pdf::Destination::ZoomMode zoom_mode, const foxit::pdf::Destination &dest)=0
A callback function to set current page zoom value.
WString network_error
Network error information of the SOAP response.
Definition: fs_actioncallback.h:1033
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.
Resize type: may not be resized.
Definition: fs_actioncallback.h:1366
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
WString audio_format
The audio format, such as "audio/wav".
Definition: fs_actioncallback.h:1800
WString soap_version
The version of the SOAP protocol to use when generating the XML Message.
Definition: fs_actioncallback.h:960
Layout mode: two pages.
Definition: fs_actioncallback.h:2279
virtual SearchIndexConfig AddSearchIndex(const wchar_t *di_path, bool is_selected)=0
A callback function to add a search index.
Off screen action: cancel playing the media clip.
Definition: fs_actioncallback.h:1384
bool is_print_auto_center
true means that each page is automatically centered relative to the paper.
Definition: fs_actioncallback.h:1250
virtual SOAPResponseInfo SoapRequest(const SOAPRequestProperties &request_params)=0
Initiates a remote procedure call (RPC) or sends an XML message to a SOAP HTTP endpoint.
Resize type: may be resized without preserving the aspect ratio.
Definition: fs_actioncallback.h:1370
SOAPAuthenticateInfo authenticate
An object that specifies how to handle HTTP authentication or credentials to use for Web Service Secu...
Definition: fs_actioncallback.h:976
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
WString corporation
The corporation name.
Definition: fs_actioncallback.h:281
int height
Specifies the height of the element in pixels.
Definition: fs_actioncallback.h:628
Definition: fs_actioncallback.h:1807
bool has_title
true means a title should be displayed in the title bar, while false means not.
Definition: fs_actioncallback.h:1496
bool is_search_bookmarks
Specifies whether bookmarks are searched for the query. Defaule value: false.
Definition: fs_actioncallback.h:1945
FloatingInfo()
Constructor.
Definition: fs_actioncallback.h:1389
virtual RectF GetPageWindowRect()=0
A callback function to get the rectangle for the page view window. The page view window is the area i...
Print Handling: Pages are rescaled to print multiple pages on each printer page.
Definition: fs_actioncallback.h:1135
JsMailResult
Enumeration for result of the mail.
Definition: fs_actioncallback.h:2289
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
virtual WStringArray GetSignatureAPStyleNameList()=0
A callback function to get the name list of signature appearance style.
Definition: fs_actioncallback.h:799
LayoutMode
Enumeration for layout mode.
Definition: fs_actioncallback.h:2273
PrintParams(const PrintParams &print_params)
Constructor, with another print parameters object.
Definition: fs_actioncallback.h:1178
SOAPResponseInfo(const SOAPResponseInfo &soap_response)
Constructor, with another SOAP response object.
Definition: fs_actioncallback.h:1005
virtual Language GetLanguage()=0
A callback function to get the language of the running viewer application.
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...
Application's viewer version information.
Definition: fs_actioncallback.h:2213
Window position: at the center left.
Definition: fs_actioncallback.h:1330
DuplexType duplex_type
Sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed....
Definition: fs_actioncallback.h:1281
WString title
The user title.
Definition: fs_actioncallback.h:293
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
Mailed result: mail failed.
Definition: fs_actioncallback.h:2291
Header file for common definitions and classes.
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...
Brazilian Portuguese.
Definition: fs_actioncallback.h:2193
bool is_search_in_markup
Specifies whether markup (annotations) are searched for the query. Defaule value: false.
Definition: fs_actioncallback.h:1947
Relative type: align the floating window relative to the document (page) window.
Definition: fs_actioncallback.h:1350
Search scope: index.
Definition: fs_actioncallback.h:2309
virtual float GetPageScale()=0
A callback function to get current page zoom value.
PageOrder
Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
Definition: fs_actioncallback.h:1113
Resize type: may be resized only if the aspect ratio is preserved.
Definition: fs_actioncallback.h:1368
int width
The width of the dialog box in pixels.
Definition: fs_actioncallback.h:768
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
virtual PointF GetMousePosition()=0
A callback function to get current mouse position.
virtual IdentityProperties GetIdentityProperties()=0
A callback function used to get identity properties of current user.
Window position: at the center right.
Definition: fs_actioncallback.h:1334
String name
The title bar of the dialog box.
Definition: fs_actioncallback.h:754
PrintContent print_content
Specif content for printing. Please refer to values starting from PrintParams::e_PrintContentDocument...
Definition: fs_actioncallback.h:1270
WString request_url
The URL for a SOAP HTTP endpoint.
Definition: fs_actioncallback.h:947
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
BookletBinding binding
The value determines the paper binding direction and the page arrange order. Please refer to values s...
Definition: fs_actioncallback.h:1297
Norwegian.
Definition: fs_actioncallback.h:2191
WordMatching
Enumeration for word matching.
Definition: fs_actioncallback.h:1814
DialogDescriptionElement(const DialogDescriptionElement &dlg_des_element)
Constructor, with another dialog description element object.
Definition: fs_actioncallback.h:529
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.
BookletBinding
Enumeration for the values used to determine the duplex printing mode when printing a booklet.
Definition: fs_actioncallback.h:1088
SOAPAuthenticateInfo(const SOAPAuthenticateInfo &soap_authenticate)
Constructor, with another SOAP authenticate object.
Definition: fs_actioncallback.h:821
virtual bool GetFullScreen()=0
A callback function to get whether the full screen mode is set.
Definition: fs_actioncallback.h:857
void Set(const wchar_t *username, const wchar_t *password, bool is_use_platform_auth)
Set values.
Definition: fs_actioncallback.h:835
virtual void PostMessageToHtml(WStringArray message)=0
A callback function to send message asynchronously to the message handler for the host container of t...
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.
virtual WString BrowseFile()=0
A callback function to show a file selection dialog, and the selected file path should be returned.
virtual bool Beep(int type)=0
A callback function to cause the system to play a sound.
French.
Definition: fs_actioncallback.h:2181
Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style v...
Definition: fs_actioncallback.h:1095
Definition: fs_rendition.h:38
WString username
A string containing the user name to use for authentication.
Definition: fs_actioncallback.h:842
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.
Layout mode: continuous page.
Definition: fs_actioncallback.h:2277
virtual bool RemoveToolButtom(const wchar_t *button_name)=0
A callback function to remove a tool button added by the function ActionCallback::AddToolButton.
Booklet Binding: Right-side binding for text with right-to-left reading direction or Japanese-style v...
Definition: fs_actioncallback.h:1105
virtual bool ShowDialog(const DialogDescriptionConfig &dlg_config)=0
A callback function to show the dialog.
bool tile_mark
true means to cut the page, and false means not.
Definition: fs_actioncallback.h:1285
Page Order type: pages are placed from top to bottom, from left to right.
Definition: fs_actioncallback.h:1119
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
bool is_tile_label
Label each page of tiled output. Labeled pages indicate row and column, file name,...
Definition: fs_actioncallback.h:1283
WString department
The department name.
Definition: fs_actioncallback.h:295
Page Order type: pages are placed from right to left, from top to bottom.
Definition: fs_actioncallback.h:1117
pdf::annots::Screen screen_annot
A pdf::annots::Screen object.
Definition: fs_actioncallback.h:1787
Chinese Simplified.
Definition: fs_actioncallback.h:2169
Relative type: align the floating window relative to the full virtual desktop.
Definition: fs_actioncallback.h:1354
SOAPRequestProperties(const SOAPRequestProperties &request_properties)
Constructor, with another SOAP request properties object.
Definition: fs_actioncallback.h:898
PrintHandling handling
The print handling type.Please refer to values starting from PrintParams::e_PrintHandlingNone and thi...
Definition: fs_actioncallback.h:1293
String request_content
An object that specifies the remote procedure name and parameters or the XML message to send.
Definition: fs_actioncallback.h:949
virtual pdf::PDFDoc GetCurrentDoc()=0
A callback function to receive current PDF document object.
Relative type: align the floating window relative to the application window.
Definition: fs_actioncallback.h:1352
Duplex type: prints on one side of the paper.
Definition: fs_actioncallback.h:1062
void Set(WString name, bool is_available, WString path, bool is_selected)
Set values.
Definition: fs_actioncallback.h:2036
media player state: Stop.
Definition: fs_actioncallback.h:2263
DuplexType
Enumeration for the values used to set the printing duplex mode.
Definition: fs_actioncallback.h:1060
virtual WString GetUntitledBookmarkName()=0
A callback function to get the new name for an untitled bookmark.
virtual bool LaunchURL(const char *url)=0
A callback function to launch to a specified URL.
bool is_reverse
true means that the printing order should be from parameter end to parameter start.
Definition: fs_actioncallback.h:1246
AppInfoType
Enumeration for application's information type.
Definition: fs_actioncallback.h:2205
RelativeTarget
Enumeration for the values used to set relative position of floating window.
Definition: fs_actioncallback.h:1348
virtual bool IsPageLoop()=0
A callback function to get the flag specifies whether the document will loop around to the beginning ...
Page Order type: pages are placed from left to right, from top to bottom.
Definition: fs_actioncallback.h:1115
virtual int Alert(const wchar_t *msg, const wchar_t *title, int type, int icon)=0
A callback function used to pop up a dialog to show warnings or hints.
virtual pdf::PDFDoc GetOpenedDoc(int index)=0
A callback function to receive an opened PDF document object by index.
Print Content: print the contents of form fields only. Useful for printing onto pre-preprinted forms.
Definition: fs_actioncallback.h:1052
SearchOption(const SearchOption &search_option)
Constructor, with another search option object.
Definition: fs_actioncallback.h:1866
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
Print Handling: Pages are enlarged or shrunk to fit the printe's paper.
Definition: fs_actioncallback.h:1131
BYTE STRING CLASS.
Definition: fx_string.h:317
bool is_stemming
Specifies whether the search query will take the stemming of words (for example, run,...
Definition: fs_actioncallback.h:1961
Window position: at the bottom center.
Definition: fs_actioncallback.h:1338
bool is_whole_word
Specifies whether search finds only occurrences of complete words that are specified in the query....
Definition: fs_actioncallback.h:1941
javascript field value changed type: format.
Definition: fs_actioncallback.h:2239
virtual void SetCurrentPage(const pdf::PDFDoc &document, int page_index)=0
A callback function used to set the current page by index.
WString response_header
Header of the SOAP response.
Definition: fs_actioncallback.h:1029
Mailed result: mail success.
Definition: fs_actioncallback.h:2293
virtual void Release()=0
A callback function used to release current callback object itself.
float tile_scale
The amount that tiled pages are scaled.
Definition: fs_actioncallback.h:1289
Booklet Binding: Left-side binding for Western-style left-to-right reading direction....
Definition: fs_actioncallback.h:1100
virtual bool AddSubMenu(const MenuItemConfig &menu_item_config)=0
A callback function to add a menu item with a submenu to the application.
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.
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
javascript field value changed type: field set value.
Definition: fs_actioncallback.h:2243
PrintParams()
Constructor.
Definition: fs_actioncallback.h:1147
SearchIndexConfig()
Constructor.
Definition: fs_actioncallback.h:1984
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
WString last_name
The user last name.
Definition: fs_actioncallback.h:291
Definition: fs_signature.h:99
DialogDescriptionElement()
Constructor.
Definition: fs_actioncallback.h:487
SearchOption()
Constructor.
Definition: fs_actioncallback.h:1825
Definition: fx_coordinates.h:30
int char_height
Specifies the height of the element in characters.
Definition: fs_actioncallback.h:640
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
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
JSFieldValueChangeType
Enumeration for javascript field value change type.
Definition: fs_actioncallback.h:2237
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Window position: at the top center.
Definition: fs_actioncallback.h:1326
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
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
media player state: Suspend.
Definition: fs_actioncallback.h:2265
Booklet Duplex Mode: automatically prints both sides of the paper.
Definition: fs_actioncallback.h:1076
Application's forms version information.
Definition: fs_actioncallback.h:2207
SearchIndexConfig & operator=(const SearchIndexConfig &search_index_config)
Assign operator.
Definition: fs_actioncallback.h:2018
WString URL
Either URL or rendition is required, with URL taking precedence.
Definition: fs_actioncallback.h:1797
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
OffScreenAction
Enumeration for the action can be taken if the floating window is positioned totally or partially off...
Definition: fs_actioncallback.h:1378
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
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.
Dutch.
Definition: fs_actioncallback.h:2189
Definition: fs_actioncallback.h:1699
bool is_simulate_overprinting
true means to do overprint preview when printing. false means not.
Definition: fs_actioncallback.h:1257
javascript field value changed type: field set read-only property.
Definition: fs_actioncallback.h:2245
Word matching: match phrase.
Definition: fs_actioncallback.h:1816
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
int char_height
The height of the dialog box in characters.
Definition: fs_actioncallback.h:789
bool is_search_doc_text
Specifies whether the document text is searched for the query. Defaule value: true.
Definition: fs_actioncallback.h:1977
int height
The height of the dialog box in pixels.
Definition: fs_actioncallback.h:775
German.
Definition: fs_actioncallback.h:2175
Search scope: active document.
Definition: fs_actioncallback.h:2305
SOAPRequestProperties()
Constructor.
Definition: fs_actioncallback.h:860
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
Danish.
Definition: fs_actioncallback.h:2173
Foxit namespace.
Definition: fs_taggedpdf.h:27
virtual void EnablePageLoop(bool is_loop)=0
A callback function to set the flag specifies whether the document will loop around to the beginning ...
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.
FloatingInfo & operator=(const FloatingInfo &floating_info)
Assign operator.
Definition: fs_actioncallback.h:1436
pdf::PDFDoc doc
The PDFDoc object of the document.
Definition: fs_actioncallback.h:1780
SearchScope
Enumeration for search scope.
Definition: fs_actioncallback.h:2303
Definition: fs_action.h:65
Search scope: folder.
Definition: fs_actioncallback.h:2307
uint32 status_code
Status code of the response.
Definition: fs_actioncallback.h:1035
WString login_name
The login name. Usually, this is the name used to log in current operating system.
Definition: fs_actioncallback.h:285
English.
Definition: fs_actioncallback.h:2177
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
virtual MenuListArray GetMenuItemNameList()=0
A callback function to get the menu item name list.
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
bool bold
Specify if the font is bold.
Definition: fs_actioncallback.h:653
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
WString password
A string containing the password to use for authentication.
Definition: fs_actioncallback.h:844
PrintHandling
Enumeration for the values used to determine how the multiple pages are laid out on the sheet.
Definition: fs_actioncallback.h:1127
WString first_name
The user first name.
Definition: fs_actioncallback.h:289
virtual MenuItemEx PopupMenuEx(const MenuItemExArray &menus, bool &is_selected_item)=0
A callback function to pop up a menu window.
SOAPAuthenticateInfo()
Constructor.
Definition: fs_actioncallback.h:802
virtual foxit::pdf::Destination::ZoomMode GetPageZoomMode()=0
A callback function to get the current page zoom mode.
String font
The font to use for this element.
Definition: fs_actioncallback.h:651
Word matching: match any word.
Definition: fs_actioncallback.h:1820
Layout mode: single page.
Definition: fs_actioncallback.h:2275
PlayerArgs & operator=(const PlayerArgs &player_args)
Assign operator.
Definition: fs_actioncallback.h:1743
virtual WString GetFilePath(const pdf::PDFDoc &document)=0
A callback function to get the file path of current PDF document.
bool is_case_sensitive
Specifies whether the search query is case sensitive. Defaule value: false.
Definition: fs_actioncallback.h:1943
WString email
The email address.
Definition: fs_actioncallback.h:283
virtual void CloseDoc(const pdf::PDFDoc &document, bool is_prompt_to_save)=0
A callback function to close document.
virtual int GetCurrentPage(const pdf::PDFDoc &document)=0
A callback function used to receive current page index.
BookletDuplexMode
Enumeration for the values used to determine the duplex printing mode when printing a booklet.
Definition: fs_actioncallback.h:1074
WString soap_namespace
A namespace for the message schema when the request does not use the SOAP Encoding.
Definition: fs_actioncallback.h:958
Application's viewer variation information.
Definition: fs_actioncallback.h:2211
JSMediaPlayerState
Enumeration for media player state.
Definition: fs_actioncallback.h:2255
DialogDescriptionConfig & operator=(const DialogDescriptionConfig &dlg_des_config)
Assign operator.
Definition: fs_actioncallback.h:715
Definition: fs_actioncallback.h:1315
Header file for PDF document related definitions and classes.
Japanese.
Definition: fs_actioncallback.h:2187
bool italic
Specify if the font is italic.
Definition: fs_actioncallback.h:655
bool has_close
true means the floating window should have a close window control button, while false means not.
Definition: fs_actioncallback.h:1493
Mailed data type: form.
Definition: fs_actioncallback.h:2227
bool is_wiredump
Whether to output debug information for SOAP requests and responses, defaults to true.
Definition: fs_actioncallback.h:969
MailType
Enumeration for data type to be mailed.
Definition: fs_actioncallback.h:2223
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
Italian.
Definition: fs_actioncallback.h:2183
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 ...
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.
virtual WString GetAttachmentsFilePath(const pdf::PDFDoc &pdf_doc, const wchar_t *name)=0
A callback function to get the file path of attachments file.
WindowPosition
Enumeration for the window position used for media player.
Definition: fs_actioncallback.h:1322
Definition: fx_coordinates.h:771
virtual MediaPlayerCallback * OpenMediaPlayer(const PlayerArgs &player_args)=0
A callback function to open media player.
DialogDescriptionElementArray element_array
An array of object literals that describe the subelements of this dialog box element.
Definition: fs_actioncallback.h:661
Booklet Binding: Left-side binding for Western-style left-to-right reading direction....
Definition: fs_actioncallback.h:1090
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
OffScreenAction off_screen
Specify what action should be taken if the floating window is positioned totally or partially offscre...
Definition: fs_actioncallback.h:1505
Window position: at the top left corner.
Definition: fs_actioncallback.h:1324
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
Definition: fs_pdfdoc.h:610
DialogDescriptionConfig()
Constructor.
Definition: fs_actioncallback.h:668
pdf::Rendition rendition
A pdf::Rendition object (either a MediaRendition or a RenditionList).
Definition: fs_actioncallback.h:1794
Print Handling: Small or normal pages are printed in the original size and large pages are printed on...
Definition: fs_actioncallback.h:1140
PrintParams & operator=(const PrintParams &print_params)
Assign operator.
Definition: fs_actioncallback.h:1210
Duplex type: prints on both sides of the paper; the paper flips along the long edge.
Definition: fs_actioncallback.h:1064
Window position: at the bottom left corner.
Definition: fs_actioncallback.h:1336
Layout mode: continuous two pages.
Definition: fs_actioncallback.h:2281
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:72
int char_width
The width of the dialog box in characters.
Definition: fs_actioncallback.h:782
Window position: at the center.
Definition: fs_actioncallback.h:1332
String name
The displayed name of the dialog box element.
Definition: fs_actioncallback.h:609
Finnish.
Definition: fs_actioncallback.h:2195
MediaSettings player_settings
A MediaSettings object.
Definition: fs_actioncallback.h:1803
Mailed result: user abort.
Definition: fs_actioncallback.h:2295
Relative type: align the floating window relative to the (selected) monitor display screen.
Definition: fs_actioncallback.h:1356
Search scope: active indexes.
Definition: fs_actioncallback.h:2311
Print Handling: Prints multiple pages on the same sheet of paper in the order required to read correc...
Definition: fs_actioncallback.h:1142
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
IdentityProperties(const IdentityProperties &id_properities)
Constructor, with another identity properties object.
Definition: fs_actioncallback.h:244
Mailed data type: string message.
Definition: fs_actioncallback.h:2229
Window position: at the top right corner.
Definition: fs_actioncallback.h:1328
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
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
Application's app version information.
Definition: fs_actioncallback.h:2215
virtual WString GetAppInfo(AppInfoType type)=0
A callback function to get application information.
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...
Definition: fs_basictypes.h:228
Off screen action: take no action.
Definition: fs_actioncallback.h:1380
media player state: Open.
Definition: fs_actioncallback.h:2257
String type
The type of this dialog box element.
Definition: fs_actioncallback.h:613
Duplex type: prints on both sides of the paper; the paper flips along the short edge.
Definition: fs_actioncallback.h:1066
Definition: fs_actioncallback.h:665
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
WString path
The path of the search index.
Definition: fs_actioncallback.h:2052
ResizeType
Enumeration for the resize type, which specifies whether a floating window may be resized by the user...
Definition: fs_actioncallback.h:1364
Word matching: match all words.
Definition: fs_actioncallback.h:1818
String next_tab
An ItemID for the next dialog box item in the tab order.
Definition: fs_actioncallback.h:615
String first_tab
An ItemID for the dialog box item that should be first in the tab order.
Definition: fs_actioncallback.h:761
Mailed data type: document.
Definition: fs_actioncallback.h:2225
DialogDescriptionConfig(const DialogDescriptionConfig &dlg_des_config)
Constructor, with another dialog description config object.
Definition: fs_actioncallback.h:698
bool is_search_in_attachments
Specifies whether any PDF file attachments should be searched along with the base document....
Definition: fs_actioncallback.h:1949
WString name
The name of search index.
Definition: fs_actioncallback.h:2043
media player state: Close.
Definition: fs_actioncallback.h:2259
Definition: fs_actioncallback.h:1981
Definition: fs_actioncallback.h:980
PlayerArgs()
Constructor.
Definition: fs_actioncallback.h:1702
virtual bool IsLocalFile(const pdf::PDFDoc &document)=0
A callback function to check whether the file is local file.
Spanish.
Definition: fs_actioncallback.h:2179
DialogDescriptionElementArray element_array
An array of dialog description element array object.
Definition: fs_actioncallback.h:795
virtual bool ExecuteNamedAction(const pdf::PDFDoc &document, const char *named_action)=0
A callback function to execute a named action.
bool is_use_platform_auth
A Boolean value indicating that platform authentication should be used.
Definition: fs_actioncallback.h:853
Swedish.
Definition: fs_actioncallback.h:2197
WString title
This title to be displayed if has_title is true.
Definition: fs_actioncallback.h:1499
String item_id
An ItemID for this dialog box.
Definition: fs_actioncallback.h:611
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
virtual LayoutMode GetLayoutMode()=0
A callback function to get the page layout of the current document.
PrintContent
Enumeration for the values used to set the contents of the print job.
Definition: fs_actioncallback.h:1046
WIDE STRING CLASS.
Definition: fx_string.h:1452
virtual void SetFullScreen(bool is_full_screen)=0
A callback function to set full screen mode.
SOAPAuthenticateInfo(const wchar_t *username, const wchar_t *password, bool is_use_platform_auth)
Constructor, with parameters.
Definition: fs_actioncallback.h:811
virtual uint32 VerifySignature(const pdf::PDFDoc &document, const pdf::Signature &pdf_signature)=0
A callback function to verify specified signature..
Definition: fs_common.h:1236
Definition: fs_image.h:36
javascript field value changed type: field fill color.
Definition: fs_actioncallback.h:2247
float tile_overlap
The number of points that tiled pages have in common.
Definition: fs_actioncallback.h:1287
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 ...
String alignment
The alignment for this element.
Definition: fs_actioncallback.h:657
virtual pdf::PDFDoc CreateBlankDoc()=0
A callback function to create a blank PDF document object.
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.
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
FloatingInfo(const FloatingInfo &floating_info)
Constructor, with another floating infomation object.
Definition: fs_actioncallback.h:1419
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
virtual bool RemoveSearchIndex(const SearchIndexConfig &search_index_config)=0
(Reserved, unsupported yet) A callback function to remove a search index.
Definition: fs_actioncallback.h:1039
Language
Enumeration for language.
Definition: fs_actioncallback.h:2165
virtual bool AddToolButton(const ButtonItem &button_item)=0
A callback function to add a tool button.
Application's viewer type information.
Definition: fs_actioncallback.h:2209
Window position: at the bottom right corner.
Definition: fs_actioncallback.h:1340
IdentityProperties()
Constructor.
Definition: fs_actioncallback.h:214
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
PlayerArgs(const PlayerArgs &player_args)
Constructor, with another player args object.
Definition: fs_actioncallback.h:1728
Booklet Duplex Mode: only prints all pages that appear on the back side of the paper.
Definition: fs_actioncallback.h:1080
virtual WString GetTemporaryDirectory()=0
A callback function to get temporary directory.
SearchIndexConfig(const SearchIndexConfig &search_index_config)
Constructor, with another search index config object.
Definition: fs_actioncallback.h:2005
int num_copies
The number of copies to be printed.
Definition: fs_actioncallback.h:1276
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.
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
WString printer_name
The default printer name for printing.
Definition: fs_actioncallback.h:1272
SOAPResponseInfo()
Constructor.
Definition: fs_actioncallback.h:983
String align_children
The alignment for all descendants.
Definition: fs_actioncallback.h:659
virtual WStringArray GetPrinterNameList()=0
A callback function to get the printer name list.
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.
SearchIndexConfig(WString name, bool is_available, WString path, bool is_selected)
Constructor, with parameters.
Definition: fs_actioncallback.h:1994
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
int char_width
Specifies the width of the element in characters.
Definition: fs_actioncallback.h:634
@2024 Foxit Software Incorporated. All rights reserved.