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
IlvMatrixRowSelection Class Reference

Matrix row selection class. More...

#include <ilviews/gadgets/matsel.h>

Public Member Functions

 IlvMatrixRowSelection (IlUShort row=0, IlUShort col1=0, IlUShort col2=0)
 Constructor. More...
 
IlUShort getColumnCount () const
 Returns the selected matrix item count. More...
 
IlUShort getFirstColumn () const
 Returns the column of the first selected matrix item. More...
 
IlUShort getLastColumn () const
 Returns the column of the last selected matrix item. More...
 
IlUShort getRow () const
 Returns the row of the selected matrix item. More...
 

Detailed Description

Matrix row selection class.

Library: ilvadvgdt

This class is used to store selected matrix items from a row. If two selected items are separated by at least one unselected item, each selected item will be stored into a specific instance of IlvMatrixRowSelection.

See Also
IlvMatrixCoordinate, IlvMatrixSelection

Constructor & Destructor Documentation

IlvMatrixRowSelection::IlvMatrixRowSelection ( IlUShort  row = 0,
IlUShort  col1 = 0,
IlUShort  col2 = 0 
)

Constructor.

Initializes a new instance of the class IlvMatrixRowSelection.

Parameters
rowThe row of the selected matrix items.
col1The column of the first selected matrix item.
col2The column of the last selected matrix item. All items between columns col1 and col2 are also considered to be selected.

Member Function Documentation

IlUShort IlvMatrixRowSelection::getColumnCount ( ) const

Returns the selected matrix item count.

Returns
The selected matrix item count.
IlUShort IlvMatrixRowSelection::getFirstColumn ( ) const

Returns the column of the first selected matrix item.

Returns
The column of the first selected matrix item.
IlUShort IlvMatrixRowSelection::getLastColumn ( ) const

Returns the column of the last selected matrix item.

Returns
The column of the last selected matrix item.
IlUShort IlvMatrixRowSelection::getRow ( ) const

Returns the row of the selected matrix item.

Returns
The row of the selected matrix item.

© 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.