IlvBitmapMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvBitmapMatrixItem:

List of all members.

Public Member Functions
	IlvBitmapMatrixItem (IlvBitmap *bitmap, IlBoolean transparent=IlFalse, IlvPalette *palette=0)
	Constructor.
virtual IlvAbstractMatrixItem *	copy () const
	Copies this object.
virtual void	draw (const IlvMatrix *, IlUShort i, IlUShort j, IlvPort *dst, const IlvRect &bbox, const IlvRect *clip) const
	Is called to draw the matrix item.
IlvBitmap *	getBitmap () const
	Returns a pointer to the bitmap displayed by the matrix item.
virtual const char *	getLabel () const
	Returns the label that identifies this matrix item.
IlBoolean	isTransparent () const
	Indicates whether the bitmap displayed by the matrix item is transparent.
virtual void	minimumSize (const IlvMatrix *, IlvDim &w, IlvDim &h) const
	Returns the preferred size of the item.
virtual void	setBackground (IlvColor *)
	Sets the background color of this matrix item.
virtual void	setBitmap (IlvBitmap *bitmap)
	Sets the bitmap displayed by this matrix item.
virtual void	setForeground (IlvColor *)
	Sets the foreground color of this matrix item.
virtual void	setLabel (const char *, IlBoolean copy=IlTrue)
	Sets the label of the matrix item.
virtual void	setPalette (IlvPalette *)
	Sets the palette of this matrix item.
void	setTransparent (IlBoolean value)
	Specifies whether the bitmap displayed by the matrix item should be transparent.
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file.
Static Public Member Functions
static IlvAbstractMatrixItem *	readItem (IlvInputFile &, IlvDisplay *)
	Reads an object description from a file.

---

Detailed Description

Matrix item class.

Library: ilvadvgdt

Use this class to define a matrix item as a bitmap.

See also:

IlvBitmap, IlvMatrix.

---

Constructor & Destructor Documentation

IlvBitmapMatrixItem::IlvBitmapMatrixItem	(	IlvBitmap *	bitmap,
		IlBoolean	transparent = IlFalse,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the class IlvBitmapMatrixItem.

Parameters:

	bitmap	The bitmap displayed by the matrix item. This bitmap is locked.
	transparent	A Boolean specifying whether the bitmap should be transparent (IlTrue) or not (IlFalse).
	palette	The palette used to draw the bitmap.

---

Member Function Documentation

virtual IlvAbstractMatrixItem* IlvBitmapMatrixItem::copy

(

)

const [virtual]

Copies this object.

Allocates and returns a copy of this object.

Returns:

A copy of the object.

See also:

IlvPredefinedMatrixItemIOMembers.

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvBitmapMatrixItem::draw	(	const IlvMatrix *	matrix,
		IlUShort	col,
		IlUShort	row,
		IlvPort *	dst,
		const IlvRect &	bbox,
		const IlvRect *	clip
	)			const [virtual]

Is called to draw the matrix item.

The default implementation of the method calls IlvAbstractMatrixItem::drawLabel.

Parameters:

	matrix	The matrix to which the item belongs.
	col	The column where the matrix item is located.
	row	The row where the matrix item is located.
	dst	The destination drawing port.
	bbox	The bounding box of the matrix item.
	clip	The clipping area.

See also:

IlvAbstractMatrix::drawItem, drawLabel

Reimplemented from IlvAbstractMatrixItem.

IlvBitmap* IlvBitmapMatrixItem::getBitmap

(

)

const

Returns a pointer to the bitmap displayed by the matrix item.

Returns:

A pointer to the bitmap displayed by the matrix item.

See also:

setBitmap, IlvBitmap

virtual const char* IlvBitmapMatrixItem::getLabel

(

)

const [virtual]

Returns the label that identifies this matrix item.

Returns:

The label that identifies this matrix item. The returned string must not be deleted or modified.

See also:

setLabel

Reimplemented from IlvAbstractMatrixItem.

IlBoolean IlvBitmapMatrixItem::isTransparent

(

)

const

Indicates whether the bitmap displayed by the matrix item is transparent.

Returns:

IlTrue if the bitmap is transparent and IlFalse otherwise.

See also:

setTransparent, IlvBitmap::setTransparentColorIndex

virtual void IlvBitmapMatrixItem::minimumSize	(	const IlvMatrix *	matrix,
		IlvDim &	width,
		IlvDim &	height
	)			const [virtual]

Returns the preferred size of the item.

The preferred size is the size that the item must have for its content to be entirely visible. Uses width and height to return the preferred size of this item when stored in matrix. This method is called by the member functions IlvMatrix::getColumnFittingSize and IlvMatrix::getRowFittingSize.

Parameters:

	matrix	The matrix to which the item belongs.
	width	The returned preferred width of the item.
	height	The returned preferred height of the item.

See also:

IlvMatrix::getColumnFittingSize, IlvMatrix::getRowFittingSize

Reimplemented from IlvAbstractMatrixItem.

static IlvAbstractMatrixItem* IlvBitmapMatrixItem::readItem	(	IlvInputFile &	file,
		IlvDisplay *	display
	)			[static]

Reads an object description from a file.

Reads an object description from the file input. It reads the information that was saved by the member function write to be able to create a new instance of this object. Usually, because of the availability of the constructor that expects an IlvInputFile, readItem should be equivalent to :

 IlvAbstractMatrixItem*
 MyClass::readItem(IlvInputFile& file, IlvDisplay* display)
 {
     return new MyClass(file, display);
 }

Parameters:

	file	The file to be read from.
	display	The display used to create the object.

See also:

DeclareMatrixItemInfoRO, DeclareMatrixItemInfo, IlvPredefinedMatrixItemIOMembers.

Warning:

[note] The readItem method is not capitalized like other static methods so that it is consistent with the write method.

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvBitmapMatrixItem::setBackground

(

IlvColor *

color

)

[virtual]

Sets the background color of this matrix item.

The default implementation does nothing.

Parameters:

color

The new background color.

See also:

setPalette, setForeground, setFont, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvBitmapMatrixItem::setBitmap

(

IlvBitmap *

bitmap

)

[virtual]

Sets the bitmap displayed by this matrix item.

Parameters:

bitmap

The bitmap to be displayed by this matrix item. The old bitmap is unlocked, and the new one is locked.

See also:

getBitmap, IlvBitmap

virtual void IlvBitmapMatrixItem::setForeground

(

IlvColor *

color

)

[virtual]

Sets the foreground color of this matrix item.

The default implementation does nothing.

Parameters:

color

The new foreground color.

See also:

setPalette, setBackground, setFont, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvBitmapMatrixItem::setLabel	(	const char *	label,
		IlBoolean	copy = IlTrue
	)			[virtual]

Sets the label of the matrix item.

Parameters:

	label	The label of the matrix item.
	copy	A Boolean value specifying whether a label should be copied. If the value is IlFalse, then you must allocate some memory for the label because in any case the label characters are deleted from the memory by the IlvAbstractMatrixItem.

See also:

getLabel

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvBitmapMatrixItem::setPalette

(

IlvPalette *

palette

)

[virtual]

Sets the palette of this matrix item.

The default implementation does nothing.

Parameters:

palette

The new palette.

See also:

setBackground, setForeground, setFont, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

void IlvBitmapMatrixItem::setTransparent

(

IlBoolean

value

)

Specifies whether the bitmap displayed by the matrix item should be transparent.

Parameters:

value

A Boolean specifying whether the bitmap displayed by this matrix item should be transparent (IlTrue) or not (IlFalse).

See also:

isTransparent, IlvBitmap::setTransparentColorIndex

virtual void IlvBitmapMatrixItem::write

(

IlvOutputFile &

file

)

const [virtual]

Writes an object description to a file.

Writes out, in a file, the object description. This description contains all the information necessary to create an exact copy of this object by means of the member function readItem.

Parameters:

file

The name of the file to be written to.

See also:

DeclareMatrixItemInfoRO, DeclareMatrixItemInfo, IlvPredefinedMatrixItemIOMembers.

Reimplemented from IlvAbstractMatrixItem.