Foxit PDF SDK
9.1
|
Instance Methods | |
(FSSearchIndexConfig *) | - addSearchIndex:is_selected: |
A callback function to add a search index. More... | |
(int) | - alert:title:type:icon: |
A callback function used to pop up a dialog to show warnings or hints. More... | |
(NSString *) | - browseFile:file_format:file_filter: |
A callback function to show a file selection dialog. More... | |
(NSString *) | - getAppInfo: |
A callback function to get application information. More... | |
(int) | - getCurrentPage: |
A callback function used to receive current page index. More... | |
(BOOL) | - getDocChangeMark: |
A callback function to receive the change mark which indicates whether the content of document is changed or not. More... | |
(FSIdentityProperties *) | - getIdentityProperties |
A callback function used to get identity properties of current user. More... | |
(NSString *) | - GetJapaneseEras:month:day: |
A callback function to get the Japanese ear name. More... | |
(FSRotation) | - getPageRotation:pageIndex: |
A callback function used to receive current displaying rotation of a page on PDF viewer. More... | |
(NSArray< NSString * > *) | - getSignatureAPStyleNameList |
A callback function to get the name list of signature appearance style. More... | |
(BOOL) | - invalidateRect:page_index:pdf_rect: |
A callback function to invalidate the client area within the specified rectangle. More... | |
(void) | - query:search_scope:search_option:di_path: |
A callback function to query the text keywords. More... | |
(BOOL) | - removeSearchIndex: |
(Reserved, unsupported yet) A callback function to remove a search index. More... | |
(void) | - setCurrentPage:destination: |
A callback function used to set the current page by destination. More... | |
(void) | - setCurrentPage:pageIndex: |
A callback function used to set the current page by index. More... | |
(BOOL) | - setDocChangeMark:change_mark: |
A callback function to set the change mark which indicates whether the content of document is changed or not. More... | |
(BOOL) | - setPageRotation:pageIndex:rotation: |
A callback function used to set the rotation value of a page on PDF viewer. More... | |
(BOOL) | - submitForm:formData:url:file_format_type: |
A callback function to submit the form data to a specified URL. More... | |
(unsigned int) | - verifySignature:signature: |
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.
|
required |
A callback function to add a search index.
This callback function will be triggered by the javascript method "search.addIndex". This callback function is optional, so it can be implemented to do nothing.
[in] | di_path | A device-independent path to an index file on the user's hard drive. |
[in] | is_selected | Specifies whether the index should be selected for searching. Default value: true. |
|
required |
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:
|
|
required |
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. |
|
required |
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. |
|
required |
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] | pdfDoc | A PDF document object. It would be valid. |
|
required |
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. |
|
required |
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.
|
required |
A callback function to get the Japanese ear name.
This callback function will be triggered by the javascript method “AnnotActionHandler.GetJapaneseEras". This callback function is optional, so it can be implemented to do nothing.
[in] | year | Designated year. |
[in] | month | Designated month. |
[in] | day | Designated day. |
|
required |
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] | pdfDoc | A PDF document object. It would be valid. |
[in] | pageIndex | 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. |
|
required |
A callback function to get the name list of signature appearance style.
This callback function will be triggered by the javascript method "SecurityHandler.appearances". This callback function is optional, so it can be implemented to do nothing.
|
required |
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. |
|
required |
A callback function to query the text keywords.
This callback function will be triggered by the javascript method "search.query". This callback function is optional, so it can be implemented to do nothing.
[in] | keywords | The text content for which to search. |
[in] | search_scope | Specifies where the text should be searched. Please refer to values starting from ActionCallback::e_SearchScopeActiveDoc and this should be one of these values. |
[in] | search_option | A SearchOption object that represents search option. |
[in] | di_path | A device-independent path to a folder or search index on the user's computer. This parameter is optional. When search_scope is ActionCallback::e_SearchScopeFolder or ActionCallback::e_SearchScopeIndex, this parameter is required. |
|
required |
(Reserved, unsupported yet) A callback function to remove a search index.
This callback function will be triggered by the javascript method "search.removeIndex". This callback function is optional, so it can be implemented to do nothing.
[in] | search_index_config | A SearchIndexConfig that represents the search index config. |
|
required |
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. |
|
required |
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] | pdfDoc | A PDF document object. It would be valid. |
[in] | pageIndex | 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. |
|
required |
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. |
|
required |
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] | pdfDoc | A PDF document object. It would be valid. |
[in] | pageIndex | 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 FSRotation0 and this would be one of these values except FSRotationUnknown. |
|
required |
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. |
|
required |
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] | signature | A PDF signature which is signed. This signature belongs to input paramter document. |