CATIAApplicationFrame CATExtIDlgTableViewColumnModel

Usage: you can derive this class.

public class CATExtIDlgTableViewColumnModel

Adapter for the CATIDlgTableViewColumnModel interface.

Role : Adapter for the CATIDlgTableViewColumnModel interface.

To implement the interface CATIDlgTableViewColumnModel for a class MyClass, write a class MyClassExtIDlgTableViewColumnModel subclassed from CATExtIDlgTableViewColumnModel and defined as an data extension of MyClass. MyClassExtIDlgTableViewColumnModel may override various methods, but in most case there is nothing to do.

Constructor and Destructor Index


o CATExtIDlgTableViewColumnModel(void)
Constructs the class.
o ~CATExtIDlgTableViewColumnModel(void)

Method Index


o GetBackgroundColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Retreives the background color for all column header of the given style.
o GetLabel(CATString&,CATUnicodeString&)
Retrieves column header text.
o GetOrderedColumns(CATListOfCATString&)
Retreives the list of columns to be displayed in the CATDlgTableView.
o GetStyle(CATString&,CATDlgTableStyle&)
Retreives the column's label style.
o GetTextColor(CATDlgTableStyle,unsigned int&,unsigned int&,unsigned int&,unsigned int&)
Retreives the text color for all column header of the given style.
o GetWidth(CATString&,int&)
Retrieves the column's width.
o SetOrderedColumns(CATListOfCATString&)
Sets the new order of the columns.
o SetVisibility(CATString&,CATDlgTableStyle)
Sets a column visibility.
o SetWidth(CATString&,int)
Sets the column's width.

Constructor and Destructor


o CATExtIDlgTableViewColumnModel
public CATExtIDlgTableViewColumnModel( )
Constructs the class.
o ~CATExtIDlgTableViewColumnModel
public virtual ~CATExtIDlgTableViewColumnModel( )

Methods


o GetBackgroundColor
public virtual GetBackgroundColor( iStyle,
ioRed,
ioGreen,
ioBlue,
ioAlpha)
Retreives the background color for all column header of the given style.
Role: Retreives the background color for all column header of the given style. input : Default color value ouput : new color value. Leave value unchanged to keep default colors
Parameters:
iStyle
[in] The searched style. The possible values are: Normal, Highlight, SubHighlight.
ioRed
[inout] It defines the red component of the border color.The value ranges from 0 to 255.
ioGreen
[inout] It defines the green component of the border color.The value ranges from 0 to 255.
ioBlue
[inout] It defines the blue component of the border color.The value ranges from 0 to 255.
ioAlpha
[inout] Not supported.
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o GetLabel
public virtual GetLabel( const iColumn,
oLabel)
Retrieves column header text.
Role: Retrieves a column's label from the column's ID.
Parameters:
iColumn
[in] The column ID.
oLabel
[out] The column's label.
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o GetOrderedColumns
public virtual GetOrderedColumns( oColumns)
Retreives the list of columns to be displayed in the CATDlgTableView.
Role: Gets columns order.
Parameters:
oColumns
[out] The list of the column ID in order.
Returns:
S_OK if everything ran ok, E_FAILotherwise.
o GetStyle
public virtual GetStyle( const iColumn,
oStyle)
Retreives the column's label style.
Role: Retrieves the column's label style from the column's ID.
Parameters:
iColumn
[in] The column ID.
oStyle
[out] The style of the column's label, this style could be a combination of different styles:
  • CATDlgTableLeftJustify |
  • CATDlgTableRightJustify |- Horizontal cell alignement
  • CATDlgTableCenterJustify |
  • CATDlgTableTopJustify |
  • CATDlgTableBottomJustify |- Vertical cell alignement
  • CATDlgTableMiddleJustify |
  • CATDlgTableColumnVisible |- for column visibility management
  • CATDlgTableColumnHidden |
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o GetTextColor
public virtual GetTextColor( iStyle,
ioRed,
ioGreen,
ioBlue,
ioAlpha)
Retreives the text color for all column header of the given style.
Role: Retrieves the text color for all cells of a given style. input : Default color value ouput : new color value. Leave value unchanged to keep default colors
Parameters:
iStyle
[in] The searched style, this style could be: Normal, Highlight, SubHighlight.
ioRed
[inout] It defines the red component of the border color.The value ranges from 0 to 255.
ioGreen
[inout] It defines the green component of the border color.The value ranges from 0 to 255.
ioBlue
[inout] It defines the blue component of the border color.The value ranges from 0 to 255.
ioAlpha
[inout] Not supported.
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o GetWidth
public virtual GetWidth( const iColumn,
oWidth)
Retrieves the column's width.
Role: Each column could have its own width. This method questions the column model in order to get the width of a particular column in pixel.
Parameters:
iColumn
[in] The column ID.
oWidth
[out] The width of the specified column.
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o SetOrderedColumns
public virtual SetOrderedColumns( const iColumns)
Sets the new order of the columns.
Role: Sets columns order from the order of the CATListOfCATString parameter. Needed when dragging and dropping columns.
Parameters:
iColumns
[in] The list of the column ID sorted in new order.
Returns:
S_OK if everything ran ok, E_FAILotherwise.
o SetVisibility
public virtual SetVisibility( const iColumn,
iStyle)
Sets a column visibility.
Role: Method called when the given column is made visible or invisible by the end user..
Parameters:
iColumn
[in] The column ID.
iStyle
[in] The style to set the column visibility, possible values are:
  • CATDlgTableColumnVisible to show the column.
  • CATDlgTableColumnHidden to hide the column.
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
o SetWidth
public virtual SetWidth( const iColumn,
iWidth)
Sets the column's width.
Role: Applies the new column width after user resize.
Parameters:
iColumn
[in] The column ID
iWidth
[in] The new width of the specified column.
Returns:
S_OK if everything ran ok, E_FAIL otherwise.
This object is included in the file: CATExtIDlgTableViewColumnModel.h
If needed, your Imakefile.mk should include the module: CATDlgView

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