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

#include <DataObjectIterator.h>

Public Member Functions

virtual ~DataObjectIterator ()
 
virtual IPMDataObject * First ()=0
 
virtual IPMDataObject * Next ()=0
 
virtual bool16 FlavorExistsInAllObjects (ExternalPMFlavor flavor)=0
 
virtual bool16 FlavorIsPrimaryInAllObjects (ExternalPMFlavor flavor)=0
 
virtual DataExchangeResponse FlavorExistsWithPriorityInAllObjects (ExternalPMFlavor flavor)=0
 

Detailed Description

an abstract iterator class used to access the items in data exchange (drap/drop and clipboard) operations. There is almost always only one item (always true on Win, and for clipboard, but can be multiple in Mac drops)

See Also
IPMDataObject

Constructor & Destructor Documentation

virtual DataObjectIterator::~DataObjectIterator ()
inlinevirtual

Destructor

Member Function Documentation

virtual IPMDataObject* DataObjectIterator::First ()
pure virtual

Get the first data object

virtual bool16 DataObjectIterator::FlavorExistsInAllObjects (ExternalPMFlavor flavor)
pure virtual

Does the flavor exist in all items

Parameters
flavorIN which flavor
Returns
kTrue or kFalse
virtual DataExchangeResponse DataObjectIterator::FlavorExistsWithPriorityInAllObjects (ExternalPMFlavor flavor)
pure virtual

Does the flavor exist in all items, and at what priority

Parameters
flavorIN which flavor
Returns
response containing kTrue or kFalse plus highest priority of flavor in items
virtual bool16 DataObjectIterator::FlavorIsPrimaryInAllObjects (ExternalPMFlavor flavor)
pure virtual

Does the flavor exist in all items, and is it the first or highest priority flavor

Parameters
flavorIN which flavor
Returns
kTrue or kFalse
virtual IPMDataObject* DataObjectIterator::Next ()
pure virtual

Get the next data object