Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TAbstractDocumentFunctor
Inherited By:
TCopyToClipboard
Purpose:
The TDocumentFunctor class is the abstract base class for document functors that apply to the document object. A functor is sent to a document surrogate. The functor is then sent to the corresponding real document instance and performed there.
Abstract base class; do not allocate.
Deriving Classes:
Functors that apply to TDocument derive from this class. Derived classes must override the pure virtual function HandleDo.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Invariants:
Functors do not maintain state.
virtual ~ TDocumentFunctor ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
- TDocumentFunctor ()
- TDocumentFunctor ( const TDocumentFunctor & );
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
Calling Context:
- Called by the stream-in operators and derived classes.
- Called to copy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual void HandleDo (TDocument &)
Interface Category:
API.
Purpose:
Executes the functor on the document. Derived classes override this function to perform their action on the document.
Calling Context:
Called only by TDocumentFunctor.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions. All exceptions are passed through.
Concurrency:
Multithread safe.
Other Considerations:
This function is a pure virtual function and must be overridden by classes deriving from TDocumentFunctor.
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.