IlvBitmapMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvBitmapMatrixItem:

Public Member Functions
	IlvBitmapMatrixItem (IlvBitmap *bitmap, IlBoolean transparent=IlFalse, IlvPalette *palette=0)
	Constructor. More...
virtual IlvAbstractMatrixItem *	copy () const
	Copies this object. More...
virtual void	draw (const IlvMatrix *, IlUShort, IlUShort, IlvPort *, const IlvRect &, const IlvRect *) const
	Is called to draw the matrix item. More...
IlvBitmap *	getBitmap () const
	Returns a pointer to the bitmap displayed by the matrix item. More...
virtual const char *	getLabel () const
	Returns the label that identifies this matrix item. More...
IlBoolean	isTransparent () const
	Indicates whether the bitmap displayed by the matrix item is transparent. More...
virtual void	minimumSize (const IlvMatrix *, IlvDim &, IlvDim &) const
	Returns the preferred size of the item. More...
virtual void	setBackground (IlvColor *)
	Sets the background color of this matrix item. More...
virtual void	setBitmap (IlvBitmap *bitmap)
	Sets the bitmap displayed by this matrix item. More...
virtual void	setForeground (IlvColor *)
	Sets the foreground color of this matrix item. More...
virtual void	setLabel (const char *, IlBoolean copy=IlTrue)
	Sets the label of the matrix item. More...
virtual void	setPalette (IlvPalette *)
	Sets the palette of this matrix item. More...
void	setTransparent (IlBoolean val)
	Specifies whether the bitmap displayed by the matrix item should be transparent. More...
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file. More...
Public Member Functions inherited from IlvAbstractMatrixItem
void	drawLabel (const char *label, const IlvMatrix *matrix, IlUShort col, IlUShort row, IlvPort *dst, const IlvRect &bbox, const IlvRect *clip=0) const
	Is called to draw the label of the matrix item. More...
virtual IlBoolean	handleSelectionDrawing () const
	Indicates whether the selection drawing is handled by the matrix item. More...
virtual void	setFont (IlvFont *font)
	Sets the font of this matrix item. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvAbstractMatrixItem
static IlvAbstractMatrixItem *	readItem (IlvInputFile &file, IlvDisplay *display)
	Reads an object description from a file. More...

Detailed Description

Matrix item class.

Library: ilvadvgdt

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

See also

IlvBitmap, IlvMatrix.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class inherits the accessors of its superclass IlvAbstractMatrixItem and adds the following ones:

Name	Type	Equivalent methods
foreground	Color	setForeground()
background	Color	setBackground()
bitmap	Bitmap	setBitmap()
transparent	Boolean	isTransparent(), setTransparent()

Constructor & Destructor Documentation

IlvBitmapMatrixItem()

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	Specifies whether the bitmap should be transparent (IlTrue) or not (IlFalse).
palette	The palette used to draw the bitmap.

Member Function Documentation

copy()

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.

draw()

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.

getBitmap()

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.

getLabel()

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.

isTransparent()

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().

minimumSize()

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.

setBackground()

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.

setBitmap()

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.

setForeground()

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.

setLabel()

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

setPalette()

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.

setTransparent()

void IlvBitmapMatrixItem::setTransparent

(

IlBoolean

val

)

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

Parameters

val	Specifies whether the bitmap displayed by this matrix item should be transparent (IlTrue) or not (IlFalse).

See also

isTransparent(), IlvBitmap::setTransparentColorIndex().

write()

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.