IFrameBundle

IFrameBundle contains imaging information for 2D graphic objects of the non-filled, framed (with any size of frame) variety. IFrameBundle contains imaging information for 2D graphic objects that non-filled and framed with any size of frame.


IFrameBundle - Member Functions and Data by Group

Constructors & Destructor

Use the constructors and destructor in this group to create and destroy objects of class IFrameBundle.


[view class]
~IFrameBundle
public:
virtual ~IFrameBundle()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IFrameBundle


Overload 1
Default constructor. Creates an IFrameBundle with black paint, source-copy mode, and solid pen.
public:
IFrameBundle()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
Constructs an IFrameBundle with specified frame color, pen width, and pen balance.
public:
IFrameBundle( const IBaseColor& frameColor, GCoordinate penWidth = 1, IPen::EPenBalance balance = IPen::kCenterFrame )

frameColor
The frame color to be copied.
penWidth
The pen width to be copied.
balance=IPen::kCenterFrame
The IPen::EPenBalance to be copied.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 3
Constructs an IFrameBundle with specified frame color, color transfer mode, pen width, and pen balance.
public:
IFrameBundle( const IBaseColor& frameColor, const IColorTransferMode& transferMode, GCoordinate penWidth = 1, IPen::EPenBalance balance = IPen::kCenterFrame )

frameColor
The frame color to be copied.
transferMode
The color transfer mode to be copied.
penWidth
The pen width to be copied.
balance=IPen::kCenterFrame
The IPen::EPenBalance to be copied.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 4
Copy constructor.
public:
IFrameBundle(const IFrameBundle&)

const IFrameBundle&
The IFrameBundle object to be copied.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Assignment Operator

Use this operator to assign the given frame bundle to the target one.


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

const IFrameBundle&
The frame bundle object.

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

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Comparing for Equality

Use the function in this group to compare an IAttributeState object with the current IFrameBundle one for equality.


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

IAttributeState)
A constant reference to the IAttributeState to be compared with this one.

Return
True if this IFrameBundle and the argument have equal attributes.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Getting the Frame Bundle's Attributes and Properties

Use the functions in this group to get values set for the frame bundle, such as the drawing operation to be performed, and the frame paint, pen and transfer mode to be used.


[view class]
drawingOperation
public:
virtual IAttributeState::EDrawOperation drawingOperation() const
Returns the EDrawOperation that determines whether to paint the fill, the frame, or both.

Return
The EDrawingOperation value of the bundle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
framePaint
public:
virtual const IPaint* framePaint() const
Returns the paint object being used for this frame.

Return
Pointer to the paint object being used.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
framePen
public:
virtual const IPen* framePen() const
Gets the IPen object that is used for the rendering of the frame.

Return
A pointer to this frame's IPen.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
frameTransferMode
public:
virtual const IColorTransferMode* frameTransferMode() const
Returns a pointer to the color transfer mode being used by the frame of this graphic object.

Return
A pointer to the transfer mode for this frame.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Setting Frame Attributes and Properties

Use the functions in this group to set the frame bundle's values, such as the frame color, transfer mode, pen width and pen balance.


[view class]
setFrameColor
public:
void setFrameColor(const IBaseColor& color)
Sets the color for the frame.

color
The color for the frame.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setFrameTransferMode
public:
void setFrameTransferMode( const IColorTransferMode& transferMode )
Sets the transfer mode for the frame bundle after deleting the existing one.

transferMode
The new transfer mode to be used.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setPenBalance
public:
void setPenBalance(IPen::EPenBalance balance)
Sets the pen balance for the frame.

balance
The new balance value.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setPenWidth
public:
void setPenWidth(GCoordinate penWidth)
Sets the pen width for the frame.

penWidth
The width (in pixels) of the frame.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Streaming the Object In and Out

Use the functions in this group to read the object in from the specified stream and to 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


IFrameBundle - Inherited Member Functions and Data

Inherited Public Functions

IAttributeState
IMStreamable
IFrameBundle

Inherited Public Data

Inherited Protected Functions

IMStreamable
IAttributeState

Inherited Protected Data