All Frameworks Class Hierarchy This Framework Indexes
CATIAApplicationFrame Interface CATIDlgTableViewController
Usage: you can reimplement this interface by deriving the supplied CATExtIDlgTableViewController adapter class.
interface CATIDlgTableViewController
Interface to retrieve data to be visualized through the CATDlgTableView component.
Role: Interface to retrieve data to be visualized through the CATDlgTableView component
Do not directly implement the CATIDlgTableViewController interface, but use the
CATExtIDlgTableViewController adapter and implement the needed methods.
BOA information: this interface cannot be implemented using the BOA (Basic Object Adapter).
To know more about the BOA, refer to the CAA Encyclopedia home page.
Click Middleware at the bottom left, then click the Object Modeler tab page.
Several articles deal with the BOA.
Method Index
- o
HasSelection(CATString&,CATBoolean&)
- Retrieves if the specified column contains a selected cell.
- o
IsPreSelected(CATBaseUnknown_var,CATString&,CATBoolean&)
- Retrieves if the specified cell is preselected.
- o
IsSelected(CATBaseUnknown_var,CATBoolean&)
- Retrieves if the specified line is selected.
- o
IsSelected(CATBaseUnknown_var,CATString&,CATBoolean&)
- Retrieves if the specified cell is selected.
- o
OnActivate(CATBaseUnknown_var)
- Method launched on the activation of the specified line.
- o
OnCellContext(CATBaseUnknown_var,CATString&)
- Method launched on a right-click over the specified cell by iRow and iColumn.
- o
OnColumnHeaderContext(CATString&)
- Method launched on a right-click over the specified column header.
- o
OnContext(CATBaseUnknown_var)
- Method launched on a right-click over the specified line.
- o
OnMoveOver(CATBaseUnknown_var,CATString&)
- Method launched on the move of the mouse over the cell specified by iRow and iColumn.
- o
OnRowHeaderContext(CATBaseUnknown_var)
- Method launched on a right-click over the specified row header.
- o
OnSelect(CATBaseUnknown_var,CATString&)
- Method launched on the selection of the cell specified by iRow and iColumn.
Methods
o HasSelection
| public virtual HasSelection( | const | iColumn, |
| | oHasSelection) |
-
Retrieves if the specified column contains a selected cell.
Role: Retrieves if the specified column contains a selected cell.
- Parameters:
-
- iColumn
- [in] The column to check.
- oHasSelection
- [out] Returns TRUE if a cell is selected in the specified column, FALSE otherwise.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o IsPreSelected
| public virtual IsPreSelected( | | iRow, |
| const | iColumn, |
| | oPreSelected) |
-
Retrieves if the specified cell is preselected.
Role: Retrieves if the specified cell is preselected.
- Parameters:
-
- iRow
- [in] The line containing the cell. This data must be serializable.
- iColumn
- [in] ID of the column containing the cell.
- oPreSelected
- [out] Returns TRUE if the cell is preselected, FALSE otherwise.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o IsSelected
| public virtual IsSelected( | | iRow, |
| | oSelected) |
-
Retrieves if the specified line is selected.
Role: Retrieves if the specified line is selected.
- Parameters:
-
- iRow
- [in] The line to check.
- oSelected
- [out] Returns TRUE if the specified line is selected, FALSE otherwise.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o IsSelected
| public virtual IsSelected( | | iRow, |
| const | iColumn, |
| | oSelected) |
-
Retrieves if the specified cell is selected.
Role: Retrieves if the specified cell is selected.
- Parameters:
-
- iRow
- [in] The line containing the cell. This data must be serializable.
- iColumn
- [in] ID of the column containing the cell.
- oSelected
- [out] Returns TRUE if the cell is selected, FALSE otherwise.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnActivate
| public virtual OnActivate( | | iRow) |
-
Method launched on the activation of the specified line.
Role: Method launched on the activation of the specified line.
- Parameters:
-
- iRow
- [in] The specified line. This data must be serializable.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnCellContext
| public virtual OnCellContext( | | iRow, |
| const | iColumn) |
-
Method launched on a right-click over the specified cell by iRow and iColumn.
Role: Method launched on a right-click over the specified cell by iRow and iColumn.
- Parameters:
-
- iRow
- [in] The line containing the cell. This data must be serializable.
- iColumn
- [in] ID of the column containing the cell.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnColumnHeaderContext
| public virtual OnColumnHeaderContext( | const | iColumn) |
-
Method launched on a right-click over the specified column header.
Role: Method launched on a right-click over the specified column header.
- Parameters:
-
- iColumn
- [in] ID of the specified column.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnContext
| public virtual OnContext( | | iRow) |
-
Method launched on a right-click over the specified line.
Role: Method launched on a right-click over the specified line.
- Parameters:
-
- iRow
- [in] The specified line. This data must be serializable.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnMoveOver
| public virtual OnMoveOver( | | iRow, |
| const | iColumn) |
-
Method launched on the move of the mouse over the cell specified by iRow and iColumn.
Role: Method launched on the move of the mouse over the cell specified
by iRow and iColumn.
- Parameters:
-
- iRow
- [in] The line containing the cell. This data must be serializable.
- iColumn
- [in] ID of the column containing the cell.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnRowHeaderContext
| public virtual OnRowHeaderContext( | | iRow) |
-
Method launched on a right-click over the specified row header.
Role: Method launched on a right-click over the specified row header.
- Parameters:
-
- iRow
- [in] The specified line.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
o OnSelect
| public virtual OnSelect( | | iRow, |
| const | iColumn) |
-
Method launched on the selection of the cell specified by iRow and iColumn.
Role: Method launched on the selection of the cell specified by iRow and iColumn.
- Parameters:
-
- iRow
- [in] The line containing the cell. This data must be serializable.
- iColumn
- [in] ID of the column containing the cell.
- Returns:
-
S_OK if everything ran ok, E_FAIL otherwise.
This object is included in the file: CATIDlgTableViewController.h
If needed, your Imakefile.mk should include the module: CATDlgView