InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CContentReadIterator Class Reference

#include <CContentIterator.h>

Inheritance diagram for CContentReadIterator:
IContentReadIteratorSchemaBasedReadIterator

Public Member Functions

 CContentReadIterator (CContentIterator &iterator)
 
void SetIterator (CContentIterator *iterator)
 
bool16 IsClassID () const
 
ClassID GetClassID () const
 
ImplementationID GetImplementationID () const
 
uint32 GetLength () const
 
bool16 Next ()
 
bool16 EndOfList () const
 
void Reset (IContentWriteIterator *out=nil)
 
IPMStreamQueryContentStream ()
 
int32 GetOriginPosition () const
 
- Public Member Functions inherited from IContentReadIterator
virtual ~IContentReadIterator ()
 

Detailed Description

This class provides a generic implementation of the IContentReadIterator interface. It uses an aggregated instance of CContentIterator to perform the actual work.

The individual methods are not documented here, they correspond exactly to those documented for IContentReadIterator.

See Also
IContentReadIterator
CContentIterator

Member Function Documentation

bool16 CContentReadIterator::EndOfList () const
inlinevirtual

Returns kTrue when there are no more IDs in the iterated data stream

Returns
kTrue if the data has been exhausted, kFalse if there are more IDs.

Implements IContentReadIterator.

ClassID CContentReadIterator::GetClassID () const
inlinevirtual

Fetch the current Class ID.

Returns
The Class ID.

Implements IContentReadIterator.

ImplementationID CContentReadIterator::GetImplementationID () const
inlinevirtual

Fetch the current Implementation ID.

Returns
The Implementation ID.

Implements IContentReadIterator.

uint32 CContentReadIterator::GetLength () const
inlinevirtual

Return the length (in bytes) of the data associated with the current ID.

Returns
Data length

Implements IContentReadIterator.

int32 CContentReadIterator::GetOriginPosition () const
inlinevirtual

Returns the initial position of the input stream associated with this iterator. That is – the stream's position at the time the iterator was bound to it.

Returns
The original stream position.

Implements IContentReadIterator.

bool16 CContentReadIterator::IsClassID () const
inlinevirtual

Used to determine whether the current ID found in the input stream is a Class ID or an Implementation ID.

Returns
kTrue if the current ID is a Class ID.

Implements IContentReadIterator.

bool16 CContentReadIterator::Next ()
inlinevirtual

Advance the iterator to the next ID in the input stream.

Returns
kTrue if another ID was found, kFalse if not.

Implements IContentReadIterator.

IPMStream* CContentReadIterator::QueryContentStream ()
inlinevirtual

Returns an interface pointer to the iterator's associated input stream. The interface is add-refed prior to returning the pointer.

Returns
The stream pointer.

Implements IContentReadIterator.

void CContentReadIterator::Reset (IContentWriteIteratorout = nil)
inlinevirtual

Called when the Conversion Manager wishes to reinitalize the iterator. An output iterator may optionall be associated with this input iterator at this time.

Parameters
outIN Used to bind an output iterator to this input iterator.

Implements IContentReadIterator.