DialogEngine CATPanelState
Usage: you must use this class as is. You should never derive it.
public class CATPanelState
Class representing a state dedicated to manage a dialog box.
Role: A dialog state is linked to agents, conditions and outgoing
transitions which depend on the Ok, Cancel, Apply, Preview, Close and
Help buttons of the dialog.
More precisely, this state has the following outgoing transitions:
- a Cancel transition which fires when the Cancel button is selected
and whose target state is the cancel state.
- an Ok transition which fires when the Ok button is selected
and whose target state is the NULL state.
- an Apply transition which fires when the Apply button is selected
and whose target state is the dialog state itself.
- a Preview transition which fires when the Preview button is selected
and whose target state is the dialog state itself.
- a Close transition which fires when the Close button is selected
and whose target state is the NULL state.
- a Help transition which fires when the Help button is selected
and whose target state is the dialog state itself.
As a command developer, you only need to associate an action to each
transition.
You may also add agents and outgoing transitions to this state and even
add a condition on the state or on the transition if a button selection is
not sufficient to fire a transition.
- See also:
-
Constructor and Destructor Index
- o
CATPanelState(CATCommand*,CATString&,CATDlgDialog*)
- Constructs a dialog state.
- o
~CATPanelState()
-
Method Index
- o
GetApplyTransition()
- Returns the transition linked to the Apply button.
- o
GetCancelTransition()
- Returns the transition linked to the Cancel button.
- o
GetCloseTransition()
- Returns the transition linked to the Close button.
- o
GetHelpTransition()
- Returns the transition linked to the Help button.
- o
GetOkTransition()
- Returns the transition linked to the Ok button.
- o
GetPreviewTransition()
- Returns the transition linked to the Preview button.
Constructor and Destructor
o CATPanelState
| public CATPanelState( | | iCmd, |
| const | iId, |
| | iDialog) |
-
Constructs a dialog state.
- Parameters:
-
- iCmd
- The command to which the state belongs.
Legal values: iCmd must be a
.
- iId
- The resource identifier used to retrieve the state prompt in the command
message file.
- iDialog
- The dialog linked to the state.
o ~CATPanelState
| public virtual ~CATPanelState( | ) |
-
Methods
o GetApplyTransition
| public GetApplyTransition( | ) |
-
Returns the transition linked to the Apply button.
- Returns:
- The transition.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
o GetCancelTransition
| public GetCancelTransition( | ) |
-
Returns the transition linked to the Cancel button.
- Returns:
- The transition.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
o GetCloseTransition
| public GetCloseTransition( | ) |
-
Returns the transition linked to the Close button.
- Returns:
- The transition.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
o GetHelpTransition
| public GetHelpTransition( | ) |
-
Returns the transition linked to the Help button.
- Returns:
- The transition.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
o GetOkTransition
-
Returns the transition linked to the Ok button.
- Returns:
- The transition.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
o GetPreviewTransition
| public GetPreviewTransition( | ) |
-
Returns the transition linked to the Preview button.
- Returns:
- The transition.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
This object is included in the file: CATPanelState.h
If needed, your Imakefile.mk should include the module: CATDialogEngine
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.