InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CInCopyStoryExportSuite Class Reference
Inheritance diagram for CInCopyStoryExportSuite:
CExportProviderCPMUnknown< IExportProvider >IExportProviderIPMUnknown

Public Member Functions

 CInCopyStoryExportSuite (IPMUnknown *boss)
 
virtual bool16 CanExportToFile () const
 
virtual bool16 CanExportThisFormat (IDocument *doc, IPMUnknown *targetboss, const PMString &formatName)
 
virtual PMString GetNthFormatName (int32 n)
 
virtual int32 CountFormats ()
 
virtual PMString GetExtensionForFormatName (const PMString &formatName)
 
virtual ScriptID GetScriptIDForFormatName (const PMString &formatName, const ScriptInfo::RequestContext &context)
 
virtual void ExportToFile (const IDFile &sysFile, IDocument *doc, IPMUnknown *targetboss, const PMString &formatName, UIFlags uiFlags=kFullUI)
 
virtual void ExportToStream (IPMStream *stream, IDocument *doc, IPMUnknown *targetboss, const PMString &formatName, UIFlags uiFlags=kFullUI)
 
virtual bool16 CanExportForExternalize () const
 
virtual PMFlavor GetInternalFlavor () const
 
virtual int32 CountExternalFlavors () const
 
virtual ExternalPMFlavor GetExternalFlavor (int32 n) const
 
virtual bool16 CanExportThisFlavor (const ExternalPMFlavor &flavor, PMString &outFormatName) const
 
virtual ErrorCode ExportForExternalize (IDataExchangeHandler *handler, const ExternalPMFlavor toWhichFlavor, IPMStream *stream)
 
- Public Member Functions inherited from CExportProvider
 CExportProvider (IPMUnknown *boss)
 
virtual TaskInfo AsynchronousExportToFile (const IDFile &sysFile, IDocument *doc, IPMUnknown *targetboss, const PMString &formatName, UIFlags uiFlags=kFullUI)
 
virtual bool16 CanExportToFileAsynchronously () const
 
- Public Member Functions inherited from CPMUnknown< IExportProvider >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 
Export
Clipboard/DragDrop Export
Internal File Based Formats

Protected Member Functions

virtual UIDList GetExportableItemList (IPMUnknown *targetboss) const
 
virtual bool16 ExportingForCollaboration () const
 
- Protected Member Functions inherited from CExportProvider
virtual ErrorCode SendSignal (const ServiceID &service, IDocument *document, const IDFile &sysFile, const PMString &formatName, UIFlags uiFlags, bool8 bIsStandAlone=kTrue)
 
virtual bool16 IsTargetFileInUseByBGTasks (const IDFile &sysFile) const
 
virtual UserTaskJobSpec CreateExportJobSpec (const IDFile &sysFile, IDocument *document, const PMString &formatName) const
 
virtual void GetUniqueSysFile (IDocument *document, const IDFile *sysFileName, IDFile *uniqueSysFileName, uint32 pageNum, IOutputPages *outputPages, bool16 exportSpreads, PMString &suffix, PMString &exportFileExtension)
 
- Protected Member Functions inherited from CPMUnknown< IExportProvider >
 CPMUnknown (IPMUnknown *boss)
 

Additional Inherited Members

- Public Types inherited from IExportProvider
enum  { kDefaultIID = IID_IEXPORTPROVIDER }
 
- Protected Attributes inherited from CExportProvider
ExportSessionToken fSessionToken
 
std::map< std::string, int32 > fFileNameMap
 

Member Function Documentation

virtual bool16 CInCopyStoryExportSuite::CanExportForExternalize () const
inlinevirtual

The provider indicates whether it can do normal file-based exports.

Reimplemented from CExportProvider.

virtual bool16 CInCopyStoryExportSuite::CanExportThisFlavor (const ExternalPMFlavor & flavor,
PMStringoutFormatName 
) const
inlinevirtual

For Clip/Drag operations, what format type, if any, would be used to produce the desired external flavor?

Reimplemented from CExportProvider.

virtual bool16 CInCopyStoryExportSuite::CanExportThisFormat (IDocumentdoc,
IPMUnknowntargetboss,
const PMStringformatName 
)
virtual

The export provider indicates whether it can export the current selection in the specified file format (i.e. a text export file would return kFalse for a page item selection and kTrue for a text selection).

Parameters
docIN Document we're exporting from.
targetbossIN Target boss.
formatNameIN Name of the format we're exporting.
Returns
kTrue if the provider supports exporting in the current context, else kFalse.

Implements IExportProvider.

virtual bool16 CInCopyStoryExportSuite::CanExportToFile () const
inlinevirtual

The provider indicates whether it can do normal file based exports.

Reimplemented from CExportProvider.

virtual int32 CInCopyStoryExportSuite::CountExternalFlavors () const
inlinevirtual

For Clip/Drag operations, what external flavors can this exporter produce?

Reimplemented from CExportProvider.

virtual int32 CInCopyStoryExportSuite::CountFormats ()
inlinevirtual

Returns the number of file formats supported by this export provider.

Returns
Number of file formats supported.

Implements IExportProvider.

virtual ErrorCode CInCopyStoryExportSuite::ExportForExternalize (IDataExchangeHandlerhandler,
const ExternalPMFlavor toWhichFlavor,
IPMStreamstream 
)
inlinevirtual

Externalize the given data to a stream.

Reimplemented from CExportProvider.

virtual void CInCopyStoryExportSuite::ExportToFile (const IDFilesysFile,
IDocumentdoc,
IPMUnknowntargetboss,
const PMStringformatName,
UIFlags uiFlags = kFullUI 
)
virtual

Export to a file. Default implementation calls ExportToStream.

Reimplemented from CExportProvider.

virtual void CInCopyStoryExportSuite::ExportToStream (IPMStreamstream,
IDocumentdoc,
IPMUnknowntargetboss,
const PMStringformatName,
UIFlags uiFlags = kFullUI 
)
virtual

Exports the current selection to the given stream. The provider will generate the specified file format. \ Note: Some export providers may display UI and may export more than just the current selection (i.e. PDF export, EPS export, etc.).

Parameters
streamIN Streaam to export to.
docIN Document we're exporting from.
targetbossIN Target boss.
formatNameIN Name of the format we're exporting.
uiFlagsIN UI flags denoting how to handle UI events. (see BaseType.h)

Implements IExportProvider.

virtual PMString CInCopyStoryExportSuite::GetExtensionForFormatName (const PMStringformatName)
virtual

Returns the preferred file extension of the format name.

Parameters
formatNameIN Format name whose preferred file extension to return.
Returns
Preferred file extension of the format name.

Implements IExportProvider.

virtual ExternalPMFlavor CInCopyStoryExportSuite::GetExternalFlavor (int32 n) const
inlinevirtual

For Clip/Drag operations, returns the n'th flavor the provider can export to.

Parameters
nIN Index of the external flavor to return.
Returns
N'th external flavor the provider can export to.

Reimplemented from CExportProvider.

virtual PMFlavor CInCopyStoryExportSuite::GetInternalFlavor () const
inlinevirtual

For Clip/Drag operations, what internal flavor does this exporter operate on?

Reimplemented from CExportProvider.

virtual PMString CInCopyStoryExportSuite::GetNthFormatName (int32 n)
virtual

Returns the name (non-localized string) of the n'th file format supported by this export provider.

Parameters
nIN Index of the format name to return.
Returns
Name of the n'th format.

Implements IExportProvider.

virtual ScriptID CInCopyStoryExportSuite::GetScriptIDForFormatName (const PMStringformatName,
const ScriptInfo::RequestContextcontext 
)
virtual

Returns the ScriptID for the given format's enumerator in the kExportFormatEnumScriptElement

Parameters
formatNameIN Format name whose ScriptID to return
contextis the scripting request context
Returns
the ScriptID (or kInvalidScriptID if this format is not supported by enum)

Implements IExportProvider.