CATMecModUIExtendItf CATMmrPanelStateCmd
Usage: you can derive this class.
public class CATMmrPanelStateCmd
Base class for mechanical feature creation and edition commands.
Role: Derives this class to implement your command.
Overrides the GiveMyPanel method to return the dialog box
associated with your command.
Overrides the OkAction, ApplyAction,... to customize
the actions on click button events.
Constructor and Destructor Index
- o
CATMmrPanelStateCmd(CATString&,CATDlgEngBehavior,CATCommandMode,int,CATPathElement*,CATPathElement*)
- Constructs the commands.
- o
~CATMmrPanelStateCmd()
- Deletes the command.
Method Index
- o
AddPanelState(CATString&)
- Creates a CATCustomizableState associated with your dialog box.
- o
ApplyAction(void*)
- Deals with Appply button click event.
- o
BuildGraph()
- Builds the command graph.
- o
Cancel(CATCommand*,CATNotification*)
- Cancels the command.
- o
CancelAction(void*)
- Deals with Cancel button click event.
- o
GetInitialPanelState(CATString&)
- Returns the first CATCustomizableState associated with your dialog box.
- o
GetMode()
- Gets the command mode.
- o
GiveMyPanel()
- Gets the dialog box.
- o
OkAction(void*)
- Deals with Ok button click event.
- o
PreviewAction(void*)
- Deals with Preview button click event.
- o
UpdateKOAction(void*)
- Deals with Ok button click event.
- o
UpdateOKAction(void*)
- Deals with Ok button click event.
Constructor and Destructor
o CATMmrPanelStateCmd
| public CATMmrPanelStateCmd( | const | iName, |
| | iBehavior | = NULL, |
| | iStatus | = CATCommandModeExclusive, |
| | iCreateCommand | = 0, |
| const | iWorkingPath | = 0, |
| const | iActiveObjectPath | = 0) |
-
Constructs the commands.
- Parameters:
-
- iName
- as in CATStateCommand.
- iBehavior
- as in CATStateCommand.
- iStatus
- as in CATStateCommand.
- iCreateCommand
- The command mode:
Legal values:
- 0: edition mode.
- 1: creation mode.
- See also:
-
o ~CATMmrPanelStateCmd
| public virtual ~CATMmrPanelStateCmd( | ) |
-
Deletes the command.
If the command has been constructed with the third argument iStatus equal to CATCommandModeUndefined,
it must be deleted by calling the method RequestDelayedDestruction.
In the other cases, it it will be automatically deleted.
Never call a delete on it.
Methods
o AddPanelState
| public AddPanelState( | const | iId) |
-
Creates a CATCustomizableState associated with your dialog box.
- Parameters:
-
- iId
- The resource identifier used to retrieve the state prompt in the command
message file.
- Returns:
- The created CATCustomizableState.
Do not release the return value.
o ApplyAction
| public virtual ApplyAction( | | iData) |
-
Deals with Appply button click event.
- Parameters:
-
- iData
- An object that can be useful for the action.
o BuildGraph
| public virtual BuildGraph( | ) |
-
Builds the command graph.
- See also:
-
o Cancel
| public virtual Cancel( | | iCmd, |
| | iNotif) |
-
Cancels the command.
- See also:
-
- Parameters:
-
- iCmd
- The command that requests to cancel the current one
- iNotif
- The notification sent
o CancelAction
| public virtual CancelAction( | | iData) |
-
Deals with Cancel button click event.
- Parameters:
-
- iData
- An object that can be useful for the action.
o GetInitialPanelState
| public GetInitialPanelState( | const | iId) |
-
Returns the first CATCustomizableState associated with your dialog box.
- Parameters:
-
- iId
- The resource identifier used to retrieve the state prompt in the command
message file.
- Returns:
- The first CATCustomizableState.
Do not release the return value.
o GetMode
-
Gets the command mode.
- Returns:
- The value.
Legal values:
- 0 edit mode.
- 1 create mode.
o GiveMyPanel
| public virtual GiveMyPanel( | ) |
-
Gets the dialog box.
Override this method to return your own dialog box.
- Returns:
- The dialog box associated with the command.
o OkAction
| public virtual OkAction( | | iData) |
-
Deals with Ok button click event.
- Parameters:
-
- iData
- An object that can be useful for the action.
o PreviewAction
| public virtual PreviewAction( | | iData) |
-
Deals with Preview button click event.
- Parameters:
-
- iData
- An object that can be useful for the action.
o UpdateKOAction
| public virtual UpdateKOAction( | | iData) |
-
Deals with Ok button click event. Update is KO.
- Parameters:
-
- iData
- An object that can be useful for the action.
o UpdateOKAction
| public virtual UpdateOKAction( | | iData) |
-
Deals with Ok button click event. Update is OK.
- Parameters:
-
- iData
- An object that can be useful for the action.
This object is included in the file: CATMmrPanelStateCmd.h
If needed, your Imakefile.mk should include the module: CATMecModUIExtendItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.