DataCommonProtocolUse DataCommonProtocolCCPServices

Usage: you must use this class as is. You should never derive it.

public class DataCommonProtocolCCPServices

Generic Copy and Paste services that operate on all objets implementing CATICutAndPastable interface.
For more specific details, please refer to the documentation of each entity. These services provide the same functionalities as the Edit -> Copy, Edit -> Paste and Edit -> Paste special in interactive application. They use the clipboard like the interactive commands, but flush the clipboard when done. Consequently, all data present in the clipboard is lost when one of theses services is called.

See also:

Method Index


o CopyAndPasteSpecialTo(CATListValCATBaseUnknown_var&,CATBaseUnknown*,CATUnicodeString&,CATListValCATBaseUnknown_var&)
Copy and Paste special of entities.
o CopyAndPasteTo(CATListValCATBaseUnknown_var&,CATBaseUnknown*,CATListValCATBaseUnknown_var&)
Copy and Paste of entities.
o GetAvailableFormats(CATListValCATBaseUnknown_var&,CATBaseUnknown*,CATListOfCATUnicodeString&)
Returns the list of available Paste special Formats.

Methods


o CopyAndPasteSpecialTo
public static CopyAndPasteSpecialTo( const iEntitiesToCopy,
iPasteTarget,
const iFormat,
oNewEntities)
Copy and Paste special of entities.
Role: copies entities like Edit -> Paste special in interactive applications.
If the first Format in the list of available Paste special Formats (i.e. default the Format) is used this service will behave exactly as service.
Parameters:
iEntitiesToCopy
The entity on which the paste is done (the selected object when using Edit -> Paste interactively).
iPasteTarget
A path representing the target of the paste operation (equivalent to the path of the selected object when using Edit -> Paste interactively). If no element in the path implements CATICutAndPastable, the operation is forbidden and fails.
iFormat
the Paste Format (the Format to select in Edit -> Paste special dialog box interactively).
oNewEntities
the copies (new objects). The list will contain some objects linked to the format and to the copy itself
Returns:
  • S_OK: the operation completed sucessfully.
  • E_POINTER: an input parameter (at least) is null or invalid.
  • E_NOTIMPL: an input parameter (at least) does not support the Copy and Paste protocol.
  • E_FAIL: the operation could not be completed.
    More information may be available via CATError::CATGetLastError.
o CopyAndPasteTo
public static CopyAndPasteTo( const iEntitiesToCopy,
iPasteTarget,
oNewEntities)
Copy and Paste of entities.
Role: copies entities like Edit -> Paste in interactive applications.
Parameters:
iEntitiesToCopy
The list of entities to copy (would be the selected objects when using Edit -> Copy interactively).
iPasteTarget
A path representing the target of the paste operation (equivalent to the path of the selected object when using Edit -> Paste interactively). If no element in the path implements CATICutAndPastable, the operation is forbidden and fails.
oNewEntities
The copies (new objects). The list will contain some objects linked to the format and to the copy itself
Returns:
  • S_OK: the operation completed sucessfully.
  • E_POINTER: an input parameter (at least) is null or invalid.
  • E_NOTIMPL: an input parameter (at least) does not support the Copy and Paste protocol.
  • E_FAIL: the operation could not be completed.
    More information may be available via CATError::CATGetLastError.
o GetAvailableFormats
public static GetAvailableFormats( const iEntitiesToCopy,
iPasteTarget,
oAvailableFormats)
Returns the list of available Paste special Formats.
Role: provides the list of Copy Paste Formats (as in Edit -> Paste special interactively) that can be used when copying iEntitiesToCopy to iPasteTarget.
The first Format in the list is the default Format, i.e. the Format used by Paste (not Paste special).
Parameters:
iEntitiesToCopy
The entity on which the paste is done (the selected object when using Edit -> Paste interactively).
iPasteTarget
A path representing the target of the paste operation (equivalent to the path of the selected object when using Edit -> Paste interactively). If no element in the path implements CATICutAndPastable, the operation is forbidden and fails.
oAvailableFormats
The list of available Paste special Formats.
Returns:
  • S_OK: the operation completed sucessfully.
  • E_POINTER: an input parameter (at least) is null or invalid.
  • E_NOTIMPL: an input parameter (at least) does not support the Copy and Paste protocol.
  • E_FAIL: the operation could not be completed.
    More information may be available via CATError::CATGetLastError.
This object is included in the file: DataCommonProtocolCCPServices.h
If needed, your Imakefile.mk should include the module: DataCommonProtocolUse

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.