DialogEngine CATMultiDocumentCommand

Usage: you can derive this class.

public class CATMultiDocumentCommand

Base class to define a state dialog command to achieve a selection in any nonactive document.
Role: This class enables a selection in a nonactive document from a state dialog command running in the workbench of the active document.
Derive CATMultiDocumentCommand to create a class that should be instantiated by a dialog agent of another state dialog command that runs in the active document. The dialog agent must be an instance of .
When the state with which the dialog agent is associated becomes active, an instance of CATMultiDocumentCommand is created for any nonactive document as a proxy of the active command to select either an object or a set of objects in one of these nonactive documents.
As for any state dialog command, you need to override the method, create at least a state, associate with this state a Agent instance to enable selection, and create an Action method that uses the or method, depending on whether you enable multiselection.

See also:

Method Index


o ReturnListOfValues(CATSO*)
Returns to the agent the selected objects as a path element.
o ReturnValue(CATPathElement*)
Returns to the agent the selected object as a path element.

Data Member Index


o _fromCommand
The agent which has instantiated this command.

Methods


o ReturnListOfValues
public ReturnListOfValues( iList)
Returns to the agent the selected objects as a path element.
Role:Use this method in case of multi-selection. Just after executing this method the command will be automatically deleted.
The list is sent to the CATOtherDocumentAgent which has instantiated this command.
Parameters:
iList
List of selected elements.
o ReturnValue
public ReturnValue( iValue)
Returns to the agent the selected object as a path element.
Role:Use this method when the selection is single. Just after executing this method the command will be automatically deleted.
The value is sent to the CATOtherDocumentAgent which has instantiated this command.
Parameters:
iValue
Element selected.

Data Members


o _fromCommand 
  protected CATOtherDocumentAgent * _fromCommand
The agent which has instantiated this command.
This object is included in the file: CATMultiDocumentCommand.h
If needed, your Imakefile.mk should include the module: CATDialogEngine

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