All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ComponentsCatalogsInterfaces Interface CATICatalogSynchronize

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

Usage: you can freely reimplement this interface.


interface CATICatalogSynchronize

Interface for catalog component synchronisation.
Role: This interface enables to components to update their attributes in catalog like name, preview and keyword values. This interface is used during the synchronization step in Edit/Links.
This interface can be implemented (it is not mandatory) on a component when it must be integrated into a catalog document. To integrate a new type of component in a catalog document there are two others interfaces to considere:


Method Index


o GetAlias(CATUnicodeString&)
Retrieves the display name of the description.
o GetEmbeddedPreview(CATPixelImage**)
Retrieves embedded preview.
o GetKeywordValue(CATUnicodeString&,CATCke::Boolean&)
Retrieves a boolean keyword value.
o GetKeywordValue(CATUnicodeString&,CATICkeType*,double&)
Retrieves a double keyword value.
o GetKeywordValue(CATUnicodeString&,CATUnicodeString&)
Retrieves a string keyword value.
o GetKeywordValue(CATUnicodeString&,int&)
Retrieves an integer keyword value.

Methods


o GetAlias
public virtual HRESULT GetAlias(CATUnicodeString& oAlias) = 0
Retrieves the display name of the description.
Role:This method returns the display name of the description ( CATICatalogDescription ) which contains a links towards an instance of the component. In other words, the name of the description, returned by the CATICatalogDescription.GetName method is those returned by this method.
The name of the description is also the value of the Name keyword.
Parameters:
oAlias
The display name of the description.
o GetEmbeddedPreview
public virtual HRESULT GetEmbeddedPreview(CATPixelImage** oImage) = 0
Retrieves embedded preview.
Role: This method is called only if a previous embedded preview was stored in the catalog.
Parameters:
oImage
[out, CATBaseUnknown#Release] A CATPixelImage with 130*110 size.
o GetKeywordValue
public virtual HRESULT GetKeywordValue( const CATUnicodeString& iKeywordName,
CATCke::Boolean& oKeyWordValue) = 0
Retrieves a boolean keyword value.
Parameters:
iKeywordName
The name of the keyword.
oKeywordValue
The value of the keyword in MKS Unit.
o GetKeywordValue
public virtual HRESULT GetKeywordValue( const CATUnicodeString& iKeywordName,
const CATICkeType* iKeywordType,
double& oKeyWordValue) = 0
Retrieves a double keyword value.
Parameters:
iKeywordName
The name of the keyword.
iKeywordType
The type of the keyword, usefull for MKS units.
oKeywordValue
The value of the keyword in MKS Unit.
o GetKeywordValue
public virtual HRESULT GetKeywordValue( const CATUnicodeString& iKeywordName,
CATUnicodeString& oKeyWordValue) = 0
Retrieves a string keyword value.
Parameters:
iKeywordName
The name of the keyword.
oKeywordValue
The value of the keyword in MKS Unit.
o GetKeywordValue
public virtual HRESULT GetKeywordValue( const CATUnicodeString& iKeywordName,
int& oKeyWordValue) = 0
Retrieves an integer keyword value.
Parameters:
iKeywordName
The name of the keyword.
oKeywordValue
The value of the keyword in MKS Unit.

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

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