Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions | Friends
IlvAbstractMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvAbstractMatrixItem:
IlvValueInterface IlvBitmapMatrixItem IlvDoubleMatrixItem IlvFloatMatrixItem IlvGadgetItemMatrixItem IlvGraphicMatrixItem IlvIntMatrixItem IlvLabelMatrixItem IlvFilledDoubleMatrixItem IlvFilledFloatMatrixItem IlvGadgetMatrixItem IlvFilledIntMatrixItem IlvFilledLabelMatrixItem

Public Member Functions

virtual IlvAbstractMatrixItemcopy () const
 Copies this object. More...
 
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 const char * getLabel () const
 Returns the label that identifies this 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 setLabel (const char *label, IlBoolean copy=IlTrue)
 Sets the label of the matrix item. More...
 
virtual void setPalette (IlvPalette *palette)
 Sets the palette of this matrix item. More...
 
virtual void write (IlvOutputFile &file) const
 Writes an object description to a file. More...
 

Static Public Member Functions

static IlvAbstractMatrixItemreadItem (IlvInputFile &file, IlvDisplay *display)
 Reads an object description from a file. More...
 

Friends

class IlvMatrix
 

Detailed Description

Matrix item class.

Library: ilvadvgdt

The objects stored in a matrix are called matrix items. To handle these objects, the IlvMatrix class uses the IlvAbstractMatrixItem class, which encapsulates the matrix item parameters and behavior. Most of the member functions of this class are virtual. Each item stored and displayed in a matrix must be an instance of a subclass of IlvAbstractMatrixItem. The default implementations of the setPalette(), setBackground(), setForeground(), setFont(), and setLabel() member functions in this abstract class, do nothing. Items may have specific client data. This data is managed at the IlvMatrix level by the member function IlvMatrix::getItemData and IlvMatrix::setItemData.

See also
IlvMatrix, IlvBitmapMatrixItem, IlvFilledFloatMatrixItem, IlvFilledIntMatrixItem, IlvFilledLabelMatrixItem, IlvFloatMatrixItem, IlvGadgetItemMatrixItem, IlvGadgetMatrixItem, IlvGraphicMatrixItem, IlvIntMatrixItem, IlvLabelMatrixItem, IlvIntMatrixItem.

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 IlvValueInterface and adds the following ones:

Name Return type Equivalent methods
copy() Object copy()

Member Function Documentation

§ copy()

virtual IlvAbstractMatrixItem* IlvAbstractMatrixItem::copy ( ) const
virtual

§ draw()

virtual void IlvAbstractMatrixItem::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
matrixThe matrix to which the item belongs.
colThe column where the matrix item is located.
rowThe row where the matrix item is located.
dstThe destination drawing port.
bboxThe bounding box of the matrix item.
clipThe clipping area.
See also
IlvAbstractMatrix::drawItem, drawLabel().

Reimplemented in IlvGadgetItemMatrixItem, IlvGadgetMatrixItem, IlvGraphicMatrixItem, IlvFilledDoubleMatrixItem, IlvFilledFloatMatrixItem, IlvFilledIntMatrixItem, IlvBitmapMatrixItem, and IlvFilledLabelMatrixItem.

§ drawLabel()

void IlvAbstractMatrixItem::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.

Parameters
labelThe label to be drawn.
matrixThe matrix to which the item belongs.
colThe column where the matrix item is located.
rowThe row where the matrix item is located.
dstThe destination drawing port.
bboxThe bounding box of the matrix item.
clipThe clipping area.
See also
IlvAbstractMatrix::drawItem, draw().

§ getLabel()

virtual const char* IlvAbstractMatrixItem::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 in IlvGadgetItemMatrixItem, IlvGadgetMatrixItem, IlvGraphicMatrixItem, IlvFilledDoubleMatrixItem, IlvFilledFloatMatrixItem, IlvDoubleMatrixItem, IlvFloatMatrixItem, IlvFilledIntMatrixItem, IlvIntMatrixItem, IlvBitmapMatrixItem, IlvFilledLabelMatrixItem, and IlvLabelMatrixItem.

§ handleSelectionDrawing()

virtual IlBoolean IlvAbstractMatrixItem::handleSelectionDrawing ( ) const
virtual

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 in IlvGadgetItemMatrixItem, and IlvGraphicMatrixItem.

§ minimumSize()

virtual void IlvAbstractMatrixItem::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
matrixThe matrix to which the item belongs.
widthThe returned preferred width of the item.
heightThe returned preferred height of the item.
See also
IlvMatrix::getColumnFittingSize(), IlvMatrix::getRowFittingSize().

Reimplemented in IlvGadgetItemMatrixItem, IlvGadgetMatrixItem, IlvGraphicMatrixItem, IlvFilledDoubleMatrixItem, IlvFilledFloatMatrixItem, IlvFilledIntMatrixItem, IlvBitmapMatrixItem, and IlvFilledLabelMatrixItem.

§ readItem()

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

MyClass::readItem(IlvInputFile& file, IlvDisplay* display)
{
return new MyClass(file, display);
}
Parameters
fileThe file to be read from.
displayThe display used to create the object.
See also
DeclareMatrixItemInfoRO(), DeclareMatrixItemInfo(), IlvPredefinedMatrixItemIOMembers().
Note
The readItem() method is not capitalized like other static methods so that it is consistent with the write() method.

§ setBackground()

virtual void IlvAbstractMatrixItem::setBackground ( IlvColor color)
virtual

§ setFont()

virtual void IlvAbstractMatrixItem::setFont ( IlvFont font)
virtual

§ setForeground()

virtual void IlvAbstractMatrixItem::setForeground ( IlvColor color)
virtual

§ setLabel()

virtual void IlvAbstractMatrixItem::setLabel ( const char *  label,
IlBoolean  copy = IlTrue 
)
virtual

Sets the label of the matrix item.

Parameters
labelThe label of the matrix item.
copySpecifies 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 in IlvGadgetItemMatrixItem, IlvGadgetMatrixItem, IlvGraphicMatrixItem, IlvFilledDoubleMatrixItem, IlvFilledFloatMatrixItem, IlvDoubleMatrixItem, IlvFloatMatrixItem, IlvFilledIntMatrixItem, IlvIntMatrixItem, IlvBitmapMatrixItem, IlvFilledLabelMatrixItem, and IlvLabelMatrixItem.

§ setPalette()

virtual void IlvAbstractMatrixItem::setPalette ( IlvPalette palette)
virtual

§ write()

virtual void IlvAbstractMatrixItem::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
fileThe name of the file to be written to.
See also
DeclareMatrixItemInfoRO(), DeclareMatrixItemInfo(), IlvPredefinedMatrixItemIOMembers().

Reimplemented in IlvGadgetItemMatrixItem, IlvGadgetMatrixItem, IlvGraphicMatrixItem, IlvFilledDoubleMatrixItem, IlvFilledFloatMatrixItem, IlvDoubleMatrixItem, IlvFloatMatrixItem, IlvFilledIntMatrixItem, IlvIntMatrixItem, IlvBitmapMatrixItem, IlvFilledLabelMatrixItem, and IlvLabelMatrixItem.


© Copyright 2017, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.