All Frameworks  Class Hierarchy  This Framework  Indexes   

StructureInterfaces Interface CATIStrColorESSObjectSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIStrColorESSObjectSettingAtt

Describe the ESSctionality of your interface here.

Using this prefered syntax will enable mkdoc to document your class.


Method Index


o GetMemberColorInfo(CATSettingInfo*)
Retrieves the state of the MemberColor parameter.
o GetMemberColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the MemberColor attribute.
o GetPlateColorInfo(CATSettingInfo*)
Retrieves the state of the PlateColor parameter.
o GetPlateColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the PlateColor attribute.
o SetMemberColorLock(unsigned char)
Locks or unlocks the MemberColor parameter.
o SetMemberColor(unsigned int,unsigned int,unsigned int)
Sets the MemberColor attribute.
o SetPlateColorLock(unsigned char)
Locks or unlocks the PlateColor parameter.
o SetPlateColor(unsigned int,unsigned int,unsigned int)
Sets the PlateColor attribute.

Methods


o GetMemberColorInfo
public virtual GetMemberColorInfo( oInfo)
Retrieves the state of the MemberColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMemberColor
public virtual GetMemberColor( oMemberColorR,
oMemberColorG,
oMemberColorB)
Retrieves the MemberColor attribute.
o GetPlateColorInfo
public virtual GetPlateColorInfo( oInfo)
Retrieves the state of the PlateColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlateColor
public virtual GetPlateColor( oPlateColorR,
oPlateColorG,
oPlateColorB)
Retrieves the PlateColor attribute.
o SetMemberColorLock
public virtual SetMemberColorLock( iLocked)
Locks or unlocks the MemberColor parameter.
Role: Locks or unlocks the MemberColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMemberColor
public virtual SetMemberColor( iMemberColorR,
iMemberColorG,
iMemberColorB)
Sets the MemberColor attribute.
o SetPlateColorLock
public virtual SetPlateColorLock( iLocked)
Locks or unlocks the PlateColor parameter.
Role: Locks or unlocks the PlateColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPlateColor
public virtual SetPlateColor( iPlateColorR,
iPlateColorG,
iPlateColorB)
Sets the PlateColor attribute.

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

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