IlvLabelMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvLabelMatrixItem:

List of all members.

Public Member Functions
	IlvLabelMatrixItem (const char *label, IlBoolean copy=IlTrue)
	Constructor.
virtual IlvAbstractMatrixItem *	copy () const
	Copies this object.
virtual const char *	getLabel () const
	Returns the label that identifies this matrix item.
virtual void	setLabel (const char *, IlBoolean copy=IlTrue)
	Sets the label of the matrix item.
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 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.

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

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.