Class: TSingleValueStyleFilter

Declaration: StyleRunIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStyleFilter

Inherited By:

None.

Purpose:

TSingleValueStyleFilter, derived from TStyleFilter, allows you to iterate for style runs containing a specific type of style object with a specific value.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not designed for deriving.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSingleValueStyleFilter::TSingleValueStyleFilter

TSingleValueStyleFilter (const TSingleValueStyleFilter & toCopy)
TSingleValueStyleFilter (const TStyle & styleValue)

Interface Category:

API.

Purpose:

Copy constructor.
Constructs a filter to search for the specified type of style object with the specified value.

Calling Context:

Called to copy an object.
Called to construct the style filter.

Parameters:

const TSingleValueStyleFilter & toCopy -The object to copy.
const TStyle & styleValue -The type of style object and value to filter for.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSingleValueStyleFilter::~TSingleValueStyleFilter

virtual ~ TSingleValueStyleFilter ()

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: TSingleValueStyleFilter::operator=

TSingleValueStyleFilter & operator =(const TSingleValueStyleFilter & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSingleValueStyleFilter & 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.

Member Function: TSingleValueStyleFilter::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: TSingleValueStyleFilter::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: TSingleValueStyleFilter::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: TSingleValueStyleFilter::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.

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