All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMFastenerUseItf Interface CATIFmaLiveWidgetFilter

Usage: you can reimplement this interface by deriving the supplied CATAFmaLiveWidgetFilter adapter class.

interface CATIFmaLiveWidgetFilter

Interface to customize results retrieved from filtering fastener live widget.

Role: User has to create the component CAAFmaLiveWidgetFilter and implement the interface on the component.

Default implementation is provided by adapter CATAFmaLiveWidgetFilter.

BOA information: this interface CAN NOT be implemented using the BOA (Basic Object Adapter).

Method Index

o GetFilterResults(CATUnicodeString&,CATLISTV(CATBaseUnknown_var)&): Retrieve the results from filtering fastener live widget.

Methods

o GetFilterResults

public virtual GetFilterResults(	const	`iFilterText`,
		`ioFilterResults`)

Retrieve the results from filtering fastener live widget.
Role: This method restrieves the results from filtering fastener live widget. Default results can be retrieved on the client implementation using the CATAFmaLiveWidgetFilter::GetFilterResults method.

Parameters:

iFilterText: [in] The filter text.
ioFilterResults: [in/out] The list of results.

Returns:

Legal values:

S_OK: if the list of results was successfully retrieved.
E_FAIL: a failure has been encountered while retrieving the list of results.

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