IlvLabelMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvLabelMatrixItem:

Public Member Functions
	IlvLabelMatrixItem (const char *label, IlBoolean copy=IlTrue)
	Constructor. More...
virtual IlvAbstractMatrixItem *	copy () const
	Copies this object. More...
virtual const char *	getLabel () const
	Returns the label that identifies this matrix item. More...
virtual void	setLabel (const char *, IlBoolean copy=IlTrue)
	Sets the label of the matrix item. More...
virtual void	write (IlvOutputFile &) const
	Writes an object description to a file. More...
Public Member Functions inherited from IlvAbstractMatrixItem
virtual void	draw (const IlvMatrix *matrix, IlUShort col, IlUShort row, IlvPort *dst, const IlvRect &bbox, const IlvRect *clip) const
	Is called to draw the matrix item. More...
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	minimumSize (const IlvMatrix *matrix, IlvDim &width, IlvDim &height) const
	Returns the preferred size of the item. More...
virtual void	setBackground (IlvColor *color)
	Sets the background color of this matrix item. More...
virtual void	setFont (IlvFont *font)
	Sets the font of this matrix item. More...
virtual void	setForeground (IlvColor *color)
	Sets the foreground color of this matrix item. More...
virtual void	setPalette (IlvPalette *palette)
	Sets the palette 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 label.

See Also

IlvFilledLabelMatrixItem, IlvMatrix.

Constructor & Destructor Documentation

IlvLabelMatrixItem::IlvLabelMatrixItem	(	const char *	label,
		IlBoolean	copy = IlTrue
	)

Constructor.

Initializes a new instance of the class IlvLabelMatrixItem.

Parameters

label	The matrix item label.
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 IlvLabelMatrixItem.

Member Function Documentation

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

Reimplemented in IlvFilledLabelMatrixItem.

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

Reimplemented in IlvFilledLabelMatrixItem.

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

Reimplemented in IlvFilledLabelMatrixItem.

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

Reimplemented in IlvFilledLabelMatrixItem.