DialogEngine CATOtherDocumentAgent
Usage: you must use this class as is. You should never derive it.
public class CATOtherDocumentAgent
Class to define a dialog agent that enables selection in a nonactive document.
Role:This dialog agent enables you to select objects in a nonactive document
thanks to a command launched from the active state dialog command. As usual, you need
to instantiate the dialog agent in the state dialog command' BuildGraph method and
associate it with a given state. The dialog agent constructor includes a parameter to
indicate the class name of the command to launch when the state becomes
the active one. This command is then launched in all the other open documents' editors.
Such a command class must derive from . The dialog agent is assigned a value using this command, and all the launched
command instances are automatically deleted.
Important:A transaction must be triggered when this agent is valuated.
Constructor and Destructor Index
- o
CATOtherDocumentAgent(CATString&,CATClassId,char*,CATClassId,CATDlgEngBehavior)
- Constructs a dialog agent that enables selection in a non-active document
- o
~CATOtherDocumentAgent()
-
Constructor and Destructor
o CATOtherDocumentAgent
| public CATOtherDocumentAgent( | const | iId, |
| | iCommandToLaunchInDocuments, |
| const | iLibrary, |
| | iType | =NULL, |
| | iBehavior | =NULL) |
-
Constructs a dialog agent that enables selection in a non-active document
- Parameters:
-
- iId
- The agent identifier. It is used to retrieve the undo/redo titles in
the command message file.
- iCommandToLaunchInDocuments
- The class name of the command to launch in the other documents to select
objects. This command must
derive from
.
- iLibrary
- The name of the shared library, without its extension and without
the prefix lib, that contains the command code.
- iType
- The type of the expected objects.
The type corresponds to an interface implemented by the object.
Legal values: iType is the name of an interface
that the expected objects must implement. If it is NULL, all the objects
are accepted.
- iBehavior
- The behavior of the dialog agent.
Legal values: The behavior is given as a
concatenation of the facet values using the | character.
e.g.: CATDlgEngRepeat|CATDlgEngActive
If it is NULL, the agent has the default behavior value for each
facet.
The behavior may be specified later using the
method.
o ~CATOtherDocumentAgent
| public virtual ~CATOtherDocumentAgent( | ) |
-
This object is included in the file: CATOtherDocumentAgent.h
If needed, your Imakefile.mk should include the module: CATDialogEngine
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.