Rogue Wave Views Gadgets Package API Reference Guide |
Rogue Wave Views Documentation Home |
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... | |
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.
IlvMatrixCoordinate
, IlvMatrixRowSelection
IlvMatrixSelection::IlvMatrixSelection | ( | ) |
Constructor.
Initializes a new instance of the class IlvMatrixSelection
.
Adds a matrix item to the current selection.
Adds a matrix item to the current selection.
row | The row of the matrix item. |
col | The column of the matrix item. |
Adds a matrix column to the current selection.
Adds a matrix column to the current selection.
col | The column of the matrix. |
rows | The row count of the matrix. |
Adds a matrix row to the current selection.
Adds a matrix row to the current selection.
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.
array | The array. |
count | The size of the array. |
|
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.
col | The column of the matrix. |
Updates the current selection after matrix columns are inserted.
Call this method to update the current selection when matrix columns are inserted.
col | The index of the first inserted column. |
count | The inserted row count. |
Removes a matrix item from the current selection.
Removes a matrix item from the current selection.
row | The row of the matrix item. |
col | The column of the matrix item. |
|
virtual |
Removes a matrix column from the current selection.
Removes a matrix column from the current selection.
col | The column of the matrix. |
|
virtual |
Removes a matrix row from the current selection.
Removes a matrix row from the current selection.
row | The row of the matrix. |
|
virtual |
Clears the current selection.
Clears the current selection.
IlvMatrixRowSelection* IlvMatrixSelection::getSelection | ( | ) | const |
Returns the first group of selected matrix items.
NULL
is returned. The returned object must be not deleted. 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.
count | Contains the size of the array. If the selection is empty then the value is 0 . |
NULL
is returned. Updates the current selection after a matrix item is deleted.
Call this method to update the current selection when a matrix item is deleted.
row | The row of the matrix item. |
col | The column of the matrix item. |
Replaces a matrix item.
Call this method to update the current selection when a matrix item is replaced by another.
row | The row of the matrix item. |
col | The column of the matrix item. |
|
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.
row | The row of the matrix item. |
Updates the current selection after matrix rows are inserted.
Call this method to update the current selection when matrix rows are inserted.
row | The index of the first inserted row. |
count | The inserted row count. |
|
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 |
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.
© Copyright 2016, 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.