Print CATDlgSettingsMultiList

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


public class CATDlgSettingsMultiList

Multilist with one attribute per line


Constructor and Destructor Index


o CATDlgSettingsMultiList(CATDialog*,CATUnicodeString&,CATUnicodeString&,CATDlgStyle)
Constructor.
o ~CATDlgSettingsMultiList()
Destructor.

Method Index


o ClearAttributes()
Clears the attributes list relative to the multilist
o GetAttributeDisplayProperties(CATUnicodeString&)
Retrieves the attribute display structure relative to an attribute
o SetColumnItemWithLock(int,CATUnicodeString&,int,CATULong)
Sets a string value taking into account the shift of one column due to the lock
o SetColumnItemWithLock(int,CATUnicodeString&,CATString&,int,CATULong)
Sets a string and an icon value taking into account the shift of one column due to the lock
o SetColumnTitlesWithLock(int,CATUnicodeString*)
Set column titles taking into account the first column reserved for the lock
o SetLineSettingsAttribute(unsigned int,CATUnicodeString&)
Set attribute for the line given in parameter
o Update()
Refresh the lock column according to the attributes list

Constructor and Destructor


o CATDlgSettingsMultiList
public CATDlgSettingsMultiList( iFather,
const iName,
const iRepositoryName,
iStyle)
Constructor.
Parameters:
iFather
The parent widget.
iName
The internal name of the multilist.
iStyle
The style of the multilist.
Legal values:
default
multiple selection is not allowed.
CATDlgLstMultisel
multiple selection is allowed.
CATDlgLstAutoSort
automatic sort is activated when the user presses the title of a column, see
.
o ~CATDlgSettingsMultiList
public virtual ~CATDlgSettingsMultiList()
Destructor.

Methods


o ClearAttributes
public ClearAttributes()
Clears the attributes list relative to the multilist
o GetAttributeDisplayProperties
public GetAttributeDisplayProperties( const iAttributeName)
Retrieves the attribute display structure relative to an attribute
Parameters:
iAttributeName
The attribute name
Returns:
The attribute display structure
o SetColumnItemWithLock
public SetColumnItemWithLock( iCol,
const iStr,
iIndex,
iMode)
Sets a string value taking into account the shift of one column due to the lock
Parameters:
iCol
the column index
iStr
The string to set
iIndex
The row index
iMode
A mode which describes how to alter the contents of the cell.
Legal values:
CATDlgDataAdd
the cell is created.
CATDlgDataModify
the cell is modified.
Returns:
the count of selected rows.
o SetColumnItemWithLock
public SetColumnItemWithLock( iCol,
const iStr,
const iIcon,
iIndex,
iMode)
Sets a string and an icon value taking into account the shift of one column due to the lock
Parameters:
iCol
the column index
iStr
The string to set
iIcon
The icon to set
iIndex
The row index
iMode
A mode which describes how to alter the contents of the cell.
Legal values:
CATDlgDataAdd
the cell is created.
CATDlgDataModify
the cell is modified.
Returns:
the count of selected rows.
o SetColumnTitlesWithLock
public SetColumnTitlesWithLock( iArraySize,
iTitleArray)
Set column titles taking into account the first column reserved for the lock
Parameters:
iArraySize
The size of the array containing the titles
iTitleArray
The array containing the titles to set
o SetLineSettingsAttribute
public SetLineSettingsAttribute( iLine,
const iAttributeName)
Set attribute for the line given in parameter
Parameters:
iLine
The selected line
iAttributeName
The name of the attribute for this line
o Update
public Update()
Refresh the lock column according to the attributes list

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

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