DialogEngine CATAcquisitionAgent
Usage: you must use this class as is. You should never derive it.
public class CATAcquisitionAgent
Base class for a state command acquisition agent.
Role: An acquisition agent is a specific dialog agent dedicated
to get something "under the mouse" in addition to the notification.
Acquisition agents are valued as dialog agents, but in addition, they
store values.
Do not instantiate directly acquisition agents because this base class
is useless as it is. Instead, use one of its derived classes:
or
.
Constructor and Destructor Index
- o
~CATAcquisitionAgent()
-
Method Index
- o
GetContextualMenu()
- Returns the contextual menu.
- o
GetValuationState()
- Returns the valuation state of the agent.
- o
SetFilter(CATAcquisitionFilter*)
- Associates a filter to the acquisition agent.
- o
SetValuation()
- Values an agent dynamically.
Enumerated Type Index
- o
ValuationState
- Agent valuation state.
Constructor and Destructor
o ~CATAcquisitionAgent
| public virtual ~CATAcquisitionAgent( | ) |
-
Methods
o GetContextualMenu
| public GetContextualMenu( | ) |
-
Returns the contextual menu.
Precondition: The agent must expect a
notification and must have been valued. Such a notification is sent when
the user clicks with the right mouse button.
- Returns:
- The contextual menu.
o GetValuationState
| public virtual GetValuationState( | ) |
-
Returns the valuation state of the agent.
Role: It is the latest state of the agent.
For example, if a valued agent receives a prevaluation, the returned state
is PreValuated, whereas it is still valued.
- Returns:
- The valuation state.
o SetFilter
| public SetFilter( | | iFilter) |
-
Associates a filter to the acquisition agent.
- Parameters:
-
- iFilter
- The filter to be applied.
o SetValuation
| public virtual SetValuation( | ) |
-
Values an agent dynamically.
Precondition: Use the
or the
method before, to give a value to the agent. But these methods are useless if you do not call
SetValuation just after.
Enumerated Types
o ValuationState
-
enum ValuationState {
NotValuated,
Transient,
PreValuated,
Valuated
}
Agent valuation state.
Role: It is linked to the latest meaningful notification received
by the agent.
- Parameters:
-
- NotValuated
- The agent is neither valued nor prevalued. It has not received expected
notifications or has been reinitialized since then.
- Transient
- The agent has received an expected notification which is being studied
and is not accepted yet.
- PreValuated
- The agent has received a notification representing a prevaluation.
In general, the prevaluation is associated with the
and
notifications and happens when an object is under the mouse without being selected.
- Valuated
- The agent has received a notification representing a valuation.
In general, the valuation is associated with the
notification and happens when an object is selected with a
mouse left click.
This object is included in the file: CATAcquisitionAgent.h
If needed, your Imakefile.mk should include the module: CATDialogEngine
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.