Class: TStyleFilter

Declaration: StyleRunIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TBoundaryStyleFilter TNotStyleFilter TNullStyleFilter TSingleStyleFilter TSingleTypeStyleFilter TSingleValueStyleFilter

Purpose:

Abstract base class for all style filter classes.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Directly derive from TStyleFilter to create additional filters to be used for iterating over particular styles in text. The member functions StartChecking and StopChecking default to do nothing, and should be overridden to initialize the storage for the iterator. The member functions CheckForFirstRun and CheckForContinuedRun are abstract and must be overridden according to their descriptions below.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStyleFilter::~TStyleFilter

virtual ~ TStyleFilter ()

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: TStyleFilter::StartChecking

virtual void StartChecking ()

Interface Category:

API.

Purpose:

Initializes the storage for the iterator.

Calling Context:

Called before iteration to initialize the storage for the iterator, and whenever the iterator changes direction.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStyleFilter::CheckForFirstRun

virtual FilterAction CheckForFirstRun (const TStyleSet * set)

Interface Category:

API.

Purpose:

Iterates through style runs until a run matching the filter conditions is found.

Calling Context:

Called while it returns excludeAndContinue; that is, until it returns includeAndContinue or includeAndStop. If it is a stop, the iterator stops and returns a single run. Otherwise, it calls CheckForContinuedRun to determine the extent of the range. It must never return excludeAndStop.

Parameters:

const TStyleSet * set -The style set defining the filter.

Return Value:

The FilterAction value specifying the action required by the first located run.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStyleFilter::CheckForContinuedRun

virtual FilterAction CheckForContinuedRun (const TStyleSet * set)

Interface Category:

API.

Purpose:

Iterates through additional runs to determine if any need to be concatenated to the first located run.

Calling Context:

Called after a run matching the specified conditions is found; that is, after CheckForFirstRun returns includeAndContinue. This function is then called as long as it returns includeAndContinue.

Parameters:

const TStyleSet * set -The style set defining the filter.

Return Value:

The FilterAction value specifying the action required by the first located run.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStyleFilter::StopChecking

virtual void StopChecking ()

Interface Category:

API.

Purpose:

Finalizes and deallocates storage.

Calling Context:

Called before returning from the iterator.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStyleFilter::TStyleFilter

TStyleFilter ()
TStyleFilter (const TStyleFilter & toCopy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TStyleFilter & toCopy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStyleFilter::operator=

TStyleFilter & operator =(const TStyleFilter & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStyleFilter & toCopy -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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