IImageTransferMode

IImageTransferMode describes the behavior how source image is drawn at the destination. It applies for the geometry of IGImage.


IImageTransferMode - Member Functions and Data by Group

Constructors & Destructor

Use the constructors in this group to construct objects of class IImageTransferMode.


[view class]
~IImageTransferMode
public:
~IImageTransferMode()

Destructs an object of class IImageTransferMode.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IImageTransferMode
Constructs an object of class IImageTransferMode.


Overload 1
Constructor with default behavior source-replaces-destination or source copy.
public:
IImageTransferMode()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
Copy constructor.
public:
IImageTransferMode(const IImageTransferMode&)

const IImageTransferMode&
The transfer mode to copy from.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
Constructor takes an enumerated type EImageMode.
public:
IImageTransferMode(EImageMode mode)

mode
The transfer mode to set.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Assignment Operator

Use the operator in this group to replace the current IImageTransferMode object with the given one.


[view class]
operator =
public:
IImageTransferMode& operator =(const IImageTransferMode&)
Assignment operator.

const IImageTransferMode&
The transfer mode to copy from.

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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Comparing Two IImageTransferMode Objects for Equality or Inequality

Use the functions in this group to test two objects for equality or inequality.


[view class]
operator !=
public:
virtual bool operator !=(const IImageTransferMode&) const
Tests two IImageTransferMode objects for inequality.

IImageTransferMode
A constant reference to the IImageTransferMode to be compared with.

Return
True if the two IImageTransferMode objects have different types.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator ==
public:
virtual bool operator ==(const IImageTransferMode&) const
Tests two IImageTransferMode objects for equality.

IImageTransferMode
A constant reference to the IImageTransferMode to be compared with.

Return
True if the two IImageTransferMode objects are the same type.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Obtaining the Transfer Mode Type

Use the function in this group to get the transfer mode.


[view class]
mode
public:
IImageTransferMode::EImageMode mode() const
Returns the enumerated type of the transfer mode.

Return
The enumerated type.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Streaming an IImageTransferMode Object In and Out

Use the functions in this group to read the object in from the specified stream or write it out to it.


[view class]
readFromStream
protected:
virtual void readFromStream(IDataStream& toWhere)

fromWhere
The stream from which the object is read in.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
writeToStream
protected:
virtual void writeToStream(IDataStream& toWhere) const

toWhere
The stream that the object is written out to.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IImageTransferMode - Enumerations


[view class]
EImageMode
enum EImageMode { kSrcCopy, 
                  kSrcORDst, 
                  kSrcANDDst, 
                  kSrcXORDst, 
                  kSrcANDInvertDst, 
                  kInvertSrc, 
                  kInvertResultOfSrcORDst, 
                  kSrcANDPattern, 
                  kInvertSrcORDst, 
                  kPatternCopy, 
                  kPatternORInvertSrcORDst, 
                  kPatternXORDst, 
                  kInvertDst, 
                  kAllZeros, 
                  kAllOnes, 
                  kOCHalfTone }
Use these enumerated constants to specify the image transfer mode.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IImageTransferMode - Inherited Member Functions and Data

Inherited Public Functions

IMStreamable

Inherited Public Data

Inherited Protected Functions

IMStreamable

Inherited Protected Data