Views
Gadgets Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvDoubleMatrixItem Class Reference

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvDoubleMatrixItem:
IlvAbstractMatrixItem IlvValueInterface IlvFilledDoubleMatrixItem

Public Member Functions

 IlvDoubleMatrixItem (IlDouble value)
 Constructor. More...
 
virtual IlvAbstractMatrixItemcopy () const
 Copies this object. More...
 
IlDouble getDouble () const
 Returns the double-precision floating-point value stored in the matrix item. More...
 
virtual const char * getFormat () const
 Returns the format used to display the double-precision floating-point value. More...
 
virtual const char * getLabel () const
 Returns the label that identifies this matrix item. More...
 
void setDouble (IlDouble value)
 Sets the double-precision floating-point value stored in the 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 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 double-precision floating-point value.

See also
IlvFilledDoubleMatrixItem, IlvMatrix.

Accessors\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\n\nThis class inherits the accessors of its superclass \c IlvAbstractMatrixItem and adds the following ones:

Name Type Equivalent methods
label String getLabel(), setLabel()
value Double getDouble(), setDouble()
format String getFormat()

Constructor & Destructor Documentation

◆ IlvDoubleMatrixItem()

IlvDoubleMatrixItem::IlvDoubleMatrixItem ( IlDouble  value)

Constructor.

Initializes a new instance of the class IlvDoubleMatrixItem.

Parameters
valueThe double-precision floating-point value encapsulated by the item.

Member Function Documentation

◆ copy()

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

◆ getDouble()

IlDouble IlvDoubleMatrixItem::getDouble ( ) const

Returns the double-precision floating-point value stored in the matrix item.

Returns
The double-precision floating-point value stored in this matrix item.
See also
setDouble().

◆ getFormat()

virtual const char* IlvDoubleMatrixItem::getFormat ( ) const
virtual

Returns the format used to display the double-precision floating-point value.

The default implementation returns f. You can override this member function in a subclass to modify the format.

Returns
The format used to display the double-precision floating-point value of the matrix item.

◆ getLabel()

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

◆ setDouble()

void IlvDoubleMatrixItem::setDouble ( IlDouble  value)

Sets the double-precision floating-point value stored in the matrix item.

Parameters
valueThe new double-precision floating-point value.
See also
getDouble().

◆ setLabel()

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

Reimplemented in IlvFilledDoubleMatrixItem.

◆ write()

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

Reimplemented in IlvFilledDoubleMatrixItem.