DialogEngine CATStateCancelNotification

Usage: you must use this class as is. You should never derive it.


public class CATStateCancelNotification

Class representing a notification whose instance is received when a state command is cancelled.
Role: As a command developer you don't need to create an instance of this class.

See also:


Constructor and Destructor Index


o ~CATStateCancelNotification()

Method Index


o GetType()
Returns the type of the activate notification.

Enumerated Type Index


o CancelType
Cancel notification type.

Constructor and Destructor


o ~CATStateCancelNotification
public virtual ~CATStateCancelNotification()

Methods


o GetType
public GetType()
Returns the type of the activate notification.
Role: It is useful to know whether the command completes normally or is interrupted by an exclusive command.
Returns:
The type.

Enumerated Types


o CancelType
enum CancelType {
  End,
  Interrupt,
  Undo
}
Cancel notification type.
Parameters:
End
The command completes normally because it has reached the NULL state.
Interrupt
The command ends because it is cancelled by an exclusive command.
Undo
The command ends because its activation is undone.

This object is included in the file: CATStateCancelNotification.h
If needed, your Imakefile.mk should include the module: CATDialogEngine

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.