CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
CFxDocumentIterator Class Referenceabstract

#include <FxDocumentIterator.h>

Inheritance diagram for CFxDocumentIterator:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (CFxDocumentIterator)
 
 CFxDocumentIterator (void)
 
 ~CFxDocumentIterator (void) override
 
virtual bool Done () const =0
 
virtual void Step ()=0
 
virtual CFxDocumentDocument ()=0
 
virtual void Seek (const CFxDocument *pDocument)=0
 
virtual void Start ()=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Description: Represents a document manager iterator. Library: DDKERNEL

Definition at line 32 of file FxDocumentIterator.h.

Constructor & Destructor Documentation

◆ CFxDocumentIterator()

CFxDocumentIterator::CFxDocumentIterator ( void  )

◆ ~CFxDocumentIterator()

CFxDocumentIterator::~CFxDocumentIterator ( void  )
override

Member Function Documentation

◆ Document()

virtual CFxDocument* CFxDocumentIterator::Document ( )
pure virtual

Description: Gets the document.

Return Value: null if it fails, else.

◆ Done()

virtual bool CFxDocumentIterator::Done ( ) const
pure virtual

Description: Dones this object.

Return Value: true if it succeeds, false if it fails.

◆ ODRX_DECLARE_MEMBERS()

CFxDocumentIterator::ODRX_DECLARE_MEMBERS ( CFxDocumentIterator  )

◆ Seek()

virtual void CFxDocumentIterator::Seek ( const CFxDocument pDocument)
pure virtual

Description: Seeks. Arguments:

Parameters
pDocumentThe document.

◆ Start()

virtual void CFxDocumentIterator::Start ( )
pure virtual

Description: Starts this object.

◆ Step()

virtual void CFxDocumentIterator::Step ( )
pure virtual

Description: Steps this object.


The documentation for this class was generated from the following file: