All Frameworks Class Hierarchy This Framework Indexes
StructureInterfaces Interface CATIStrColorSTDObjectSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIStrColorSTDObjectSettingAtt
Describe the STDctionality of your interface here.
Using this prefered syntax will enable mkdoc to document your class.
Method Index
- o
GetPlateColorInfo(CATSettingInfo*)
- Retrieves the state of the PlateColor parameter.
- o
GetPlateColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the PlateColor attribute.
- o
GetShapeColorInfo(CATSettingInfo*)
- Retrieves the state of the ShapeColor parameter.
- o
GetShapeColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the ShapeColor attribute.
- o
SetPlateColorLock(unsigned char)
- Locks or unlocks the PlateColor parameter.
- o
SetPlateColor(unsigned int,unsigned int,unsigned int)
- Sets the PlateColor attribute.
- o
SetShapeColorLock(unsigned char)
- Locks or unlocks the ShapeColor parameter.
- o
SetShapeColor(unsigned int,unsigned int,unsigned int)
- Sets the ShapeColor attribute.
Methods
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 GetShapeColorInfo
| public virtual GetShapeColorInfo( | | oInfo) |
-
Retrieves the state of the ShapeColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetShapeColor
| public virtual GetShapeColor( | | oShapeColorR, |
| | oShapeColorG, |
| | oShapeColorB) |
-
Retrieves the ShapeColor 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.
o SetShapeColorLock
| public virtual SetShapeColorLock( | | iLocked) |
-
Locks or unlocks the ShapeColor parameter.
Role: Locks or unlocks the ShapeColor 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 SetShapeColor
| public virtual SetShapeColor( | | iShapeColorR, |
| | iShapeColorG, |
| | iShapeColorB) |
-
Sets the ShapeColor attribute.
This object is included in the file: CATIStrColorSTDObjectSettingAtt.h
If needed, your Imakefile.mk should include the module: CATStrSettingsItf