Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvGadgetItemMatrixItem:

Public Member Functions
	IlvGadgetItemMatrixItem (IlvGadgetItem *item)
	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...

IlvGadgetItem *	getItem () const
	Returns a pointer to the gadget item stored in this matrix item. More...

virtual const char *	getLabel () const
	Returns the label that identifies this matrix item. 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	setFont (IlvFont *)
	Sets the font of 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...

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

Protected Member Functions
virtual IlBoolean	handleSelectionDrawing () const
	Indicates whether the selection drawing is handled by the matrix item. More...

Friends
class	IlvMatrix

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 gadget item.

See Also: IlvGadgetItem, IlvMatrix.

Constructor & Destructor Documentation

IlvGadgetItemMatrixItem::IlvGadgetItemMatrixItem ( IlvGadgetItem * item )

Constructor.

Initializes a new instance of the class IlvGadgetItemMatrixItem.

Parameters

item	The gadget item encapsulated by this matrix item.

Member Function Documentation

virtual IlvAbstractMatrixItem* IlvGadgetItemMatrixItem::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 IlvGadgetItemMatrixItem::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.

IlvGadgetItem* IlvGadgetItemMatrixItem::getItem ( ) const

Returns a pointer to the gadget item stored in this matrix item.

Returns: A pointer to the gadget item stored in this matrix item.

virtual const char* IlvGadgetItemMatrixItem::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.

virtual IlBoolean IlvGadgetItemMatrixItem::handleSelectionDrawing ( ) const

protectedvirtual

Indicates whether the selection drawing is handled by the matrix item.

Returns: IlTrue if the selection drawing is handled by the matrix item and not by the matrix to which it belongs. In this case, the member function IlvMatrix::drawSelection() is not called. The default implementation returns IlFalse.

See Also: IlvMatrix::drawSelection().

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvGadgetItemMatrixItem::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.

virtual void IlvGadgetItemMatrixItem::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 IlvGadgetItemMatrixItem::setFont ( IlvFont * font )

virtual

Sets the font of this matrix item.

The default implementation does nothing.

Parameters

font	The new font.

See Also: setPalette(), setForeground(), setBackground(), IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem.

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvGadgetItemMatrixItem::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 IlvGadgetItemMatrixItem::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.

virtual void IlvGadgetItemMatrixItem::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.

virtual void IlvGadgetItemMatrixItem::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.

Rogue Wave ViewsGadgets Package API Reference Guide

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Rogue Wave Views
Gadgets Package API Reference Guide