Foxit PDF SDK
|
Inherits <NSObject>.
Instance Methods | |
(int) | - alert:title:type:icon: |
A callback function used to pop up a dialog to show warnings or hints. More... | |
(BOOL) | - beep: |
A callback function to cause the system to play a sound. More... | |
(NSString *) | - browseFile |
A callback function to show a file selection dialog, and the selected file path should be returned. More... | |
(NSString *) | - browseFile:file_format:file_filter: |
A callback function to show a file selection dialog. More... | |
(FSPDFDoc *) | - createBlankDoc |
A callback function to create a blank PDF document object. More... | |
(BOOL) | - executeNamedAction:named_action: |
A callback function to execute a named action. More... | |
(NSString *) | - getAppInfo: |
A callback function to get application information. More... | |
(FSPDFDoc *) | - getCurrentDoc |
A callback function to receive current PDF document object. 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... | |
(NSString *) | - getFilePath: |
A callback function to get the file path of current PDF document. More... | |
(FSIdentityProperties *) | - getIdentityProperties |
A callback function used to get identity properties of current user. More... | |
(FSActionCallbackLanguage) | - getLanguage |
A callback function to get the language of the running viewer application. More... | |
(FSPDFDoc *) | - getOpenedDoc: |
A callback function to receive an opened PDF document object by index. More... | |
(int) | - getOpenedDocCount |
A callback function to receive the count of opened documents. More... | |
(FSRotation) | - getPageRotation:page_index: |
A callback function used to receive current displaying rotation of a page on PDF viewer. More... | |
(BOOL) | - invalidateRect:page_index:pdf_rect: |
A callback function to invalidate the client area within the specified rectangle. More... | |
(BOOL) | - launchURL: |
A callback function to launch to a specified URL. More... | |
(BOOL) | - mailData:data_type:is_ui:to:subject:cc:bcc:message: |
A callback function to mail data or message, with or without user interaction. More... | |
(BOOL) | - openDoc:password: |
A callback function to open a PDF file. More... | |
(NSString *) | - popupMenu: |
A callback function to pop up a menu window. More... | |
(BOOL) | - print:is_ui:page_range:is_silent:is_shrunk_to_fit:is_printed_as_image:is_reversed:is_to_print_annots: |
A callback function to print pages within a specified index range. More... | |
(NSString *) | - response:title:default_value:label:is_password: |
A callback function to display a dialog box containing a question and an entry field for the user to reply to the question. More... | |
(void) | - setCurrentPage:page_index: |
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:page_index:rotation: |
A callback function used to set the rotation value of a page on PDF viewer. More... | |
(BOOL) | - submitForm:form_data:url: |
A callback function to submit the form data to a specified URL. More... | |
(unsigned int) | - verifySignature:pdf_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 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 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:
|
|
required |
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.
|
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 | Whether is open or saving dialog, true means open dialog and false means saving dialog. |
[in] | file_format | The file format string. |
[in] | file_filter | The file filter string. |
|
required |
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.
|
required |
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. |
|
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 FSActionCallbackAppInfoTypeViewerVersion, FSActionCallbackAppInfoTypeAppVersion and FSActionCallbackAppInfoTypeFormsVersion, please use string to represent it.
[in] | type | Type of information. Please refer to values starting from FSActionCallbackAppInfoTypeFormsVersion and this would be one of these macros. |
|
required |
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.
|
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] | document | 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 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. |
|
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 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.
|
required |
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 FSActionCallback::getOpenedDocCount |
|
required |
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.
|
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] | 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. |
|
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 FSRenderer::startRender:matrix:pause: 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. |
|
required |
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. |
|
required |
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 | Pointer to 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 FSActionCallbackMailTypeDoc and this would be one of these values. |
[in] | is_ui | YES means that the remaining parameters are used to seed the compose-new-message window which is displayed to the user. NO 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. |
|
required |
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. |
|
required |
A callback function to pop up a menu window.
The position of menu window is 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 object. |
|
required |
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 | YES 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 | YES means that the cancel dialog box should be suppressed while the document is printing. |
[in] | is_shrunk_to_fit | YES means that the page should be shrunk (if necessary) to fit within the area of the printed page. |
[in] | is_printed_as_image | YES means that pages should be printed as image. |
[in] | is_reversed | YES means that the printing order should be from parameter end to parameter start. |
[in] | is_to_print_annots | YES means that annotations should be printed with page. |
|
required |
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: YES means that the user's response should show as asterisks (*) or bullets (?) to mask the response, which might be sensitive information. |
|
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] | 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. |
|
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] | 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 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 | Pointer to a form data buffer which is to be submit. |
[in] | url | A URL, to which the form data will be submit. |
|
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 FSSignatureStateUnknown. User is recommended to use class FSLTVVerifier 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 paramter document. |