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

Matrix item class. More...

#include <ilviews/gadgets/matrix.h>

Inheritance diagram for IlvFloatMatrixItem:
IlvAbstractMatrixItem IlvValueInterface IlvFilledFloatMatrixItem

Public Member Functions

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

See also
IlvFilledFloatMatrixItem, IlvMatrix(IlFloat).

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 Float getFloat(), setFloat()
format String getFormat()

Constructor & Destructor Documentation

◆ IlvFloatMatrixItem()

IlvFloatMatrixItem::IlvFloatMatrixItem ( IlFloat  value)

Constructor.

Initializes a new instance of the class IlvFloatMatrixItem.

Parameters
valueThe floating-point value encapsulated by the matrix item.

Member Function Documentation

◆ copy()

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

◆ getFloat()

IlFloat IlvFloatMatrixItem::getFloat ( ) const

Returns the floating-point value stored in this matrix item.

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

◆ getFormat()

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

Returns the format used to display the floating-point value stored in the matrix item.

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

Returns
The format used to display the floating-point value stored in the matrix item.

◆ getLabel()

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

◆ setFloat()

void IlvFloatMatrixItem::setFloat ( IlFloat  value)

Sets the floating-point value stored in this matrix item.

Parameters
valueThe new floating-point value.
See also
getFloat().

◆ setLabel()

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

◆ write()

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