CATFmtUIInterfaces CATFmtSelectionTrapAgent
Usage: you must use this class as is. You should never derive it.
public class CATFmtSelectionTrapAgent
Selection trap agent.
Role: This dialog agent enable to selects objects using a trap.
It should be used along with another object that will build the selection from the trap contour.
see .
Constructor and Destructor Index
- o
CATFmtSelectionTrapAgent(CATString&,CATIFmtTrapSelector*,void*,CATString&)
- Constructs a selection trap agent.
- o
~CATFmtSelectionTrapAgent()
- Destructor.
Method Index
- o
GetListOfValues()
- Returns the list of selected objects.
- o
InitializeAcquisition()
- Resets the valuation if the trap agent.
Constructor and Destructor
o CATFmtSelectionTrapAgent
| public CATFmtSelectionTrapAgent( | const | iId, |
| | iSelector, |
| | iData | = NULL , |
| const | iProviderName | = "" ) |
-
Constructs a selection trap agent.
- Parameters:
-
- iId
- The agent identifier. It is used to retrieve the undo/redo titles in
the command message file.
- iSelector
- Object that will build the selection from the trap contour.
- iData
- An object that can be useful for the selection (see
.
- iUIProvider
- Do not use, reserved for internal use.
o ~CATFmtSelectionTrapAgent
| public virtual ~CATFmtSelectionTrapAgent( | ) |
-
Destructor.
Methods
o GetListOfValues
-
Returns the list of selected objects.
Lifecycle rules deviation: This method doesn't AddRef the
returned list.
o InitializeAcquisition
| public InitializeAcquisition( | ) |
-
Resets the valuation if the trap agent.
This object is included in the file: CATFmtSelectionTrapAgent.h
If needed, your Imakefile.mk should include the module: CATFmtUIInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.