Public Member Functions

<XAP_CocoaPlugin_FramelessDocument> Protocol Reference

Plug-in API for manipulating documents which do not have windows. More...

#import <xap_CocoaPlugin.h>

Inheritance diagram for <XAP_CocoaPlugin_FramelessDocument>:
AP_CocoaPlugin_FramelessDocument

List of all members.

Public Member Functions

(BOOL) - exportDocumentToFile:exportOptions:
 Save the document in the document file format suggested by the path's extension (e.g., .html, .txt).

Detailed Description

Plug-in API for manipulating documents which do not have windows.

Typically these loaded from a file. See XAP_CocoaPlugin's importDocumentFromFile:importOptions: method.


Member Function Documentation

- (BOOL) exportDocumentToFile: (NSString *)  path
exportOptions: (NSDictionary *)  options 

Save the document in the document file format suggested by the path's extension (e.g., .html, .txt).

Parameters:
path The output file path. This should have an appropriate extension.
options A dictionary mapping of NSString keys to NSString values; these options are passed to the exporter. May be nil.
Returns:
Returns YES on success, NO on failure.

Reimplemented in AP_CocoaPlugin_FramelessDocument.


The documentation for this protocol was generated from the following file: