All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

InteractiveInterfaces Interface CATISelectionSetsFactory

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

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


interface CATISelectionSetsFactory

Interface to manage the Selection Sets in a document.

Role: This interface, implemented by the document, enables you to create, find and delete Selection Set (CATISelectionSet ) in a document.
Several Selection Sets can be created, and one can be defined as the current one.
Several Selection Sets can have the same name.
A Selection Set contains elements ( CATISelectionSetElement )


Method Index


o BeginFindOwningSets()
Starts a transaction with several FindOwningSets calls.
o CreateSelectionSet(CATUnicodeString&,CATISelectionSet*&)
Creates a new Selection Set.
o DeleteSelectionSet(CATISelectionSet*&,CATUnicodeString&)
Removes a Selection Set.
o EndFindOwningSets()
Ends a transaction with several FindOwningSets calls.
o FindOwningSets(CATPathElement*,CATSelectionSetMode,CATListOfCATISelectionSet_var*&)
Finds all the Selection Sets that contain the searched element.
o FindSelectionSets(CATUnicodeString&,CATSelectionSetMode,CATListOfCATISelectionSet_var*&)
Retrieves the list of Selection Sets from his name.
o GetCurrent(CATISelectionSet*&)
Current Selection Set management.
o ListSelectionSets(CATSelectionSetMode,CATListOfCATISelectionSet_var*&)
Retrieves all Selection Sets.
o SetCurrent(CATISelectionSet*)
Current Selection Set management.

Methods


o BeginFindOwningSets
public virtual HRESULT BeginFindOwningSets()= 0
Starts a transaction with several FindOwningSets calls.
Role: If several FindOwningSets calls are needed, call first this method and the EndFindOwningSets after so that the treatment will be optimized (data structure loaded in memory). Do not forget to call EndFindOwningSets to clean memory.
Returns:
The error code of function :
  • S_OK if the method succeeded
  • E_FAIL if a problem occurred
o CreateSelectionSet
public virtual HRESULT CreateSelectionSet( const CATUnicodeString& iName,
CATISelectionSet*& oNewSet) = 0
Creates a new Selection Set.
Role: This method creates a new Selection Set.
Parameters:
iName
The name of Selection Set to create.
oNewSet
The created Selection Set.
Returns:
The error code of function.
  • S_OK if the Selection Set is created
  • E_FAIL if a problem occurred
o DeleteSelectionSet
public virtual HRESULT DeleteSelectionSet(CATISelectionSet*& ioSelectionSetToDelete,
CATUnicodeString& oNLSErrorMessage) = 0
Removes a Selection Set.
Role: This method removes a Selection Set and all it contents.
Parameters:
ioSelectionSetToDelete
The Selection Set to delete. The inout argument is set to NULL.
oNLSErrorMessage
The error message if E_FAIL
Returns:
The error code of function :
  • S_OK if the method succeeded
  • E_FAIL if a problem occurred
o EndFindOwningSets
public virtual HRESULT EndFindOwningSets()= 0
Ends a transaction with several FindOwningSets calls.
Role: If several FindOwningSets calls are needed, call first BeginFindOwningSets method and this method after so that the treatment will be optimized (data structure loaded in memory).
Returns:
The error code of function :
  • S_OK if the method succeeded
  • E_FAIL if a problem occurred
o FindOwningSets
public virtual HRESULT FindOwningSets(CATPathElement* iPath,
const CATSelectionSetMode iMode,
CATListOfCATISelectionSet_var*& oOwningSetsList) = 0
Finds all the Selection Sets that contain the searched element.
Role: If several calls to this method are needed, call first the BeginFindOwningSets method and the EndFindOwningSets after so that the treatment will be optimized (data structure loaded in memory).
Parameters:
iPath
The path of the selected element
iMode
The find mode.
oOwningSetsList
The list of Sets to which the input element belongs
Returns:
The error code of function :
  • S_OK if the input element belongs to at least one Set
  • S_FALSE if no Sets were found (in this case, the output list is reset to NULL)
  • E_FAIL if a problem occurred
o FindSelectionSets
public virtual HRESULT FindSelectionSets( const CATUnicodeString& iName,
const CATSelectionSetMode iMode,
CATListOfCATISelectionSet_var*& oSetList) = 0
Retrieves the list of Selection Sets from his name.
Role: Retrieves the list of Selection Sets from his name.
Parameters:
iName
The name of Selection Set to retrieve.
iMode
The find mode.
oSetList
The list of retrieved Selection Sets.
Returns:
The error code of function.
  • S_OK if found
  • S_FALSE if no Set is found
  • E_FAIL if a problem occurred
o GetCurrent
public virtual HRESULT GetCurrent(CATISelectionSet*& oCurrentSelectionSet) = 0
Current Selection Set management.
Role: Retrieves the current Set. The result can be NULL if the Set has been deleted.
Parameters:
oCurrentSelectionSetToDelete
The current Selection Set.
Returns:
The error code of function :
  • S_OK if the method succeeded
  • E_FAIL if a problem occurred
o ListSelectionSets
public virtual HRESULT ListSelectionSets( const CATSelectionSetMode iMode,
CATListOfCATISelectionSet_var*& oSetList) = 0
Retrieves all Selection Sets.
Role: This method lists all Selection Sets.
Parameters:
iMode
The list mode.
oSetList
The list of retrieved Selection Sets
Returns:
The error code of function.
  • S_OK if found
  • S_FALSE if no Set is found
  • E_FAIL if a problem occurred
o SetCurrent
public virtual HRESULT SetCurrent(CATISelectionSet* iCurrentSelectionSet) = 0
Current Selection Set management.
Role: To set the current Selection Set.
Parameters:
iSelectionSet
The current SelectionSet
Returns:
The error code of function :
  • S_OK if the method succeeded
  • E_FAIL if a problem occurred

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

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