### IFillAndFrameBundle

  IFillAndFrameBundle contains imaging information for 2D graphic objects of the solid-filled, framed (with any size of frame) variety. IFillAndFrameBundle contains imaging information for 2D graphic objects of the solid-filled, framed, with any size of frame, variety.

### IFillAndFrameBundle - Member Functions and Data by Group

### Constructors & Destructor

Use the functions in this group to construct and destroy objects of class IFillAndFrameBundle.

~IFillAndFrameBundle

      public:
      virtual ~IFillAndFrameBundle()

  Destroys the IFillAndFrameBundle object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

IFillAndFrameBundle

  Overload 1
  Default constructor.

      public:
      IFillAndFrameBundle()

  Use this constructor to create an IFillAndFrameBundle default frame and fill. Default frame is black paint, source-copy color transfer mode, and solid pen. Default fill is black paint and source-copy color transfer mode.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 2
  Copy constructor.

      public:
      IFillAndFrameBundle(const IFillAndFrameBundle&)

  IFillAndFrameBundle
    A constant reference to the IFillAndFrameBundle to be copied.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 3

      public:
      IFillAndFrameBundle( const IBaseColor& fillColor,
                           const IColorTransferMode& fillTransferMode,
                           const IBaseColor& frameColor,
                           const IColorTransferMode& frameTransferMode,
                           GCoordinate penWidth = 1,
                           IPen::EPenBalance balance = IPen::kCenterFrame )

  Use this constructor to create an IFillAndFrameBundle with specified parameters for the fill and the frame.

  fillColor
    The fill color to be copied.
  fillTransferMode
    The color transfer mode for the fill.
  frameColor
    The frame color to be copied.
  frameTransferMode
    The color transfer mode for the frame.
  penWidth
    The pen width to be copied.
  IPen::kCenterFrame
    The IPen::EPenBalance to be copied. The default value is IPen::kCenterFrame.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

  Overload 4

      public:
      IFillAndFrameBundle( const IBaseColor& fillColor,
                           const IBaseColor& frameColor,
                           GCoordinate penWidth = 1,
                           IPen::EPenBalance balance = IPen::kCenterFrame )

  Constructs an IFillAndFrameBundle with specified color, pen width, and pen balance.

  fillColor
    The fill color to be copied.
  frameColor
    The frame color to be copied.
  penWidth
    The pen width to be copied.
  balance
    The IPen::EPenBalance to be copied. The default value is IPen::kCenterFrame.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Assignment Operator

Use this operator to assign the given IFillAndFrameBundle object to the target one.

operator =

      public:
      IFillAndFrameBundle& operator =(const IFillAndFrameBundle&)

  Assignment operator.

  IFillAndFrameBundle
    A constant reference to the bundle object to be copied.

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

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Comparing Two Objects for Equality

Use the function in this group to test the objects for equality.

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 IFillAndFrameBundle and the argument have equal attributes.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Getting Attribute Values for the Frame and Fill

Use the functions in this group to get values set for the frame and fill, or both, such as the transfer mode and paint to be used for the fill and the pen and paint to be used for the frame.

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

fillPaint

      public:
      virtual const IPaint* fillPaint() const

  Returns the paint object being used for the fill region of this graphic object.

Return
  A pointer to the paint object being used.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

fillTransferMode

      public:
      virtual const IColorTransferMode* fillTransferMode() const

  Returns the transfer mode object being used for the fill region of this graphic object.

Return
  A pointer to the paint object being used.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

framePaint

      public:
      virtual const IPaint* framePaint() const

  Returns the paint object being used for this frame.

Return
  A pointer to the paint object being used.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

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

frameTransferMode

      public:
      virtual const IColorTransferMode* frameTransferMode() const

  Returns a pointer to the 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 Atttribute Values for the Frame and Fill

Use the functions in this group to set values for the frame or fill, or both, such as the pen width and balance , and the frame or fills transfer mode and color.

setFillColor

      public:
      void setFillColor(const IBaseColor& color)

  Sets the fill color for the object.

  color
    The color for the fill region.

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

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

setFillTransferMode

      public:
      void
        setFillTransferMode( const IColorTransferMode& transferMode )

  Sets the transfer mode that determines the fill color after deleting the existing one.

  transferMode
    The new transfer mode to be used.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

setFrameColor

      public:
      void setFrameColor(const IBaseColor& color)

  Sets the color of the frame.

  color
    The new color for the frame.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

setFrameTransferMode

      public:
      void
        setFrameTransferMode( const IColorTransferMode& transferMode )

  Sets the transfer mode that determines the frame color after deleting the existing one.

  transferMode
    The new transfer mode to be used.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

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

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 an 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.

readFromStream

      protected:
      virtual void readFromStream(IDataStream& toWhere)

  Reads the object in from the specified stream.

  fromWhere
    The stream used to read in the object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

writeToStream

      protected:
      virtual void writeToStream(IDataStream& toWhere) const

  Writes the object out the the specified stream.

  toWhere
    The stream to write out the object.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### IFillAndFrameBundle - Inherited Member Functions and Data

#### Inherited Public Functions

  IAttributeState

  -     virtual ~IAttributeState()

  -     virtual EDrawOperation drawingOperation() const = 0

  -     virtual const ICap* frameEndCap() const

  -     virtual const IJoint* frameJoint() const

  -     IAttributeState(const IAttributeState&)

  -     IAttributeState()

  -     virtual const IImageSamplingControl* imageSampling() const

  -     virtual const IImageTransferMode* imageTransferMode() const

  -     bool operator !=(const IAttributeState& obj) const

  -     IAttributeState& operator =(const IAttributeState&)

  -     virtual bool operator ==(const IAttributeState& obj) const

  -     virtual unsigned long timeStamp() const

  IMStreamable

  -     virtual ~IMStreamable()

  -     void externalizeToStream(IDataStream& towhere) const

  -     void internalizeFromStream(IDataStream& fromwhere)

  -     virtual const ITypeRepresentation&
          typeRepresentation() const = 0

  IFillAndFrameBundle

  -     StreamableDeclarationsMacro(IFillAndFrameBundle)

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  IMStreamable

  -     IMStreamable()

  -     IMStreamable(const IMStreamable& other)

  -     virtual void readFromStream(IDataStream& fromwhere) = 0

  -     virtual void writeToStream(IDataStream& towhere) const = 0

  IAttributeState

  -     void resetTimeStamp()

  -     void setTimeStamp(unsigned long)

  -     void updateTimeStamp()

#### Inherited Protected Data

  - None