Foxit PDF SDK
|
Public Member Functions | |
virtual bool | AddMenuItem (const MenuItemConfig &menu_item_config, bool is_prepend)=0 |
A callback function to adds a menu item to a menu. More... | |
virtual bool | AddSubMenu (const MenuItemConfig &menu_item_config)=0 |
A callback function to add a menu item with a submenu to the application. More... | |
virtual bool | AddToolButton (const ButtonItem &button_item)=0 |
A callback function to add a tool button. More... | |
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. More... | |
virtual bool | Beep (int type)=0 |
A callback function to cause the system to play a sound. More... | |
virtual WString | BrowseFile ()=0 |
A callback function to show a file selection dialog, and the selected file path should be returned. More... | |
virtual WString | BrowseFile (bool is_open_dialog, const wchar_t *file_format, const wchar_t *file_filter)=0 |
A callback function to show a file selection dialog. More... | |
virtual void | CloseDoc (const pdf::PDFDoc &document, bool is_prompt_to_save)=0 |
A callback function to close document. More... | |
virtual pdf::PDFDoc | CreateBlankDoc ()=0 |
A callback function to create a blank PDF document object. More... | |
virtual bool | ExecuteNamedAction (const pdf::PDFDoc &document, const char *named_action)=0 |
A callback function to execute a named action. More... | |
virtual WString | GetAppInfo (AppInfoType type)=0 |
A callback function to get application information. More... | |
virtual WString | GetAttachmentsFilePath (const pdf::PDFDoc &pdf_doc, const wchar_t *name)=0 |
A callback function to get the file path of attachments file. More... | |
virtual pdf::PDFDoc | GetCurrentDoc ()=0 |
A callback function to receive current PDF document object. More... | |
virtual int | GetCurrentPage (const pdf::PDFDoc &document)=0 |
A callback function used to receive current page index. More... | |
virtual bool | GetDocChangeMark (const pdf::PDFDoc &document)=0 |
A callback function to receive the change mark which indicates whether the content of document is changed or not. More... | |
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. More... | |
virtual WString | GetFilePath (const pdf::PDFDoc &document)=0 |
A callback function to get the file path of current PDF document. More... | |
virtual bool | GetFullScreen ()=0 |
A callback function to get whether the full screen mode is set. More... | |
virtual IdentityProperties | GetIdentityProperties ()=0 |
A callback function used to get identity properties of current user. More... | |
virtual Language | GetLanguage ()=0 |
A callback function to get the language of the running viewer application. More... | |
virtual LayoutMode | GetLayoutMode ()=0 |
A callback function to get the page layout of the current document. More... | |
virtual MenuListArray | GetMenuItemNameList ()=0 |
A callback function to get the menu item name list. More... | |
virtual PointF | GetMousePosition ()=0 |
A callback function to get current mouse position. More... | |
virtual pdf::PDFDoc | GetOpenedDoc (int index)=0 |
A callback function to receive an opened PDF document object by index. More... | |
virtual int | GetOpenedDocCount ()=0 |
A callback function to receive the count of opened documents. More... | |
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. More... | |
virtual float | GetPageScale ()=0 |
A callback function to get current page zoom value. More... | |
virtual RectF | GetPageWindowRect ()=0 |
A callback function to get the rectangle for the page view window. The page view window is the area inside the inner document window in which the PDF content is displayed. More... | |
virtual foxit::pdf::Destination::ZoomMode | GetPageZoomMode ()=0 |
A callback function to get the current page zoom mode. More... | |
virtual WStringArray | GetPrinterNameList ()=0 |
A callback function to get the printer name list. More... | |
virtual WString | GetTemporaryDirectory ()=0 |
A callback function to get temporary directory. More... | |
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 with the file suffix name. More... | |
virtual WString | GetUntitledBookmarkName ()=0 |
A callback function to get the new name for an untitled bookmark. More... | |
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. More... | |
virtual bool | IsLocalFile (const pdf::PDFDoc &document)=0 |
A callback function to check whether the file is local file. More... | |
virtual bool | LaunchURL (const char *url)=0 |
A callback function to launch to a specified URL. More... | |
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. More... | |
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. More... | |
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. More... | |
virtual bool | OpenDoc (const WString &file_path, const WString &password)=0 |
A callback function to open a PDF file. More... | |
virtual MediaPlayerCallback * | OpenMediaPlayer (const PlayerArgs &player_args)=0 |
A callback function to open media player. More... | |
virtual WString | PopupMenu (const MenuListArray &menus, bool &is_selected_item)=0 |
A callback function to pop up a menu window. More... | |
virtual MenuItemEx | PopupMenuEx (const MenuItemExArray &menus, bool &is_selected_item)=0 |
A callback function to pop up a menu window. More... | |
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. More... | |
virtual bool | Print (const pdf::PDFDoc &document, const PrintParams &print_params)=0 |
A callback function to print document with print parameters. More... | |
virtual void | Release ()=0 |
A callback function used to release current callback object itself. More... | |
virtual bool | RemoveToolButtom (const wchar_t *button_name)=0 |
A callback function to remove a tool button added by the function ActionCallback::AddToolButton. More... | |
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 reply to the question. More... | |
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 view. More... | |
virtual void | SelectPageNthWord (int page_index, int word_index, bool is_show_selection)=0 |
A callback function to change the current page number and selects the specified word on the page. More... | |
virtual void | SetCurrentPage (const pdf::PDFDoc &document, int page_index)=0 |
A callback function used to set the current page by index. More... | |
virtual void | SetCurrentPage (const pdf::PDFDoc &document, const foxit::pdf::Destination &destination)=0 |
A callback function used to set the current page by destination. More... | |
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 or not. More... | |
virtual void | SetFullScreen (bool is_full_screen)=0 |
A callback function to set full screen mode. More... | |
virtual bool | SetIdentityProperties (const IdentityProperties &identity_properties)=0 |
A callback function used to set identity properties of current user. More... | |
virtual void | SetLayoutMode (LayoutMode layout_mode, bool is_cover_mode)=0 |
A callback function to set the page layout of the current document. More... | |
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. More... | |
virtual void | SetPageScale (foxit::pdf::Destination::ZoomMode zoom_mode, const foxit::pdf::Destination &dest)=0 |
A callback function to set current page zoom value. More... | |
virtual bool | ShowDialog (const DialogDescriptionConfig &dlg_config)=0 |
A callback function to show the dialog. More... | |
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. More... | |
virtual void | UpdateLogicalLabel ()=0 |
A callback function to update logical label. More... | |
virtual uint32 | VerifySignature (const pdf::PDFDoc &document, const pdf::Signature &pdf_signature)=0 |
A callback function to verify specified signature.. More... | |
This class represents a callback object for performing PDF actions. All the pure virtual functions in this class are used as callback functions and should be implemented by user, to perform PDF actions, such as javascript actions.
Enumeration for application's information type.
Values of this enumeration should be used alone.
Enumeration for javascript field value change type.
Values of this enumeration should be used alone.
Enumeration for media player state.
Values of this enumeration should be used alone.
Enumeration for language.
Values of this enumeration should be used alone.
|
pure virtual |
A callback function to adds a menu item to a menu.
This callback function will be triggered by the javascript method "app.addMenuItem".
[in] | menu_item_config | The config of the menu item. |
[in] | is_prepend | Determines the position of the new menu item relative to the position specified by MenuItemConfig::pos or MenuItemConfig::pos_str. The default value is false. If this parameter is true, the rules for insertion are as follows:
|
|
pure virtual |
A callback function to add a menu item with a submenu to the application.
This callback function will be triggered by the javascript method "app.addSubMenu".
[in] | menu_item_config | The config of the menu item. |
|
pure virtual |
A callback function to add a tool button.
This callback function will be triggered by the javascript method "app.addToolButton".
[in] | button_item | The ButtonItem object of the tool button. |
|
pure virtual |
A callback function used to pop up a dialog to show warnings or hints.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | msg | The message string to be displayed in the dialog. |
[in] | title | The title of the dialog. |
[in] | type | Type of button group. It would be one of following values:
|
[in] | icon | Icon type. It would be one of following values:
|
|
pure virtual |
A callback function to cause the system to play a sound.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | type | Sound type. The value would be on of following values:
|
|
pure virtual |
A callback function to show a file selection dialog, and the selected file path should be returned.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to show a file selection dialog.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | is_open_dialog | A boolean value to specify whether the dialog is for opening file or saving file. true means the dialog should be used to open file, while false means the dialog should be used to save file. |
[in] | file_format | The file format string. |
[in] | file_filter | The file filter string. |
|
pure virtual |
A callback function to close document.
This callback function will be triggered by the javascript method "Doc.closeDoc". This callback function is optional, so it can be implemented to do nothing.
[in] | document | A PDF document object. It would be valid. |
[in] | is_prompt_to_save | true means show save prompt, while false means not. |
|
pure virtual |
A callback function to create a blank PDF document object.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to execute a named action.
Please refer to description of "Named Actions" in Section 8.5.3 of <PDF Reference 1.7> for more details. This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | named_action | A string to specify a named action. |
|
pure virtual |
A callback function to get application information.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
For the digital information like ActionCallback::e_AppInfoTypeViewerVersion, ActionCallback::e_AppInfoTypeAppVersion and ActionCallback::e_AppInfoTypeFormsVersion, please use string to represent it.
[in] | type | Type of information. Please refer to values starting from ActionCallback::e_AppInfoTypeFormsVersion and this would be one of these values. |
|
pure virtual |
A callback function to get the file path of attachments file.
This callback function will be triggered by the javascript method "Doc.importDataObject". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | pdf_doc | A PDF document object. It will embed with a data object. |
[in] | name | The name to associate with the data object. It's the parameter "cName" of the method "Doc.importDataObject". |
|
pure virtual |
A callback function to receive current PDF document object.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function used to receive current page index.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
pure virtual |
A callback function to receive the change mark which indicates whether the content of document is changed or not.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
pure virtual |
A callback function to get the file path of extracted embedded file.
This callback function will be triggered by the javascript method "Doc.exportDataObject". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | pdf_doc | A PDF document object. It will be embedded as a data object to the file . |
[in] | name | The name of the data object to extract. It's the parameter "cName" of the method "Doc.exportDataObject". |
|
pure virtual |
A callback function to get the file path of current PDF document.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
pure virtual |
A callback function to get whether the full screen mode is set.
This callback function will be triggered by the javascript property "app.fullScreen" or "app.fs.isFullScreen".
|
pure virtual |
A callback function used to get identity properties of current user.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the language of the running viewer application.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the page layout of the current document.
This callback function will be triggered by the javascript properties "Doc.layout". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the menu item name list.
This callback function will be triggered by the javascript method "app.listMenuItems".
|
pure virtual |
A callback function to get current mouse position.
This callback function will be triggered by the javascript properties "doc.mouseX" or "doc.mouseY". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to receive an opened PDF document object by index.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | index | The index of an opened PDF documents. Valid range: from 0 to count-1. count is returned by callback function ActionCallback::GetOpenedDocCount; |
|
pure virtual |
A callback function to receive the count of opened documents.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function used to receive current displaying rotation of a page on PDF viewer.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index, used to specify which page's rotation is to be retrieved. The index would start from 0 and less than page count of the specified document. |
|
pure virtual |
A callback function to get current page zoom value.
This callback function will be triggered by the javascript properties "Doc.zoom". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the rectangle for the page view window. The page view window is the area inside the inner document window in which the PDF content is displayed.
This callback function will be triggered by the javascript property "Doc.pageWindowRect". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the current page zoom mode.
This callback function will be triggered by the javascript properties "Doc.zoom" or "Doc.zoomType". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the printer name list.
This callback function will be triggered by the javascript property "app.printerNames". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get temporary directory.
This callback function will be triggered by the javascript method "Doc.extractpages". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to get the temporary file path. The temporary file name combine the document name with the file suffix name.
This callback function will be triggered by the javascript method "Doc.mailForm". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | file_suffix_name | File suffix name. |
|
pure virtual |
A callback function to get the new name for an untitled bookmark.
This callback function will be triggered by the javascript mothod "bookmark.createChild" when the parameter "cName" of the method is an empty string. This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to invalidate the client area within the specified rectangle.
All positions are measured in PDF "user space". Implementation should call function common::Renderer::StartRender for repainting a specified page area.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index. It would start from 0 and less than page count of the specified document. |
[in] | pdf_rect | A rectangle that specifies the page area in PDF coordinate system. If this is an empty rectangle, that means to refresh the whole page. |
|
pure virtual |
A callback function to check whether the file is local file.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
|
pure virtual |
A callback function to launch to a specified URL.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | url | A URL. |
|
pure virtual |
A callback function to mail data or message, with or without user interaction.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | data | A data which is to be mailed. The value and type of the data depends on parameter data_type:
|
[in] | data_type | Mail type. Please refer to values starting from ActionCallback::e_MailTypeDoc and this would be one of these values. |
[in] | is_ui | true means that the remaining parameters are used to seed the compose-new-message window which is displayed to the user. false means that the parameter to is required and all other parameters are optional. |
[in] | to | A string that specifies a semicolon-delimited list of recipients for the message. |
[in] | subject | A string that specifies the subject of the message. The limit of this string's length is 64 KB. |
[in] | cc | A string that specifies a semicolon-delimited list of CC recipients for the message. |
[in] | bcc | A string that specifies a semicolon-delimited list of BCC recipients for the message. |
[in] | message | A string that specifies the content of the message. The limit of this string's length is 64 KB. |
|
pure virtual |
A callback function to mails a document as an attachment.
This callback function will be triggered by the javascript method "Doc.mailDoc". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | to_address | To address. |
[in] | cc_address | Cc address. |
[in] | bcc_address | Bcc address. |
[in] | subject | Mail subject. |
[in] | message | Mail message. |
[in] | is_ui | true means to show mail dialog, while false means not. |
|
pure virtual |
A callback function to notify the value change of the field.
This callback function will be triggered when the field's value is changed via JavaScript.
[in] | field_name | A string that specifies the field name. |
[in] | type | Field value change type. Please refer to values starting from ActionCallback::e_JSFieldValueChangedByFormat and this would be one of these values. |
[in] | value_before_changed | A string array that specifies the field's value before the change. |
For a list box, the parameter represent one or more than one of the field's items which be selected simultaneously.
[in] | value_after_changed | A string array that specifies the field's value after the change. For a list box, the parameter represent one or more than one of the field's items which be selected simultaneously. |
|
pure virtual |
A callback function to open a PDF file.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | file_path | A full path of an existing PDF file. |
[in] | password | Password for input PDF file. This may be an empty string. |
|
pure virtual |
A callback function to open media player.
This callback function will be triggered by the javascript method "app.media.openPlayer" or "app.media.createPlayer".
[in] | player_args | The PlayerArgs object. |
|
pure virtual |
A callback function to pop up a menu window.
The position of menu window is the same as cursor's. This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | menus | An array of menu list objects. |
[out] | is_selected_item | Output parameter that receives the value of whether a menu item is selected or not. true means that the menu item is selected, while false means that the menu item is not selected. |
|
pure virtual |
A callback function to pop up a menu window.
The position of menu window is the same as cursor's. This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | menus | An array of MenuItemEx objects. |
[out] | is_selected_item | Output parameter that receives the value of whether a menu item is selected or not. true means that the menu item is selected, while false means that the menu item is not selected. |
|
pure virtual |
A callback function to print pages within a specified index range.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | is_ui | true means that a UI should be presented to the user to obtain printing information and confirm the action. |
[in] | page_range | A range object to specify the page range for printing. All the indexes represented in this range would start from 0 and less than page count of the specified document. |
[in] | is_silent | true means that the cancel dialog box should be suppressed while the document is printing. |
[in] | is_shrunk_to_fit | true means that the page should be shrunk (if necessary) to fit within the area of the printed page. |
[in] | is_printed_as_image | true means that pages should be printed as image. |
[in] | is_reversed | true means that the printing order should be from parameter end to parameter start. |
[in] | is_to_print_annots | true means that annotations should be printed with page. |
|
pure virtual |
A callback function to print document with print parameters.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | print_params | A PrintParams object. |
|
pure virtual |
A callback function used to release current callback object itself.
|
pure virtual |
A callback function to remove a tool button added by the function ActionCallback::AddToolButton.
This callback function will be triggered by the javascript method "app.removeToolButton".
[in] | button_name | The name of the tool button. |
|
pure virtual |
A callback function to display a dialog box containing a question and an entry field for the user to reply to the question.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | question | A string that specifies the question to be posed to the user. |
[in] | title | A string that specifies the title of the dialog box. |
[in] | default_value | A string that specifies a default value as the answer to the question. If the answer is not specified, no default value is presented. |
[in] | label | A string that specifies a short string to appear in front of the edit text field. |
[in] | is_password | A boolean value that indicates whether user's response should be masked to show: true means that the user's response should show as asterisks (*) or bullets (?) to mask the response, which might be sensitive information. |
|
pure virtual |
A callback function to scroll the specified point on the current page into the middle of the current view.
This callback function will be triggered by the javascript method "Doc.scroll". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | point | The specified point[PDF coordinate system]. |
|
pure virtual |
A callback function to change the current page number and selects the specified word on the page.
This callback function will be triggered by the javascript method "Doc.selectPageNthWord". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | page_index | The page index. |
[in] | word_index | The word index. |
[in] | is_show_selection | true means to show selection, while false means not. |
|
pure virtual |
A callback function used to set the current page by index.
This callback function is optional, so it can be implemented to do nothing.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index which is used to change current page. The index would start from 0 and less than page count of the specified document. |
|
pure virtual |
A callback function used to set the current page by destination.
This callback function is optional, so it can be implemented to do nothing.
[in] | document | A PDF document object. It would be valid. |
[in] | destination | A object. None. |
|
pure virtual |
A callback function to set the change mark which indicates whether the content of document is changed or not.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | change_mark | A boolean value that indicates whether the content of document is changed or not. |
|
pure virtual |
A callback function to set full screen mode.
This callback function will be triggered when the javascript property "app.fullScreen" or "app.fs.isFullScreen" is to be set.
[in] | is_full_screen | true means to set full screen mode, while false means not. |
|
pure virtual |
A callback function used to set identity properties of current user.
This callback function is optional, so it can be implemented to do nothing.
[in] | identity_properties | An identity properties object used to be set. |
|
pure virtual |
A callback function to set the page layout of the current document.
This callback function will be triggered by the javascript properties "Doc.layout". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | layout_mode | The layout mode. Please refer to values starting from ActionCallback::e_LayoutModeSinglePage and this should be one of these values. |
[in] | is_cover_mode | true means that the cover will always displayed separately, while false means not. |
|
pure virtual |
A callback function used to set the rotation value of a page on PDF viewer.
This callback function is optional, so it can be implemented to do nothing.
[in] | document | A PDF document object. It would be valid. |
[in] | page_index | A page index, used to specify which page's rotation is to be changed. The index would start from 0 and less than page count of the specified document. |
[in] | rotation | New rotation value. Please refer to values starting from common::e_Rotation0 and this should be one of these values except common::e_RotationUnknown. |
|
pure virtual |
A callback function to set current page zoom value.
This callback function will be triggered by the javascript properties "Doc.zoom" or "Doc.zoomType". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | zoom_mode | The zoom mode. Please refer to values starting from pdf::Destination::e_ZoomXYZ and this should be one of these values. |
[in] | dest | A pdf::Destination object that represents destination data. |
|
pure virtual |
A callback function to show the dialog.
This callback function will be triggered by the javascript method "app.execDialog".
[in] | dlg_config | The DialogDescriptionConfig object. |
|
pure virtual |
A callback function to submit the form data to a specified URL.
This callback function is optional, so it can be implemented to do nothing and just return a useless value.
[in] | document | A PDF document object. It would be valid. |
[in] | form_data | A form data buffer which is to be submitted. |
[in] | length | The size (in bytes) of the buffer parameterform_data. |
[in] | url | A URL, to which the form data will be submitted. |
[in] | file_format_type | File format type for submission form. Please refer to values starting from foxit::common::e_FileFormatTypeFDF and this would be one of these values. |
|
pure virtual |
A callback function to update logical label.
This callback function will be triggered by the javascript method "Doc.setPageLabels". This callback function is optional, so it can be implemented to do nothing and just return a useless value.
|
pure virtual |
A callback function to verify specified signature..
This callback function will be triggered when a signature is to be verified by an action. If user does not want to verify the signature, just implement this function to do nothing and just return pdf::Signature::e_StateUnknown. User is recommended to use class pdf::LTVVerifier to verify if a signed signature is valid or not.
[in] | document | A PDF document object. It would be valid. |
[in] | pdf_signature | A PDF signature which is signed. This signature belongs to input parameter document. |