IlvMatrixSelection Class Reference

Matrix selection manager class. More...

#include <ilviews/gadgets/matsel.h>

List of all members.

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

---

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

(

)

Constructor.

Initializes a new instance of the class IlvMatrixSelection.

---

Member Function Documentation

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.

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.

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.

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.

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.

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.

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.

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.

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.

virtual void IlvMatrixSelection::deselectAll

(

)

[virtual]

Clears the current selection.

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.

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.

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.

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.

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.

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.

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.

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.