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

#include <IContentIteratorRegister.h>

Inheritance diagram for IContentIteratorRegister:
IPMUnknownCContentIteratorRegisterSnapIteratorRegister

Public Member Functions

virtual uint32 GetClassIDCount ()=0
 
virtual void GetNthClassID (uint32 n, ClassID &id)=0
 
virtual uint32 GetImplementationIDCount ()=0
 
virtual void GetNthImplementationID (uint32 n, ImplementationID &id)=0
 
virtual IContentReadIteratorNewNthClassReadIterator (uint32 n, const VersionID &version, IPMStream *s)=0
 
virtual IContentWriteIteratorNewNthClassWriteIterator (uint32 n, const VersionID &version, IPMStream *s)=0
 
virtual IContentReadIteratorNewNthImplementationReadIterator (uint32 n, const VersionID &version, IPMStream *s)=0
 
virtual IContentWriteIteratorNewNthImplementationWriteIterator (uint32 n, const VersionID &version, IPMStream *s)=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

This interface allows a client to register a set of class and implementation Content Iterators. The object implementing this interface must register with the system as a service provider of type kContentIteratorRegisterServiceImpl.

See Also
IContentReadIterator
IContentWriteIterator

Member Function Documentation

virtual uint32 IContentIteratorRegister::GetClassIDCount ()
pure virtual

Return a count of the number of classes for which iterators can be provided.

Returns
The class count

Implemented in CContentIteratorRegister.

virtual uint32 IContentIteratorRegister::GetImplementationIDCount ()
pure virtual

Return a count of the number of implementations for which iterators can be provided.

Returns
The implementation count

Implemented in CContentIteratorRegister, and SnapIteratorRegister.

virtual void IContentIteratorRegister::GetNthClassID (uint32 n,
ClassIDid 
)
pure virtual

Return the ID of the n-th class for which iterators can be provided.

Parameters
nIN Which class
idOUT The class ID or kInvalidClass if n is invalid.

Implemented in CContentIteratorRegister.

virtual void IContentIteratorRegister::GetNthImplementationID (uint32 n,
ImplementationIDid 
)
pure virtual

Return the ID of the n-th implementation for which iterators can be provided.

Parameters
nIN Which implementation
idOUT The implementation ID or kInvalidImpl if n is invalid.

Implemented in SnapIteratorRegister, and CContentIteratorRegister.

virtual IContentReadIterator* IContentIteratorRegister::NewNthClassReadIterator (uint32 n,
const VersionIDversion,
IPMStreams 
)
pure virtual

Create a new input iterator for a particular version of a particular class.

Parameters
nIN The index of the class in the list supplied via GetNthClassID()
versionIN The class data format
sIN An input stream that contains the data in the specified format
Returns
A referenced instance of IContentReadIterator

Implemented in CContentIteratorRegister.

virtual IContentWriteIterator* IContentIteratorRegister::NewNthClassWriteIterator (uint32 n,
const VersionIDversion,
IPMStreams 
)
pure virtual

Create a new output iterator for a particular version of a particular class.

Parameters
nIN The index of the class in the list supplied via GetNthClassID()
versionIN The class data format
sIN An output stream that will contain the data
Returns
A referenced instance of IContentWriteIterator

Implemented in CContentIteratorRegister.

virtual IContentReadIterator* IContentIteratorRegister::NewNthImplementationReadIterator (uint32 n,
const VersionIDversion,
IPMStreams 
)
pure virtual

Create a new input iterator for a particular version of a particular implementation.

Parameters
nIN The index of the implementation in the list supplied via GetNthImplementationID()
versionIN The implementation data format
sIN An input stream that contains the data in the specified format
Returns
A referenced instance of IContentReadIterator

Implemented in SnapIteratorRegister, and CContentIteratorRegister.

virtual IContentWriteIterator* IContentIteratorRegister::NewNthImplementationWriteIterator (uint32 n,
const VersionIDversion,
IPMStreams 
)
pure virtual

Create a new output iterator for a particular version of a particular implementation.

Parameters
nIN The index of the implementation in the list supplied via GetNthImplementationID()
versionIN The implementation data format
sIN An output stream that will contain the data
Returns
A referenced instance of IContentWriteIterator

Implemented in SnapIteratorRegister, and CContentIteratorRegister.