All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ComponentsCatalogsInterfaces Interface CATICatalogBrowserFactory

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

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


interface CATICatalogBrowserFactory

Interface to open a Components Catalog Browser.
Role:This interface enables to open a Catalog Browser Dialog box. This Dialog object is handled by the CATICatalogBrowser interface.
The editor of the document implements this interface. In others word, the CATFrmEditor class implements this interface. You retrieve an instance of this class in using:


Method Index


o OpenCatalogBrowser(CATICatalogBrowser*&,CATCciCatalogBrowserDisplayOptions,int,int)
Opens a new Catalog Browser Dialog box.

Methods


o OpenCatalogBrowser
public virtual HRESULT OpenCatalogBrowser(CATICatalogBrowser*& oBrowser,
CATCciCatalogBrowserDisplayOptions iOptions=CATCatalogDisplayWndModal,
int iAuthorizeDrag=1,
int iAuthorizeInstantiation=1) = 0
Opens a new Catalog Browser Dialog box.
Parameters:
oBrowser
[out, CATBaseUnknown#Release] The created catalog browser.
iOptions
The options to customize the display of the Catalog Browser.
Default value:CATCatalogDisplayWndModal
iAuthorizeDrag
The option to authorize or not the instantiation by Drag and Drop for a component.
Attention, the Drag and Drop is only possible if the current command is the Select command. So if the catalog browser is launched from a command which is exclusive, or shared, the instantiation by drag and drop is unavailable.
Legal value:
  • 1: Drag and Drop is possible (default value)
  • 0: Drag and Drop is impossible
iAuthorizeInstantiation
The option to authorize or not the instantiation by contextual menu or double click of a component.
Legal value:
  • 1: Instantiation is possible (default value)
  • 0: Instantiation is impossible

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

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