All Frameworks  Class Hierarchy  This Framework  Next  Indexes

ProductStructureInterfaces Interface CATICustoIconProduct

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATICustoIconProduct
 

Usage: you can freely reimplement this interface.


interface CATICustoIconProduct

Interface to provide icons for the product structure tree.

Role: By implementing this interface on a feature extension of Product its own icons to be displayed in the product structure tree. It can also indicates whether various information masks can be overlaid on the icons or not.


Method Index


o GetIconForComponent(CATUnicodeString&)
Returns the icon to be displayed for a component.
o GetIconForProduct(CATUnicodeString&)
Returns the icon to be displayed for a product.
o IsPossibleToAddCentralMask()
Indicates whether central information mask can be added to the icon.
o IsPossibleToAddContextDesignMask()
Indicates whether contextuality information mask can be added to the icon.
o IsPossibleToAddDocMask()
Indicates whether document information mask can be added to the icon.
o IsPossibleToAddFlexibleDesignMask()
Indicates whether flexible design information mask can be added to the icon.
o IsPossibleToAddGearsMask()
Indicates whether gears mask can be added to the icon.
o IsPossibleToAddRepMask()
Indicates whether representation information mask can be added to the icon.

Methods


o GetIconForComponent
public virtual HRESULT GetIconForComponent(CATUnicodeString& oIcon)= 0
Returns the icon to be displayed for a component.
Role: The icon returned will be used to display an internal component in a product structure tree.
Parameters:
oIcon
The name of the icon that should be used for a component
Returns:
E_FAIL internal error S_FALSE no icon provided, use the default S_OK use the returned icon
o GetIconForProduct
public virtual HRESULT GetIconForProduct(CATUnicodeString& oIcon)= 0
Returns the icon to be displayed for a product.
Role: The icon returned will be used to display an external product in a product structure tree.
Parameters:
oIcon
The name of the icon that should be used for a product
Returns:
E_FAIL internal error S_FALSE no icon provided, use the default S_OK use the returned icon
o IsPossibleToAddCentralMask
public virtual HRESULT IsPossibleToAddCentralMask()= 0
Indicates whether central information mask can be added to the icon.
Role: When an icon is provided, this method is called to indicate whether central information mask can be added to the icon.
Returns:
E_FAIL internal error S_FALSE no mask should be added S_OK central information mask can be added
o IsPossibleToAddContextDesignMask
public virtual HRESULT IsPossibleToAddContextDesignMask()= 0
Indicates whether contextuality information mask can be added to the icon.
Role: When an icon is provided without a gears mask, this method is called to indicate whether contextuality information mask can be added to the icon.
Returns:
E_FAIL internal error S_FALSE no mask should be added S_OK contextuality information mask can be added
o IsPossibleToAddDocMask
public virtual HRESULT IsPossibleToAddDocMask()= 0
Indicates whether document information mask can be added to the icon.
Role: When an icon is provided, this method is called to indicate whether document information mask can be added to the icon on its top right corner.
Returns:
E_FAIL internal error S_FALSE no mask should be added S_OK document information mask can be added
o IsPossibleToAddFlexibleDesignMask
public virtual HRESULT IsPossibleToAddFlexibleDesignMask()= 0
Indicates whether flexible design information mask can be added to the icon.
Role: When an icon is provided without a gears mask, this method is called to indicate whether flexible design information mask can be added to the icon.
Returns:
E_FAIL internal error S_FALSE no mask should be added S_OK flexible design information mask can be added
o IsPossibleToAddGearsMask
public virtual HRESULT IsPossibleToAddGearsMask()= 0
Indicates whether gears mask can be added to the icon.
Role: When an icon is provided, this method is called to indicate whether gears mask can be added to the icon its bottom left corner.
Returns:
E_FAIL internal error S_FALSE no mask should be added S_OK gears mask can be added
o IsPossibleToAddRepMask
public virtual HRESULT IsPossibleToAddRepMask()= 0
Indicates whether representation information mask can be added to the icon.
Role: When an icon is provided, this method is called to indicate whether representation information mask can be added to the icon on its bottom right corner.
Returns:
E_FAIL internal error S_FALSE no mask should be added S_OK representation information mask can be added

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

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