All Frameworks  Class Hierarchy  This Framework  Indexes   

CATIAApplicationFrame Interface CATIDlgTableViewModel

Usage: you can reimplement this interface by deriving the supplied CATExtIDlgTableViewModel adapter class.


interface CATIDlgTableViewModel

Interface to retrieve data to be visualized through the CATDlgTableView component.
Role: .

The goal of this interface is to provide You should implement the CATIDlgTableViewModel interface, for each model 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 GetBackgroundColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Retrieves the cell background color for all cells of given style
Role: Style possible value are : OK, Normal, Warning, Error, Highlight, SubHighlight input : Default color value ouput : new color value.
o GetBackgroundColor(CATBaseUnknown_var,CATString&,unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Retrieves the cell background color for the cell defined by iLine, iColumn.
o GetEventPublisher(CATBaseUnknown**)
Retrieves the Event publisher that dispatches the update events when the view needs to be updated.
o GetIcon(CATBaseUnknown_var,CATString&,CATUnicodeString&)
Retrieves the icon content of the cell defined by iLine, iColumn.
o GetLabel(CATBaseUnknown_var&,CATString&,CATUnicodeString&)
Retrieves the text content of the cell defined by iLine, iColumn.
o GetLineCount(int&)
retrieves the total number of lines that can be displayed.
o GetLines(int,int,CATListOfCATBaseUnknown_var&)
Retrieves iCount lines from line number iStart.
o GetStyle(CATBaseUnknown_var,CATString&,CATDlgTableStyle&)
Retrieves the cell style combination.
o GetTextColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Retrieves the cell background color for all cells of given style.
o GetTextColor(CATBaseUnknown_var,CATString&,unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Retrieves the cell text color for the cell defined by iLine, iColumn.
o GetUpdateEvent(CATCallbackEvent*)
Retrieves the event dispatched by the model when the view needs to be updated.
o IsEditable(CATBaseUnknown_var&,CATString&,CATBoolean&)
Indicates if the pointed cell can be edited.
o SetLabel(CATBaseUnknown_var&,CATString&,CATUnicodeString&)
Sets the text entered by the user.

Methods


o GetBackgroundColor
public virtual GetBackgroundColor( iStyle,
ioRed,
ioGreen,
ioBlue,
ioAlpha)
Retrieves the cell background color for all cells of given style
Role: Style possible value are : OK, Normal, Warning, Error, Highlight, SubHighlight input : Default color value ouput : new color value. Leave value unchanged to keep default colors
Parameters:
iStyle
[in] The searched cell style. The possible values are:
  • CATDlgTableLeftJustify |
  • CATDlgTableRightJustify |- Horizontal cell alignement
  • CATDlgTableCenterJustify |
  • CATDlgTableTopJustify |
  • CATDlgTableBottomJustify |- Vertical cell alignement
  • CATDlgTableMiddleJustify |
  • CATDlgTableCellOK | OK cell style
  • CATDlgTableCellNormal | Normal cell style
  • CATDlgTableCellWarning | Warning cell style
  • CATDlgTableCellError | Error cell style
  • CATDlgTableCellCustom | Custom cell style
ioRed
[inout] It defines the red component of the background color.The value ranges from 0 to 255.
ioGreen
[inout] It defines the green component of the background color.The value ranges from 0 to 255.
ioBlue
[inout] It defines the blue component of the background color.The value ranges from 0 to 255.
ioAlpha
[inout] Not supported.
o GetBackgroundColor
public virtual GetBackgroundColor( iLine,
const iColumnID,
ioRed,
ioGreen,
ioBlue,
ioAlpha)
Retrieves the cell background color for the cell defined by iLine, iColumn.
Role: This method is not called if the cells does not have the style CustomColor. input : Default color value ouput : New color value. Leave value unchanged to keep default colors
Parameters:
iLine
[in] The line containing the cell.
iColumnID
[in] ID of the column containing the cell.
ioRed
[inout] It defines the red component of the background color.The value ranges from 0 to 255.
ioGreen
[inout] It defines the green component of the background color.The value ranges from 0 to 255.
ioBlue
[inout] It defines the blue component of the background color.The value ranges from 0 to 255.
ioAlpha
[inout] Not supported.
o GetEventPublisher
public virtual GetEventPublisher( oTableModelEventPublisher)
Retrieves the Event publisher that dispatches the update events when the view needs to be updated.
Role: Retrieves the Event publisher that dispatches the update events when the view needs to be updated. The view subscribes to this publiser on the UpdateEvent.
Parameters:
oTableModelEventPublisher
[out] The event publisher that dispatches the update events.
Returns:
S_OK if everything ran ok.
o GetIcon
public virtual GetIcon( iLine,
const iColumn,
oIcon)
Retrieves the icon content of the cell defined by iLine, iColumn.
Role: Retrieves the icon content of the cell defined by iLine, iColumn.
Parameters:
iLine
[in] The line containing the cell. This data must be serializable.
iColumn
[in] ID of the column containing the cell.
oIcon
[out] The Icon's ID.
Returns:
S_OK if everything ran ok.
o GetLabel
public virtual GetLabel( iLine,
const iColumn,
oLabel)
Retrieves the text content of the cell defined by iLine, iColumn.
Role: Retrieves the text content of the cell defined by iLine, iColumn.
Parameters:
iLine
[in] The line containing the cell. This data must be serializable.
iColumn
[in] ID of the column containing the cell.
oLabel
[out] The text content of the pointed cell.
Returns:
S_OK if everything ran ok.
o GetLineCount
public virtual GetLineCount( oLineCount)
retrieves the total number of lines that can be displayed.
Role: retrieves the total number of lines that can be displayed.
Parameters:
oLineCount
[out] The number of lines that can be displayed.
Returns:
S_OK if everything ran ok.
o GetLines
public virtual GetLines( iStart,
iCount,
oLines)
Retrieves iCount lines from line number iStart.
Role: Retrieves iCount lines from line number iStart.
Parameters:
iStart
[in] Number of the first line to be retrieved.
iCount
[in] Integer, number of lines to be retrieved.
oLines
[out] List of the retrieved iCount lines.
Returns:
S_OK if everything ran ok.
o GetStyle
public virtual GetStyle( iLine,
const iColumnID,
oStyle)
Retrieves the cell style combination.
Role: Retrieves the cell style combination. The style are cumulated by logical or.
Parameters:
iLine
[in] The line containing the cell. This data must be serializable.
iColumnID
[in] ID of the column containing the cell.
oStyle
[out] The cell style, available styles are :
  • CATDlgTableLeftJustify |
  • CATDlgTableRightJustify |- for text horizontal alignement
  • CATDlgTableCenterJustify |
  • CATDlgTableTopJustify |
  • CATDlgTableBottomJustify |- for text vertical alignement
  • CATDlgTableMiddleJustify |
  • CATDlgTableCellOK | OK cell style |
  • CATDlgTableCellNormal | Normal cell style |
  • CATDlgTableCellWarning | Warning cell style | - for cell color
  • CATDlgTableCellError | Error cell style |
  • CATDlgTableCellCustom | Custom cell style |
Default value is: CATDlgTableLeftJustify | CATDlgTableMiddleJustify | CATDlgTableCellNormal
Returns:
S_OK if everything ran ok.
o GetTextColor
public virtual GetTextColor( iStyle,
ioRed,
ioGreen,
ioBlue,
ioAlpha)
Retrieves the cell background color for all cells of given style.
Role: Retrieves the cell background color for all cells of given style. input : Default color value ouput : new color value. Leave value unchanged to keep default colors
Parameters:
iStyle
[in] The searched cell style. The possible values are:
  • CATDlgTableLeftJustify |
  • CATDlgTableRightJustify |- Horizontal cell alignement
  • CATDlgTableCenterJustify |
  • CATDlgTableTopJustify |
  • CATDlgTableBottomJustify |- Vertical cell alignement
  • CATDlgTableMiddleJustify |
  • CATDlgTableCellOK | OK cell style
  • CATDlgTableCellNormal | Normal cell style
  • CATDlgTableCellWarning | Warning cell style
  • CATDlgTableCellError | Error cell style
  • CATDlgTableCellCustom | Custom cell style
ioRed
[inout] It defines the red component of the text color.The value ranges from 0 to 255.
ioGreen
[inout] It defines the green component of the text color.The value ranges from 0 to 255.
ioBlue
[inout] It defines the blue component of the text color.The value ranges from 0 to 255.
ioAlpha
[inout] Not supported.
o GetTextColor
public virtual GetTextColor( iLine,
const iColumn,
ioRed,
ioGreen,
ioBlue,
ioAlpha)
Retrieves the cell text color for the cell defined by iLine, iColumn.
Role: Retrieves the cell text color for the cell defined by iLine, iColumn. This method is not called if the cells does not have the style CustomColor input : Default color value ouput : new color value. Leave value unchanged to keep default colors
Parameters:
iLine
[in] The line containing the cell. This data must be serializable.
iColumn
[in] ID of the column containing the cell.
ioRed
[inout] It defines the red component of the text color.The value ranges from 0 to 255.
ioGreen
[inout] It defines the green component of the text color.The value ranges from 0 to 255.
ioBlue
[inout] It defines the blue component of the text color.The value ranges from 0 to 255.
ioAlpha
[inout] Not supported
Returns:
S_OK if everything ran ok, otherwise...
o GetUpdateEvent
public virtual GetUpdateEvent( oUpdateEvent)
Retrieves the event dispatched by the model when the view needs to be updated.
Role: Retrieves the event dispatched by the model when the view needs to be updated.
Parameters:
oUpdateEvent
[out] The event dispatched by the model
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o IsEditable
public virtual IsEditable( iLine,
const iColumn,
oEditable)
Indicates if the pointed cell can be edited.
Role: Indicates if the pointed cell can be edited.
Parameters:
iLine
[in] The line containing the cell. This data must be serializable.
iColumn
[in] ID of the column containing the cell.
oEditable
[out] CATBoolean indicating the pointed cell's editability. Returns true if the cell can be edited by user
Returns:
S_OK if everything ran ok.
o SetLabel
public virtual SetLabel( iLine,
const iColumn,
const iLabel)
Sets the text entered by the user.
Role: Sets the text entered by the user. This method is not called if the cell cannot be edited.
Parameters:
iLine
[in] The line containing the cell. This data must be serializable.
iColumn
[in] ID of the column containing the cell.
iLabel
[in] The text to set the content of the pointed cell.
Returns:
S_OK if everything ran ok.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.