All Frameworks Class Hierarchy This Framework Previous Next Indexes
ComponentsCatalogsInterfaces Interface CATICatalogDescription
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICatalogDescription
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICatalogDescription
Interface to inquire and define catalog descriptions.
Role: A description is a link between a chapter and:
- a chapter,
- a document (CATPart, ...),
- a feature in a document
- or nothing.
To create descriptions there are three ways:
Method Index
- o
GetBoolean(CATUnicodeString&,CATBoolean&)
- Retrieves the keyword value on the current description (CATBoolean).
- o
GetChapter(CATICatalogChapter*&)
- Retrieves the chapter containing this description.
- o
GetDescriptionType(CATICatalogDescription::CATCatalogDescriptionType&)
- Retrieves the type of the description (for description on objects).
- o
GetDouble(CATUnicodeString&,double&)
- Retrieves the keyword value on the current description (real).
- o
GetInteger(CATUnicodeString&,int&)
- Retrieves the keyword value on the current description (integer).
- o
GetName(CATUnicodeString&)
- Retrieves the name of the description.
- o
GetObject(CATBaseUnknown*&)
- Retrieves the object linked to the current description.
- o
GetPreview(CATPixelImage**)
- Retrieves an embedded image to current description.
- o
GetPreviewName(CATUnicodeString&)
- Retrieves a preview file to current description.
- o
GetString(CATUnicodeString&,CATUnicodeString&)
- Retrieves the keyword value on the current description (string).
- o
GetSubChapter(CATICatalogChapter*&)
- Retrieves the subchapter from current description.
- o
GetValue(CATUnicodeString&,CATUnicodeString&)
- Retrieves the keyword value on the current description.
- o
IsObjectASubchapter()
- Return the type of the pointed chapter.
- o
IsPointedDocumentAvailable()
- Checks if the link to the document is correct or not.
- o
IsResolvedObjectComputed(int&)
- Retrieves if the description is resolved or not.
- o
ResetLinkToPointedDocument()
- Releases the pointing document if possible.
- o
ResolvedDocumentFromDesignTable()
- Resolves the current description.
- o
RunInstantiationCmd(CATICatalogBrowser*,int,int)
- Launches an instantiation.
- o
SetBoolean(CATUnicodeString&,CATBoolean)
- Sets the keyword value on the current description (boolean).
- o
SetDocumentName(CATUnicodeString&)
- Create a link on current description from a file name.
- o
SetDouble(CATUnicodeString&,double)
- Sets the keyword value on the current description (real).
- o
SetInteger(CATUnicodeString&,int)
- Sets the keyword value on the current description (integer).
- o
SetName(CATUnicodeString&)
- Sets the name for the description.
- o
SetObject(CATILinkableObject*)
- Creates a link on the current description.
- o
SetPreview(CATPixelImage*)
- Associates an embedded image to the current description.
- o
SetPreviewName(CATUnicodeString&)
- Associates an preview file to current description.
- o
SetString(CATUnicodeString&,CATUnicodeString&)
- Sets the keyword value on the current description (string).
- o
SetValue(CATUnicodeString&,CATUnicodeString&)
- Sets the keyword value on the current description.
- o
UnsetKeyword(CATUnicodeString&)
- Suppresses the keyword value on current description.
Enumerated Type Index
- o
CATCatalogDescriptionType
- Enumeration to describe differents kinds of descriptions links to objects.
Methods
o GetBoolean
-
Retrieves the keyword value on the current description (CATBoolean).
- Parameters:
-
- iName
- The keyword to read.
- oValue
- The boolean value of the keyword.
o GetChapter
-
Retrieves the chapter containing this description.
- Parameters:
-
- oChapter
- [out, CATBaseUnknown#Release] The chapter of current description.
o GetDescriptionType
public virtual HRESULT GetDescriptionType( | CATICatalogDescription::CATCatalogDescriptionType& | ocomponentKindof)=0 |
-
Retrieves the type of the description (for description on objects).
To known if description has a link on document, feature, V4 model or unset
- Parameters:
-
- ocomponentKindof
- Value to describe different kind of description link to objects.
o GetDouble
-
Retrieves the keyword value on the current description (real).
- Parameters:
-
- iName
- The keyword to read.
- oValue
- The real value of the keyword.
o GetInteger
-
Retrieves the keyword value on the current description (integer).
- Parameters:
-
- iName
- The keyword to read.
- oValue
- The integer value of the keyword.
o GetName
-
Retrieves the name of the description.
- Parameters:
-
- oName
- The name of the description, displayed in catalog editor and browser.
o GetObject
-
Retrieves the object linked to the current description.
- Parameters:
-
- oExternalObject
- [out, CATBaseUnknown#Release] The linked external object.
o GetPreview
-
Retrieves an embedded image to current description.
This image is always use if it exist for display in editor and browser.
- Parameters:
-
- oImage
- [out, CATBaseUnknown#Release] The pixel image retrieving in catalog, NULL to unset.
o GetPreviewName
-
Retrieves a preview file to current description.
This image is use if no embedded preview is available.
- Parameters:
-
- oexternalObjectName
- The name of file to use a preview (.bmp, .jpg).
o GetString
-
Retrieves the keyword value on the current description (string).
- Parameters:
-
- iName
- The keyword to read.
- oValue
- The string value of the keyword.
o GetSubChapter
-
Retrieves the subchapter from current description.
- Parameters:
-
- oSubChapter
- [out, CATBaseUnknown#Release] The chapter pointed by the current description.
o GetValue
-
Retrieves the keyword value on the current description.
- Parameters:
-
- iName
- The keyword to read.
- oValue
- The value of the keyword, for example "3mm".
o IsObjectASubchapter
public virtual CATBoolean IsObjectASubchapter( | )= 0 |
-
Return the type of the pointed chapter.
- Returns:
- TRUE if pointed object is a sub-chapter, or FALSE if it's a EndChapter.
o IsPointedDocumentAvailable
public virtual HRESULT IsPointedDocumentAvailable( | )=0 |
-
Checks if the link to the document is correct or not.
- Returns:
-
- S_OK : pointed document is available (without loading)
- S_FALSE :pointed document is not available or the description does not point to a document
- E_FAIL in case of error or if there is no pointed object associated to the catalog description
o IsResolvedObjectComputed
public virtual HRESULT IsResolvedObjectComputed( | int& | oAnswer) =0 |
-
Retrieves if the description is resolved or not.
- Parameters:
-
- oAnswer
- 1 if the description is resolved, 0 otherwise.
o ResetLinkToPointedDocument
public virtual HRESULT ResetLinkToPointedDocument( | )=0 |
-
Releases the pointing document if possible.
- Returns:
-
- S_OK : pointed document has been released and removed from memory
- E_FAIL : unable to remove pointed document, several possible reason:
- There is another link in session to this document
- The pointed document has been modified in session, impossible to unload it without data loss
o ResolvedDocumentFromDesignTable
public virtual HRESULT ResolvedDocumentFromDesignTable( | )=0 |
-
Resolves the current description.
Role:When a description is linked with a CATPart which contain a Design Table, the description can be resolved.
In this case, a new CATPart document is created with the right configuration and the description is linked with this new document.
In the new document, the link with the Design Table is deleted.
o RunInstantiationCmd
-
Launches an instantiation.
- Parameters:
-
- iBrowser
- The interface pointer on the current Catalog Browser (it can be NULL)
- iInstantiateMode
- The mode of the instantiation is useful for a document instantiation:
- 0: The document in the destination document is created by new From
- 1: The document in the destination document is linked
towards the component
otherwise, it is useless.
- iRepeatMode
o SetBoolean
-
Sets the keyword value on the current description (boolean).
- Parameters:
-
- iName
- The keyword to valuate.
- iValue
- The boolean value to set on selected keyword.
o SetDocumentName
-
Create a link on current description from a file name.
Role:To associate a document with the description there
is two ways:
-
SetObject : you give the
CATILinkableObject interface pointer on the document
- SetDocumentName : you give only the complete path of the document. In this case,
the document is not opened.
- Parameters:
-
- iFileName
- File name of the document to link to the description.
o SetDouble
-
Sets the keyword value on the current description (real).
- Parameters:
-
- iName
- The keyword to valuate.
- iValue
- The real value to set on selected keyword.
o SetInteger
-
Sets the keyword value on the current description (integer).
- Parameters:
-
- iName
- The keyword to valuate.
- iValue
- The integer value to set on selected keyword.
o SetName
-
Sets the name for the description.
- Parameters:
-
- iName
- The new name of the description.
o SetObject
-
Creates a link on the current description.
- Parameters:
-
- iExternalObject
- The external object to link, it could be any CATILinkable object (document or feature).
NULL to unset current link.
o SetPreview
-
Associates an embedded image to the current description.
This image is always use if it exist for display in editor and browser.
- Parameters:
-
- iImage
- The pixel image to store in catalog, NULL to unset.
o SetPreviewName
-
Associates an preview file to current description.
This image is use if no embedded preview is available.
- Parameters:
-
- iexternalObjectName
- The name of file to use a preview (.bmp, .jpg).
o SetString
-
Sets the keyword value on the current description (string).
- Parameters:
-
- iName
- The keyword to valuate.
- iValue
- The string value to set on selected keyword.
o SetValue
-
Sets the keyword value on the current description.
- Parameters:
-
- iName
- The keyword to valuate.
- iValue
- The value to set on selected keyword, for example "3mm".
o UnsetKeyword
-
Suppresses the keyword value on current description. The default value will be used.
- Parameters:
-
- iName
- The keyword to unset.
Enumerated Types
o CATCatalogDescriptionType
-
enum CATCatalogDescriptionType {
CATCatalogDocument,
CATCatalogFeature,
CATCatalogUnset,
CATCatalogDescription
}
Enumeration to describe differents kinds of descriptions links to objects.
- Parameters:
-
- CATCatalogDocument
- The description is linked with a document.
- CATCatalogFeature
- The description is linked with a feature in a document.
- CATCatalogUnset
- The description has no link.
- CATCatalogDescription
- The description is linked with a description (Persistent Query).
This object is included in the file: CATICatalogDescription.h
If needed, your Imakefile.mk should include the module: CATCclInterfaces