Class: TInvertTransferMode

Declaration: InvertTransferModes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDstActiveTransferMode

Inherited By:

TInvertHighlightTransferMode

Purpose:

TInvertTransferMode is a concrete class derived from TDstActiveTransferMode, that provides an invertible transfer mode for indexed devices. It is used internally to select highlighted text. This transfer mode causes a conversion of the destination color from the indexed color to RGB; determines the color's red, green, and blue components; subtracts each value from 1.0; then replaces the destination with the inverted color. Once you apply the transfer mode to an area, the original contents of that area can be restored by applying the operation again.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special considerations.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TInvertTransferMode::TInvertTransferMode

  1. TInvertTransferMode ()
  2. TInvertTransferMode (const TInvertTransferMode &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Called by the stream-in operators. You can also call this constructor directly.
  2. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvertTransferMode::~TInvertTransferMode

virtual ~ TInvertTransferMode ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvertTransferMode::GetResultingColor

  1. virtual void GetResultingColor (const TColor & sourceColor, const TColor & destColor, TColor & resultingColor) const
  2. virtual void GetResultingColor (const TColor & destColor, TColor & resultingColor) const

Interface Category:

API.

Purpose:

  1. Converts a destination color into the corresponding inverted RGB color. Each of the destination color's red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The source color is ignored. The resulting color is returned as a TColor.
  2. Converts a destination color into the corresponding inverted RGB color. Each of the destination color's red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The resulting color is returned as a TColor.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvertTransferMode::GetInvertDstResult

static void GetInvertDstResult (const TRGBColor & destColor, TRGBColor & resultingColor)

Interface Category:

API.

Purpose:

Converts a destination TRGBColor into the corresponding inverted RGB color. Each of the red, green, and blue components, as well as the alpha component, are subtracted from 1.0. The resulting color is returned as a TRGBColor.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvertTransferMode::operator=

TInvertTransferMode & operator =(const TInvertTransferMode & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvertTransferMode::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvertTransferMode::TemporaryTypeID

virtual TTransferMode :: ETransferModeClassID TemporaryTypeID () const

Interface Category:

API.

Purpose:

Gives information as to which type of transfer mode is represented by the object.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the type of transfer mode this object represents.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This is a temporary function meant to offer mode identification until an ANSI C++ typeid operator is available.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.