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

Matrix coordinate class. More...

#include <ilviews/gadgets/matsel.h>

Public Member Functions

 IlvMatrixCoordinate (IlUShort row=0, IlUShort col=0)
 Constructor. More...
 
IlUShort getColumn () const
 Returns the column of the selected matrix item. More...
 
IlvAbstractMatrixItemgetItem (const IlvMatrix *matrix) const
 Returns the selected matrix item. More...
 
IlUShort getRow () const
 Returns the row of the selected matrix item. More...
 

Detailed Description

Matrix coordinate class.

Library: ilvadvgdt

This class is used to store the coordinates of the IlvMatrix item which is selected.

See also
IlvMatrixRowSelection, IlvMatrixSelection

Constructor & Destructor Documentation

◆ IlvMatrixCoordinate()

IlvMatrixCoordinate::IlvMatrixCoordinate ( IlUShort  row = 0,
IlUShort  col = 0 
)

Constructor.

Initializes a new instance of the class IlvMatrixCoordinate.

Parameters
rowThe row of the selected matrix item.
colThe column of the selected matrix item.

Member Function Documentation

◆ getColumn()

IlUShort IlvMatrixCoordinate::getColumn ( ) const

Returns the column of the selected matrix item.

Returns
The column of the selected matrix item.

◆ getItem()

IlvAbstractMatrixItem* IlvMatrixCoordinate::getItem ( const IlvMatrix matrix) const

Returns the selected matrix item.

Parameters
matrixThe matrix which contains the matrix item.
Returns
The selected matrix item.

◆ getRow()

IlUShort IlvMatrixCoordinate::getRow ( ) const

Returns the row of the selected matrix item.

Returns
The row of the selected matrix item.