rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Gadgets Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvFilledLabelMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvFilledLabelMatrixItem:
IlvLabelMatrixItem IlvAbstractMatrixItem

Public Member Functions

 IlvFilledLabelMatrixItem (IlvPalette *palette, const char *label, IlBoolean copy=IlTrue)
 Constructor. More...
 
 IlvFilledLabelMatrixItem (IlvMatrix *matrix, const char *label, IlBoolean copy=IlTrue)
 Constructor. More...
 
 IlvFilledLabelMatrixItem (const char *label, IlvPalette *palette, IlvPalette *invpal, IlBoolean copy=IlTrue)
 Constructor. More...
 
virtual IlvAbstractMatrixItemcopy () const
 Copies this object. More...
 
virtual void draw (const IlvMatrix *, IlUShort i, IlUShort j, IlvPort *dst, const IlvRect &bbox, const IlvRect *clip) const
 Is called to draw the matrix item. More...
 
IlvPalettegetInvertedPalette () const
 Returns the palette used to display this matrix item when it is selected. More...
 
virtual const char * getLabel () const
 Returns the label that identifies this matrix item. More...
 
IlvPalettegetPalette () const
 Returns the palette used to display this matrix item. More...
 
virtual void minimumSize (const IlvMatrix *, IlvDim &w, IlvDim &h) 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 *)
 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 *, 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 &) const
 Writes an object description to a file. More...
 
- Public Member Functions inherited from IlvLabelMatrixItem
 IlvLabelMatrixItem (const char *label, IlBoolean copy=IlTrue)
 Constructor. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvAbstractMatrixItem
static IlvAbstractMatrixItemreadItem (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 with a filled background.

See Also
IlvMatrix, IlvPalette.

Constructor & Destructor Documentation

IlvFilledLabelMatrixItem::IlvFilledLabelMatrixItem ( IlvPalette palette,
const char *  label,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the class IlvFilledLabelMatrixItem.

Parameters
paletteThe matrix item palette.
labelThe matrix item label.
copyA 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 IlvFilledLabelMatrixItem.
IlvFilledLabelMatrixItem::IlvFilledLabelMatrixItem ( IlvMatrix matrix,
const char *  label,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the class IlvFilledLabelMatrixItem.

Parameters
matrixThe matrix to which the item belongs. This parameter is used to compute the matrix item palette.
labelThe matrix item label.
copyA 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 IlvFilledLabelMatrixItem.
IlvFilledLabelMatrixItem::IlvFilledLabelMatrixItem ( const char *  label,
IlvPalette palette,
IlvPalette invpal,
IlBoolean  copy = IlTrue 
)

Constructor.

Initializes a new instance of the class IlvFilledLabelMatrixItem.

Parameters
labelThe matrix item label.
paletteThe matrix item palette.
invpalThe inverted palette used by the matrix item when it is selected. When using other constructors, the inverted palette is automatically computed from the matrix item palette.
copyA 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 IlvFilledLabelMatrixItem.

Member Function Documentation

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

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

IlvPalette* IlvFilledLabelMatrixItem::getInvertedPalette ( ) const

Returns the palette used to display this matrix item when it is selected.

Returns
The palette used to display this matrix item when it is selected.
See Also
getPalette
virtual const char* IlvFilledLabelMatrixItem::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 IlvLabelMatrixItem.

IlvPalette* IlvFilledLabelMatrixItem::getPalette ( ) const

Returns the palette used to display this matrix item.

Returns
The palette used to display this matrix item.
See Also
getInvertedPalette
virtual void IlvFilledLabelMatrixItem::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 from IlvAbstractMatrixItem.

virtual void IlvFilledLabelMatrixItem::setBackground ( IlvColor color)
virtual

Sets the background color of this matrix item.

The default implementation does nothing.

Parameters
colorThe new background color.
See Also
setPalette, setForeground, setFont, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvFilledLabelMatrixItem::setFont ( IlvFont font)
virtual

Sets the font of this matrix item.

The default implementation does nothing.

Parameters
fontThe new font.
See Also
setPalette, setForeground, setBackground, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

virtual void IlvFilledLabelMatrixItem::setForeground ( IlvColor color)
virtual

Sets the foreground color of this matrix item.

The default implementation does nothing.

Parameters
colorThe new foreground color.
See Also
setPalette, setBackground, setFont, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

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

Sets the label of the matrix item.

Parameters
labelThe label of the matrix item.
copyA 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 IlvLabelMatrixItem.

virtual void IlvFilledLabelMatrixItem::setPalette ( IlvPalette palette)
virtual

Sets the palette of this matrix item.

The default implementation does nothing.

Parameters
paletteThe new palette.
See Also
setBackground, setForeground, setFont, IlvFilledLabelMatrixItem, IlvFilledIntMatrixItem, IlvFilledFloatMatrixItem, IlvFilledDoubleMatrixItem

Reimplemented from IlvAbstractMatrixItem.

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


© Copyright 2012, 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.