InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITxtExpSuite Class Referenceabstract

#include <ITxtExpSuite.h>

Inheritance diagram for ITxtExpSuite:
IPMUnknownCPMUnknown< ITxtExpSuite >TxtExpSuiteASBTxtExpSuiteTextCSB

Public Types

enum  { kDefaultIID = IID_ITXTEXPSUITE }
 

Public Member Functions

virtual bool16 CanExportText (const PMString &formatName)=0
 
virtual ErrorCode DoExportText (IPMStream *fileStreamWrites, ITxtExpFileWriter::Encoding encoding)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

From SDK sample; interface added by this plug-in that allows client code to export the selected text into its own format.

See Also
TxtExpSuiteASB
TxtExpSuiteTextCSB

Member Function Documentation

virtual bool16 ITxtExpSuite::CanExportText (const PMStringformatName)
pure virtual
Parameters
formatNameIN the export format name, must be the one we support to return kTrue.
Returns
kTrue if there is text focus, in that case, we will export the selected text or the whole text story.

Implemented in TxtExpSuiteTextCSB, and TxtExpSuiteASB.

virtual ErrorCode ITxtExpSuite::DoExportText (IPMStreamfileStreamWrites,
ITxtExpFileWriter::Encoding encoding 
)
pure virtual

Export the text.

Parameters
fileStreamWritesIN the the writes stream used to output text.
Precondition
CanExportText == kTrue
Returns
kSuccess if the export operation is successful

Implemented in TxtExpSuiteTextCSB, and TxtExpSuiteASB.