IGrafBundle
- IGrafBundle is a collection of attributes that contain imaging information for the rendering device.
IGrafBundle - Member Functions and Data by Group
Constructors & Destructor
Use the constructor and destructor in this group to create and destroy objects of class IGrafBundle.
- ~IGrafBundle
public:
virtual ~IGrafBundle()
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- IGrafBundle
Overload 1
- Copy constructor
public:
IGrafBundle(const IGrafBundle&)
- IGrafBundle
- The attribute bundle to copy from.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 2
- Creates an IGrafBundle and adopts the given fill paint and frame paint.
public:
IGrafBundle( const IPaint& fillPaint,
const IPaint& framePaint,
IAttributeState::EDrawOperation attribute = kFillAndFrame )
- fillPaint
- The paint to be used for the fill.
- framePaint
- The paint to be used for the frame.
- kFillAndFrame
- By default, the drawing operation applies the first paint to the fill, and the second paint to the frame.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 3
- Creates an IGrafBundle of a specified color, which is to be used as a filled polygon with frame.
public:
IGrafBundle( const IBaseColor& fillColor,
const IBaseColor& frameColor,
IAttributeState::EDrawOperation attribute = kFillAndFrame )
- fillColor
- The color of the fill.
- frameColor
- The color of the frame.
- attribute
- By default, the drawing operation applies the first color to the fill, and the second color to the frame.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 4
- Creates an IGrafBundle, initialized with the data from the given attribute bundle.
public:
IGrafBundle(const IAttributeState&)
- IAttributeState
- The attribute bundle from which the initialization data is obtained.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 5
- Creates an IGrafBundle using the given fill paint, frame paint, or both, as specified by the second parameter.
public:
IGrafBundle( const IPaint& fPaint,
IAttributeState::EDrawOperation attribute = kFrame )
- fPaint
- The paint to be used for the fill or frame.
- kFrame
- By the default, the drawing operation applies the paint to the frame.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 6
- Default constructor with all attributes set to 0 (NIL).
public:
IGrafBundle()
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Overload 7
- Creates an IGrafBundle of a specified color, which is to be used as an empty frame.
public:
IGrafBundle( const IBaseColor& color,
IAttributeState::EDrawOperation attribute = kFrame )
- color
- The color of the frame.
- attribute
- By default, the drawing operation applies the color to the frame
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Assignment Operator
Use the operator in this group to assign the given graphics bundle object to the target one.
- operator =
public:
IGrafBundle& operator =(const IGrafBundle& source)
- Assignment operator.
- source
- The source bundle 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 compare the given IAttributeState object with the current IGrafBundle object for
equality.
- operator ==
public:
virtual bool operator ==(const IAttributeState&) const
- Tests two IAttributeState objects for equality.
- IAttributeState
- The IAttributeState to be compared with this one.
- Return
- True if this IGrafBundle and the argument have same attributes
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Getting the Graphic Bundles Attributes and Properties
Use the functions in this group to obtain the graphic bundle's attributes, such as the fill paint, transfer mode,
frma color, and so on.
- drawingOperation
public:
virtual IAttributeState::EDrawOperation
drawingOperation() const
- Returns the EDrawOperation that determines whether to paint the fill, the frame, or both.
- Return
- Returns the drawing operation.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- fillColor
public:
virtual const IBaseColor* fillColor() const
- Returns the color for the fill.
- Return
- A constant pointer to the fill.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- fillPaint
public:
virtual const IPaint* fillPaint() const
- Returns the paint used for the fill (the area within the frame).
- Return
- A constant pointer to the fill paint.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- fillTransferMode
public:
virtual const IColorTransferMode* fillTransferMode() const
- Returns the transfer mode for the fill.
- Return
- A constant pointer to the fill transfer mode.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- frameColor
public:
virtual const IBaseColor* frameColor() const
- Returns the frame color.
- Return
- A constant pointer to the frame color.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- frameEndCap
public:
virtual const ICap* frameEndCap() const
- Returns a constant pointer to the ICap that determines the frame end cap style (such as flush or square).
- Return
- A constant pointer to the frame end cap.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- frameJoint
public:
virtual const IJoint* frameJoint() const
- Returns a constant pointer to the frame joint style (such as round or miter).
- Return
- A constant pointer to the frame joint style.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- framePaint
public:
virtual const IPaint* framePaint() const
- Returns the paint used for the frame (the border of the graphic).
- Return
- A constant pointer to the frame paint.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- framePen
public:
virtual const IPen* framePen() const
- Returns the pen used to draw the border of the graphic.
- Return
- A constant pointer to the frame pen (NIL if no frame paint or pen has yet been specified).
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- frameTransferMode
public:
virtual const IColorTransferMode* frameTransferMode() const
- Returns the transfer mode for the frame.
- Return
- A constant pointer to the frame transfer mode (NIL if no frame paint or pen has yet been specified).
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- imageSampling
public:
virtual const IImageSamplingControl* imageSampling() const
- Returns a constant pointer to the IImageSamplingControl that determines how the image used for the fill or frame is sampled.
- Return
- A constant pointer to the object that stores the image sampling information.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- imageTransferMode
public:
virtual const IImageTransferMode* imageTransferMode() const
- Returns the transfer mode for an image after deleting the existing one.
- Return
- A constant pointer to the image transfer mode.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Removing Attribute Properties
Use the functions in this group to remove the graphic bundle's attributes, including the frame end cap, fill transfer
mode, fill paint, image transfer mode, and so on.
- removeFillPaint
public:
virtual void removeFillPaint()
- Delete the paint.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeFillTransferMode
public:
virtual void removeFillTransferMode()
- Delete the transfer mode for the fill.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeFrameEndCap
public:
virtual void removeFrameEndCap()
- Delete the frame end cap style.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeFrameJoint
public:
virtual void removeFrameJoint()
- Deletes the frame joint style.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeFramePaint
public:
virtual void removeFramePaint()
- Delete the frame paint.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeFramePen
public:
virtual void removeFramePen()
- Deletes the pen for the frame.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeFrameTransferMode
public:
virtual void removeFrameTransferMode()
- Deletes the frame transfer mode.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeImageSampling
public:
virtual void removeImageSampling()
- Deletes the image sampling control that determines how the image used for the fill or frame is sampled.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- removeImageTransferMode
public:
virtual void removeImageTransferMode()
- Delete the transfer mode for an image.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Setting Graphics Bundle Properties
Use the functions in this group to set the graphic bundle properties, such as the drawing operation to
be performed, the fill color, the fill paint, the fill transfer mode, and so on.
- setDrawingOperation
public:
virtual void
setDrawingOperation( IAttributeState::EDrawOperation )
- Specifies whether to paint the fill, the frame, or both.
- IAttributeState::EDrawOperation
- The desired drawing operation (kFrame, kFill, kFillAndFrame, or kUnset).
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFillColor
public:
virtual void setFillColor(const IBaseColor&)
- Sets the color for the fill.
- IBaseColor
- The fill color to be set.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFillPaint
public:
virtual void setFillPaint(const IPaint& paint)
- Sets the paint used for the fill (the area within the frame) after deleting the existing one.
- paint
- The paint from which the initialization data is to be obtained.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFillTransferMode
public:
virtual void setFillTransferMode(const IColorTransferMode&)
- Sets the transfer mode for the fill after deleting the existing one.
- IColorTransferMode
- The new fill transfer mode.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFrameColor
public:
virtual void setFrameColor(const IBaseColor&)
- Sets the frame color.
- IBaseColor
- The new frame color.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFrameEndCap
public:
virtual void setFrameEndCap(const ICap&)
- Sets the frame end cap style after deleting the existing one.
- ICap
- The new frame end cap style (such as flush or square).
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFrameJoint
public:
virtual void setFrameJoint(const IJoint&)
- Sets the frame joint style after deleting the existing one.
- IJoint
- The new frame joint style (such as round or miter).
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFramePaint
public:
virtual void setFramePaint(const IPaint& paint)
- Sets the frame paint after deleting the existing one.
- paint
- The new frame paint.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFramePen
public:
virtual void setFramePen(const IPen& pen)
- Sets the pen used to draw the border of the graphic after deleting the existing one.
- pen
- The new pen (in pixels) for the frame.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setFrameTransferMode
public:
virtual void
setFrameTransferMode( const IColorTransferMode& )
- Sets the frame transfer mode for the frame after deleting the existing one.
- IColorTransferMode
- The new frame transfer mode.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setImageSampling
public:
virtual void setImageSampling(const IImageSamplingControl&)
- Sets the image sampling control that determines how the image used for the fill or frame is sampled after deleting the existing one.
- IImageSamplingControl
- The new image sampling control.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
- setImageTransferMode
public:
virtual void
setImageTransferMode( const IImageTransferMode& )
- Sets the transfer mode for an image after deleting the existing one.
- IImageTransferMode
- The new image transfer mode.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
Streaming the Object In and Out
Use the functions in this group to read in the object from the specified stream and 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
- Writing the object out to the specified stream.
- toWhere
- The stream that the object is written out to.
- Supported Platforms
Windows |
OS/2 |
AIX |
Yes |
Yes |
Yes |
IGrafBundle - Inherited Member Functions and Data
Inherited Public Functions
- IAttributeState
-
virtual ~IAttributeState()
virtual EDrawOperation drawingOperation() const = 0
IAttributeState()
IAttributeState(const IAttributeState&)
bool operator !=(const IAttributeState& obj) const
IAttributeState& operator =(const IAttributeState&)
virtual bool operator ==(const IAttributeState& obj) const
virtual unsigned long timeStamp() const
- IMStreamable
-
- IGrafBundle
-
Inherited Public Data
Inherited Protected Functions
- IMStreamable
-
IMStreamable()
IMStreamable(const IMStreamable& other)
virtual void readFromStream(IDataStream& fromwhere) = 0
virtual void writeToStream(IDataStream& towhere) const = 0
- IAttributeState
-
Inherited Protected Data