FeatureModelerExt CATFmCCPContext
Usage: you must use this class as is. You should never derive it.
public class CATFmCCPContext
Class defining the context of a Cut, Copy or Paste operation.
Refer to the CAA Encyclopedia Feature Modeler pages, and more specifically the article "Cut, Copy Paste Customization".
- See also:
-
Method Index
- o
GetCopyObjectFromSource(CATBaseUnknown*)
- Returns the copy object from its source.
- o
GetImpactedObjects(CATListValCATBaseUnknown_var&)
- Retrieves the impacted objects.
- o
GetPasteTargets(CATListValCATBaseUnknown_var&)
- Retrieves the target objects.
- o
GetSourceObjectFromCopy(CATBaseUnknown*)
- Returns the source object from its copy.
- o
IsSourceInClipBoard()
- Returns information about the source context.
- o
IsTargetInClipBoard()
- Returns information about the target context.
Methods
o GetCopyObjectFromSource
| public GetCopyObjectFromSource( | const | iSource) |
-
Returns the copy object from its source.
Role: This method gives access to the mapping between source and copy objects during a Copy or a Paste operation.
- Parameters:
-
- iSource
- [in] Any interface pointer to the source object as a CATBaseUnknown pointer.
- Returns:
- A smart pointer holding an interface pointer to the related copy object if applicable, or NULL_var.
Warning: the exact type of the interface returned as a CATBaseUnknown pointer
is not part of the specification and may vary. Do not make any assumption about it.
o GetImpactedObjects
| public GetImpactedObjects( | | oSetOfObjects) |
-
Retrieves the impacted objects.
Role: This method retrieves the objects that will be impacted by the current operation.
- When the current operation is
, the set contains all the objects on which the CcpUpdate method will be invoked.
- When the current operation is
, the set contains the root objects that have been created and must be handled.
- Parameters:
-
- oSetOfObjects
- [out] A (caller provided) collection in which the list of objects that have to be processed during the operation will be stored.
If the method fails oSetOfObjects is not modified, it is otherwise overwritten with the retrieved value.
Warning: the exact type of the classes returned as CATBaseUnknown pointers
is not part of the specification and may vary. Do not make any assumption about it.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The list has been successfuly retrieved.
- E_FAIL
- This list cannot be retrived for the current operation.
- Other
- Another failure has occured.
o GetPasteTargets
| public GetPasteTargets( | | oPasteTargets) |
-
Retrieves the target objects.
Role: This method retrieves the list of targets for the paste operation.
- In case of an Edit -> Copy action in an intercative application, this method will fail.
- In case of an Edit -> Paste action in an intercative application, this method will succeed.
- When invoked in batch, or by other commands like
, result will depend on the context.
- Parameters:
-
- oPasteTargets
- [out] A (caller provided) collection in which the the list of targets for the paste operation will be stored.
If the method fails oPasteTargets is not modified, it is otherwise overwritten with the retrieved value.
Warning: the exact type of the classes returned as CATBaseUnknown pointers
is not part of the specification and may vary. Do not make any assumption about it.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The list has been successfuly retrieved.
- E_FAIL
- This list cannot be retrived for the current operation.
- Other
- Another failure has occured.
o GetSourceObjectFromCopy
| public GetSourceObjectFromCopy( | const | iCopy) |
-
Returns the source object from its copy.
Role: This method gives access to the mapping between source and copy objects during a Copy or a Paste operation.
- Parameters:
-
- iCopy
- [in] Any interface pointer to the copy object as a CATBaseUnknown pointer.
- Returns:
- A smart pointer holding an interface pointer to the related source object if applicable, or NULL_var.
Warning: the exact type of the interface returned as a CATBaseUnknown pointer
is not part of the specification and may vary. Do not make any assumption about it.
o IsSourceInClipBoard
| public IsSourceInClipBoard( | ) |
-
Returns information about the source context.
Role: Call this method to know whether the source of the Cut/Copy Paste operation is in a clipboard.
- In case of an Edit -> Copy action in an intercative application, this method will return FALSE
.
- In case of an Edit -> Paste action in an intercative application, this method will return TRUE
.
- When invoked in batch, or by other commands like
, result will depend on the context.
- Returns:
- An Boolean value.
- TRUE
- The objects to copy (source) of the current operation are in a clipboard.
- FALSE
- The objects to copy (source) of the current operation are not in a clipboard.
o IsTargetInClipBoard
| public IsTargetInClipBoard( | ) |
-
Returns information about the target context.
Role: Call this method to know whether the target of the Cut/Copy Paste operation is in a clipboard.
- In case of an Edit -> Copy action in an intercative application, this method will return TRUE
.
- In case of an Edit -> Paste action in an intercative application, this method will return FALSE
.
- When invoked in batch, or by other commands like
, result will depend on the context.
- Returns:
- An Boolean value.
- TRUE
- The copies (target) of the current operation are in a clipboard.
- FALSE
- The copies (target) of the current operation are not in a clipboard.
This object is included in the file: CATFmCCPContext.h
If needed, your Imakefile.mk should include the module: FeatureModelerExt
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.