InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
CDataExchangeHandlerFor Class Referenceabstract

#include <CDataExchangeHandlerFor.h>

Inheritance diagram for CDataExchangeHandlerFor:
CPMUnknown< IDataExchangeHandler >IDataExchangeHandlerIPMUnknownBscDNDCustomDEHandlerCusDtLnkUIDataExchangeHandler

Public Types

typedef CPMUnknown
< IDataExchangeHandler > 		Inherited
 

Public Member Functions

 CDataExchangeHandlerFor (IPMUnknown *boss)
 
virtual void CreateScrapStorage ()
 
virtual PMFlavor GetFlavor () const =0
 
virtual DataExchangeResponse CanInternalizeData (IPMDataObject *whichItem) const
 
virtual bool16 CanConvertExternalFlavor (ExternalPMFlavor fromWhichFlavor) const
 
virtual void AddInternalizeableFlavorsToList (OrderedFlavorList &flavorList) const
 
virtual void AddExternalizeableFlavorsToList (OrderedFlavorList &flavorList) const
 
virtual void Clear ()
 
virtual bool16 IsEmpty () const
 
virtual ErrorCode ExternalizePromises (IPMDataObject *whichItem)
 
virtual ErrorCode Externalize (IPMDataObject *whichItem, ExternalPMFlavor toWhichFlavor, IPMStream *s)
 
virtual ErrorCode Internalize (IPMDataObject *whichItem)
 
virtual ErrorCode Internalize (IPMDataObject *whichItem, ExternalPMFlavor fromWhichFlavor, IPMStream *s)
 
- Public Member Functions inherited from CPMUnknown< IDataExchangeHandler >
IPMUnknown * QueryInterface (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
 
CPMUnknown & operator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from CPMUnknown< IDataExchangeHandler >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IDataExchangeHandler >
HelperInterface fHelperInterface
 

Detailed Description

Helper class to make it easier for clients to create simple DataExchangeHandlers. And for me to update them.

See Also
IDataExchangeHandler

Member Function Documentation

virtual void CDataExchangeHandlerFor::AddExternalizeableFlavorsToList (OrderedFlavorList & flavorList) const
virtual

Override this method to add to the list, the set of flavors thus handler can convert to. Default implementaton does nothing.

Implements IDataExchangeHandler.

virtual void CDataExchangeHandlerFor::AddInternalizeableFlavorsToList (OrderedFlavorList & flavorList) const
virtual

Override this method to add to the list, the set of flavors thus handler can convert from. Default implementation does nothing.

Implements IDataExchangeHandler.

virtual bool16 CDataExchangeHandlerFor::CanConvertExternalFlavor (ExternalPMFlavor fromWhichFlavor) const
virtual

Override this method to return whether this handler can convert the specified external flavor. Default implementation only knows about the flavor returned by GetFlavor().

Implements IDataExchangeHandler.

virtual DataExchangeResponse CDataExchangeHandlerFor::CanInternalizeData (IPMDataObject * whichItem) const
virtual

Override this method to examine external flavors in data object to see if this handler can convert them. Default implementation only knows about the flavor returned by GetFlavor().

Implements IDataExchangeHandler.

virtual void CDataExchangeHandlerFor::Clear ()
virtual

Override this method to clear all data retained by the handler. Default implementation does nothing.

Implements IDataExchangeHandler.

Reimplemented in BscDNDCustomDEHandler, and CusDtLnkUIDataExchangeHandler.

virtual void CDataExchangeHandlerFor::CreateScrapStorage ()
virtual

Do scrap database initialization for this handler. Default implementation does nothing.

Implements IDataExchangeHandler.

Reimplemented in BscDNDCustomDEHandler, and CusDtLnkUIDataExchangeHandler.

virtual ErrorCode CDataExchangeHandlerFor::Externalize (IPMDataObject * whichItem,
ExternalPMFlavor toWhichFlavor,
IPMStream * s 
)
virtual

Override this method to externalize the data object to the specified external flavor, writing to the given stream. Default implementation asserts, but otherwise does nothing.

Implements IDataExchangeHandler.

virtual ErrorCode CDataExchangeHandlerFor::ExternalizePromises (IPMDataObject * whichItem)
virtual

Override this method to externalize the promises made for the data object. Default implementation does nothing.

Implements IDataExchangeHandler.

virtual PMFlavor CDataExchangeHandlerFor::GetFlavor () const
pure virtual

Override this method to specify the internal PMFlavor this handler represents.

Implements IDataExchangeHandler.

Implemented in BscDNDCustomDEHandler, and CusDtLnkUIDataExchangeHandler.

virtual ErrorCode CDataExchangeHandlerFor::Internalize (IPMDataObject * whichItem)
virtual

Override this method to internalize the data from a data object. Default implementation asserts, but otherwise does nothing.

Implements IDataExchangeHandler.

virtual ErrorCode CDataExchangeHandlerFor::Internalize (IPMDataObject * whichItem,
ExternalPMFlavor fromWhichFlavor,
IPMStream * s 
)
virtual

Override this method to internalize the data from a data object using a specified external flavor, reading from the given stream. Default implementation asserts, but otherwise does nothing.

Implements IDataExchangeHandler.

virtual bool16 CDataExchangeHandlerFor::IsEmpty () const
virtual

Override this method to return whether or not the handler is empty, or if it contains internalized flavor data. Default implementation returns kTrue.

Implements IDataExchangeHandler.

Reimplemented in BscDNDCustomDEHandler, and CusDtLnkUIDataExchangeHandler.