CATIAApplicationFrame CATDlgTableView

Usage: you must use this class as is. You should never derive it.


public class CATDlgTableView

Class to create a table in a scrollable view.

Role: This class constructs a table. Individual cells edition is allowed.


Constructor and Destructor Index


o CATDlgTableView(CATDlgFrame*,CATString&,int)
Constructs a table view.
o ~CATDlgTableView()

Method Index


o Draw()
Draws the table view.
o Edit(CATBaseUnknown_var,CATString&)
Creates a text editor as an in-cell editor.
o GetDeviceEvent()
Retrieves mouse events.
o GetMenu()
Gets contextual menu.
o GetRow(CATBaseUnknown_var)
Gets row count of an item.
o Invalidate()
Refreshes state and redraws view.
o SetColumnModel(CATBaseUnknown*)
Sets the column model of the table view.
o SetController(CATBaseUnknown*)
Sets the controller of the table view.
o SetModel(CATBaseUnknown*)
Sets the model of the table view.
o SetRowHeadersEnabled(CATBoolean)
Allows to draw row headers.
o UpdateHighlight(CATBaseUnknown_var)
Highlight/prehighlight changed.

Constructor and Destructor


o CATDlgTableView
public CATDlgTableView( iFather,
const iName,
iStyle= CATRightScroll|CATListSortable )
Constructs a table view.
Role: Constructs a table view.
Parameters:
iFather
[in] The parent frame.
iName
[in] The internal name of the table view.
iStyle
[in] The style of the table view. Legal values:
CATRightScroll
Style to display the scroll bar on the right of the view.
CATLeftScroll
Style to display the scroll bar on the left of the view.
CATListHeaderFullWidth
Style to have a list header up to the right. Without it, the list header ends a last column
CATListHeaderAlwaysVisible
Style to display the list header even on empty list
CATListSortable
Style to allow sort
o ~CATDlgTableView
public virtual ~CATDlgTableView()

Methods


o Draw
public Draw()
Draws the table view.
Role: Draws the table view.
o Edit
public Edit( iRow,
const iColumn)
Creates a text editor as an in-cell editor.
Role: Allows to edit the cell specified by iRow and iColumn.
Parameters:
iRow
[in] The Row containing the cell to edit.
iColumn
[in] ID of the column containing the cell.
o GetDeviceEvent
public GetDeviceEvent()
Retrieves mouse events.
Role: Gets event notification from the mouse. Describes the nature of the event and provides additionnal information specific to that event.
Returns:
Returns the mouse event.
o GetMenu
public GetMenu()
Gets contextual menu.
Role: Retrieves the view contextual menu, it can be accessed by right clicking the object. It offers context-dependent capabilities to the end-user.

Returns:
Returns the contextual menu
o GetRow
public GetRow( iRow)
Gets row count of an item.
Role: Gets row count of an item. Item should be visible for the method to work. This method must be used only on response to user interactions.
Parameters:
iRow
[in] The input item to get row count.
Returns:
Returns the row count corresponding to the item. Returns 0 if item not found (first row is 1).
o Invalidate
public Invalidate()
Refreshes state and redraws view.
Role: Refreshes state and redraws view.
o SetColumnModel
public SetColumnModel( model)
Sets the column model of the table view.
Role: Sets the model attached to the columns, the model may implement CATIDlgTableViewColumnModel.
Parameters:
model
[in] The model implementing CATIDlgTableViewColumnModel.
o SetController
public SetController( controller)
Sets the controller of the table view.
Role: Sets the controller of the table view. The controller processes and responds to events, user actions, and invokes changes on the model.
Parameters:
controller
[in] The table view controller.
o SetModel
public SetModel( model)
Sets the model of the table view.
Role: Sets the model of the table view. The model must implement CATIDlgTableViewModel. It represents the information on which the application operates.
Parameters:
model
[in] The model implementing CATIDlgTableViewModel. This model contains the data displayed by the table view.
o SetRowHeadersEnabled
public SetRowHeadersEnabled( enabled)
Allows to draw row headers.
Role: If enabled, row headers are drawn on the left side. They are disabled by default.
Parameters:
enabled
[in] TRUE to enable row headers, FALSE otherwise.
o UpdateHighlight
public UpdateHighlight( iItem)
Highlight/prehighlight changed.
Role: Update the highlighting status of the specified item.
Parameters:
iItem
[in] The item requiring an highlighting update.

This object is included in the file: CATDlgTableView.h
If needed, your Imakefile.mk should include the module: CATDlgView

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.