All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchContCutAndPaste

System.IUnknown
  |
  +---CATISchContCutAndPaste
 

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


interface CATISchContCutAndPaste

Interface to provide Cut/Delete/Copy/Paste behavior on Schematic basic set of objects for the schematic applications.
Role: To be called by CATICutAndPastable implementation on the base object with Schematic extensions


Method Index


o BoundaryExtract(IUnknown*,ListOfVarBaseUnknown&,ListOfVarBaseUnknown*,CATFormat*)
Lists objects to extract.
o Create(IUnknown*,CATSchContCCPMode,CATBaseUnknown_Associations&,CATFormat*)
Creates in the client side, all objects required, and provides associations.
o GetSrcTgtContRelatedObject(CATSchContCCPQueryMode,IUnknown*,CATBaseUnknown_Associations&,IUnknown**)
Query related objects in the source container and the clipboard container.
o Update(IUnknown*,CATSchContCCPMode,CATBaseUnknown_Associations&,CATFormat*,ListOfVarBaseUnknown*)
Makes in the client, the update of data and relations.

Methods


o BoundaryExtract
public virtual HRESULT BoundaryExtract(IUnknown* iObjectTobeProcessed,
ListOfVarBaseUnknown& ioObjectsAlreadyInBoundary,
const ListOfVarBaseUnknown* iObjectsToAdd=NULL,
const CATFormat* iAnImposedFormat=NULL) = 0
Lists objects to extract.
Role: used on copy.
Parameters:
iObjectTobeProcessed
the object in the source/clip container to be extracted
ioObjectsAlreadyInBoundary
list of objects to extract.
iObjectsToAdd
list objects to add to list of objects to extract.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Create
public virtual HRESULT Create(IUnknown* iObjectTobeProcessed,
CATSchContCCPMode iMode,
CATBaseUnknown_Associations& ioAssociationOfObjects,
const CATFormat* an_imposed_format=NULL)=0
Creates in the client side, all objects required, and provides associations.
Parameters:
iObjectTobeProcessed
the object in the source/clip container to be created
iMode
for component input SchContCCPMode_Component and for route input SchContCCPMode_Route
ioAssociationOfObjects
couples of objects source/target.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetSrcTgtContRelatedObject
public virtual HRESULT GetSrcTgtContRelatedObject(CATSchContCCPQueryMode iMode,
IUnknown* iObjectIn,
CATBaseUnknown_Associations& ioAssociationOfObjects,
IUnknown** oRelatedObject) = 0
Query related objects in the source container and the clipboard container.
Parameters:
CATSchContCCPQueryMode
for querying related object in the source container given a clipboard object, input SchCCPQueryInputClipReturnSrc for querying related object in the clipboard container given a source container object, input SchCCPQueryInputSrcReturnClip
iObjectIn
input object whose related object is to be queried.
ioAssociationOfObjects
couples of objects source/target.
oRelatedObject
related object
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Update
public virtual HRESULT Update(IUnknown* iObjectTobeProcessed,
CATSchContCCPMode iMode,
CATBaseUnknown_Associations& ioAssociationOfObjects,
const CATFormat* iAnImposedFormat=NULL,
ListOfVarBaseUnknown* iToCurObjects=NULL)=0
Makes in the client, the update of data and relations.
Parameters:
iObjectTobeProcessed
the object in the clip/target container to be updated
iMode
for component input SchContCCPMode_Component and for route input SchContCCPMode_Route
ioAssociationOfObjects
couples of objects source/target.
iAnImposedFormat
if this format is not valid, it will be reinitialized.
iToCurObjects
target objects for paste corresponding to selected objects.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchContCutAndPaste.h

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