Class: TCompoundDocumentFunctor

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractDocumentFunctor

Inherited By:

None.

Purpose:

The TCompoundDocumentFunctor class is the abstract base class for document functors that apply to the compound document object. A functor is sent to a document surrogate. The functor is then sent to the corresponding real document instance and performed there.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Functors that apply to TCompoundDocument derive from this class. Derived classes must override the pure virtual function HandleDo.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Invariants: Functors do not maintain state.

Member Function: TCompoundDocumentFunctor::~TCompoundDocumentFunctor

virtual ~ TCompoundDocumentFunctor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCompoundDocumentFunctor::TCompoundDocumentFunctor

TCompoundDocumentFunctor ()
TCompoundDocumentFunctor (const TCompoundDocumentFunctor&)

Interface Category:

API.

Purpose:

Default constructor. Does nothing.
Copy constructor.

Calling Context:

Called by the stream-in operators and derived classes.
Called to copy an object.

Parameters:

Takes no parameters.
const TCompoundDocumentFunctor& -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TCompoundDocumentFunctor is an abstract base class--all the constructors are protected. Do not instantiate this class.

Member Function: TCompoundDocumentFunctor::HandleDo

virtual void HandleDo (TCompoundDocument &)

Interface Category:

API.

Purpose:

Executes the functor on the compound document.

Calling Context:

Called only by TCompoundDocumentFunctor. Derived classes override this member function to perform their action on the compound document.

Parameters:

TCompoundDocument & -The target document.

Return Value:

None.

Exceptions:

Throws no exceptions. All exceptions are passed through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is a pure virtual function and must be overridden by classes deriving from TCompoundDocumentFunctor.

Click the icon to mail questions or corrections about this material to Taligent personnel.