All Frameworks Class Hierarchy This Framework Next Indexes
DialogEngine Notification CATStateActivateNotification
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATNotification
|
+---CATStateActivateNotification
Usage: you must use this class as is. You should never derive it.
public class CATStateActivateNotification
Class representing a notification whose instance is received when a state
command is activated.
Role: As a command developer you don't need to create an instance
of this class.
- See also:
- CATStateCommand
Constructor and Destructor Index
- o
~CATStateActivateNotification()
-
Method Index
- o
GetType()
- Returns the type of the activate notification.
- o
ResumedAfterSharedKO()
- Returns whether the shared command reached the Cancel state.
Enumerated Type Index
- o
ActivateType
- Activate notification type.
Constructor and Destructor
o ~CATStateActivateNotification
public virtual ~CATStateActivateNotification( | ) |
-
Methods
o GetType
public CATStateActivateNotification::ActivateType GetType( | ) |
-
Returns the type of the activate notification.
Role: It is useful to know whether the command begins or
resumes after a deactivation.
- Returns:
- The type, which is Begin or Resume, not ResumeAfterSharedKO.
o ResumedAfterSharedKO
-
Returns whether the shared command reached the Cancel state.
Role: When the command resumes after a deactivation, it is useful to
know whether the shared command having involved the deactivation reached the Cancel state.
- Returns:
- The type.
Enumerated Types
o ActivateType
-
enum ActivateType {
Begin,
Resume,
ResumeThenLocalUndo
}
Activate notification type.
- Parameters:
-
- Begin
- The command starts from the beggining.
- Resume
- The command restarts at the state which was the current one when a shared
command took the focus from it.
- ResumeAfterSharedKO
- The command restarts at the state which was the current one when a shared
command took the focus from it, but this shared reached the Cancel State.
This object is included in the file: CATStateActivateNotification.h
If needed, your Imakefile.mk should include the module: CATDialogEngine