All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMLibraryInterfaces Interface PLMICLGCatalogBrowser

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

interface PLMICLGCatalogBrowser

Interface to manipulate the Catalog Browser.
Role: The Catalog Browser is a Dialog window in which a user may browse a catalog structure, search and select items/classified components. The interface enables to create an instance of this Dialog window.

After the creation, you must retrieve the window of the Dialog, thanks to the . It enables to your to receive the notifications sent by the Catalog Browser dialog window.

Method Index

o GetBrowserDialog(CATDlgDialog*&): Retrieves the dialog window to add notification.
o GetFilter(PLMICLGCatalogFilter_var&): Get the current filter.
o GetSelectedObjects(CATLISTV(CATBaseUnknown_var)&): Retrieves the selected catalog description objects.
o SetFilter(PLMICLGCatalogFilter_var): Set the filter to the current Catalog Browser.

Methods

o GetBrowserDialog

public virtual GetBrowserDialog( oDialog)

Retrieves the dialog window to add notification.

Parameters:

oDialog: the catalog browser dialog.
Lifecycle rules deviation: No AddRef is performed on the returned value. Also, use CATDlgDialog::SetFather() to set your command as the father

Returns:

S_OK if the Dialog was successfully retreived.
E_FAIL otherwise.

o GetFilter

public virtual GetFilter( ospCatalogFilter)

Get the current filter.

Parameters:

ospCatalogFilter: Filter

Returns:

S_OK if the Filter was successfully get.
E_FAIL otherwise.

o GetSelectedObjects

public virtual GetSelectedObjects( oListResults)

Retrieves the selected catalog description objects.

Parameters:

oListResults: Please handle them accordingly.

Returns:

Returns S_OK on success, E_FAIL on failure.

o SetFilter

public virtual SetFilter( ispCatalogFilter)

Set the filter to the current Catalog Browser.

Parameters:

ispCatalogFilter: Filter

Returns:

S_OK if the Filter was successfully set.
E_FAIL otherwise.

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