IlvMatrixSelection Class Reference

Matrix selection manager class. More...

#include <ilviews/gadgets/matsel.h>

Public Member Functions
	IlvMatrixSelection ()
	Constructor. More...
virtual void	addSelection (IlUShort row, IlUShort col)
	Adds a matrix item to the current selection. More...
virtual void	addSelectionColumn (IlUShort col, IlUShort rows)
	Adds a matrix column to the current selection. More...
virtual void	addSelectionRow (IlUShort row, IlUShort cols)
	Adds a matrix row to the current selection. More...
void	cleanArraySelection (IlvMatrixCoordinate **array, IlUShort count)
	Frees an array of selected matrix items. More...
virtual void	columnDeleted (IlUShort col)
	Updates the current selection after a matrix column is deleted. More...
virtual void	columnInserted (IlUShort col, IlUShort count=1)
	Updates the current selection after matrix columns are inserted. More...
virtual void	delSelection (IlUShort row, IlUShort col)
	Removes a matrix item from the current selection. More...
virtual void	delSelectionColumn (IlUShort col)
	Removes a matrix column from the current selection. More...
virtual void	delSelectionRow (IlUShort row)
	Removes a matrix row from the current selection. More...
virtual void	deselectAll ()
	Clears the current selection. More...
IlvMatrixRowSelection *	getSelection () const
	Returns the first group of selected matrix items. More...
IlvMatrixCoordinate **	getSelection (IlUShort &count) const
	Returns an array of selected matrix items. More...
virtual void	itemDeleted (IlUShort row, IlUShort col)
	Updates the current selection after a matrix item is deleted. More...
virtual void	itemReplaced (IlUShort row, IlUShort col)
	Replaces a matrix item. More...
virtual void	rowDeleted (IlUShort row)
	Updates the current selection after a matrix row is deleted. More...
virtual void	rowInserted (IlUShort row, IlUShort count=1)
	Updates the current selection after matrix rows are inserted. More...
virtual void	startIgnoreNotification ()
	Stops updates to the selection. More...
virtual void	stopIgnoreNotification ()
	Restarts updates to the selection. More...

Detailed Description

Matrix selection manager class.

Library: ilvadvgdt

This class is used to manage the matrix selection. For each matrix event, there is a method to update the selection.

See also

IlvMatrixCoordinate, IlvMatrixRowSelection

Constructor & Destructor Documentation

IlvMatrixSelection()

IlvMatrixSelection::IlvMatrixSelection

(

)

Constructor.

Initializes a new instance of the class IlvMatrixSelection.

Member Function Documentation

addSelection()

virtual void IlvMatrixSelection::addSelection ( IlUShort  row, IlUShort  col  )

virtual

Adds a matrix item to the current selection.

Adds a matrix item to the current selection.

Parameters

row	The row of the matrix item.
col	The column of the matrix item.

addSelectionColumn()

virtual void IlvMatrixSelection::addSelectionColumn ( IlUShort  col, IlUShort  rows  )

virtual

Adds a matrix column to the current selection.

Adds a matrix column to the current selection.

Parameters

col	The column of the matrix.
rows	The row count of the matrix.

addSelectionRow()

virtual void IlvMatrixSelection::addSelectionRow ( IlUShort  row, IlUShort  cols  )

virtual

Adds a matrix row to the current selection.

Adds a matrix row to the current selection.

Parameters

row	The row of the matrix.
cols	The column count of the matrix.

cleanArraySelection()

void IlvMatrixSelection::cleanArraySelection	(	IlvMatrixCoordinate **	array,
		IlUShort	count
	)

Frees an array of selected matrix items.

This method is used to free an array which has been returned by the getSelection function.

Parameters

array	The array.
count	The size of the array.

columnDeleted()

virtual void IlvMatrixSelection::columnDeleted ( IlUShort  col )

virtual

Updates the current selection after a matrix column is deleted.

Call this method to update the current selection when a matrix column is deleted.

Parameters

col	The column of the matrix.

columnInserted()

virtual void IlvMatrixSelection::columnInserted ( IlUShort  col, IlUShort  count = 1  )

virtual

Updates the current selection after matrix columns are inserted.

Call this method to update the current selection when matrix columns are inserted.

Parameters

col	The index of the first inserted column.
count	The inserted row count.

delSelection()

virtual void IlvMatrixSelection::delSelection ( IlUShort  row, IlUShort  col  )

virtual

Removes a matrix item from the current selection.

Removes a matrix item from the current selection.

Parameters

row	The row of the matrix item.
col	The column of the matrix item.

delSelectionColumn()

virtual void IlvMatrixSelection::delSelectionColumn ( IlUShort  col )

virtual

Removes a matrix column from the current selection.

Removes a matrix column from the current selection.

Parameters

col	The column of the matrix.

delSelectionRow()

virtual void IlvMatrixSelection::delSelectionRow ( IlUShort  row )

virtual

Removes a matrix row from the current selection.

Removes a matrix row from the current selection.

Parameters

row	The row of the matrix.

deselectAll()

virtual void IlvMatrixSelection::deselectAll ( )

virtual

Clears the current selection.

Clears the current selection.

getSelection() [1/2]

IlvMatrixRowSelection* IlvMatrixSelection::getSelection

(

)

const

Returns the first group of selected matrix items.

Returns

The first group of selected matrix items. If the selection is empty then NULL is returned. The returned object must be not deleted.

getSelection() [2/2]

IlvMatrixCoordinate** IlvMatrixSelection::getSelection

(

IlUShort &

count

)

const

Returns an array of selected matrix items.

The array contains the coordinates of the selected matrix items. Each coordinate pair corresponds to a matrix item. You are responsible for the deletion of this array. Use the cleanArraySelection method to delete this array.

Parameters

count

Contains the size of the array. If the selection is empty then the value is 0.

Returns

An array of selected matrix items. If the selection is empty then NULL is returned.

itemDeleted()

virtual void IlvMatrixSelection::itemDeleted ( IlUShort  row, IlUShort  col  )

virtual

Updates the current selection after a matrix item is deleted.

Call this method to update the current selection when a matrix item is deleted.

Parameters

row	The row of the matrix item.
col	The column of the matrix item.

itemReplaced()

virtual void IlvMatrixSelection::itemReplaced ( IlUShort  row, IlUShort  col  )

virtual

Replaces a matrix item.

Call this method to update the current selection when a matrix item is replaced by another.

Parameters

row	The row of the matrix item.
col	The column of the matrix item.

rowDeleted()

virtual void IlvMatrixSelection::rowDeleted ( IlUShort  row )

virtual

Updates the current selection after a matrix row is deleted.

Call this method to update the current selection when a matrix row is deleted.

Parameters

row	The row of the matrix item.

rowInserted()

virtual void IlvMatrixSelection::rowInserted ( IlUShort  row, IlUShort  count = 1  )

virtual

Updates the current selection after matrix rows are inserted.

Call this method to update the current selection when matrix rows are inserted.

Parameters

row	The index of the first inserted row.
count	The inserted row count.

startIgnoreNotification()

virtual void IlvMatrixSelection::startIgnoreNotification ( )

virtual

Stops updates to the selection.

After calling this method, all updates to the selection are ignored and lost until a call to the stopIgnoreNotification method is made. If this method is called twice, the stopIgnoreNotification method must also be called twice to cancel the effects of this method.

stopIgnoreNotification()

virtual void IlvMatrixSelection::stopIgnoreNotification ( )

virtual

Restarts updates to the selection.

After calling this method, all updates to the selection are processed again if the number of calls to this method matches the number of calls to the startIgnoreNotification method.