Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
berry::IExecutionListenerWithChecks Struct Referenceabstract

#include <berryIExecutionListenerWithChecks.h>

Inheritance diagram for berry::IExecutionListenerWithChecks:
Collaboration diagram for berry::IExecutionListenerWithChecks:

Classes

struct  Events
 

Public Member Functions

virtual void NotDefined (const QString &commandId, const NotDefinedException *exception)=0
 
virtual void NotEnabled (const QString &commandId, const NotEnabledException *exception)=0
 
- Public Member Functions inherited from berry::IExecutionListener
virtual ~IExecutionListener ()
 
virtual void NotHandled (const QString &commandId, const NotHandledException *exception)=0
 
virtual void PostExecuteFailure (const QString &commandId, const ExecutionException *exception)=0
 
virtual void PostExecuteSuccess (const QString &commandId, const Object::Pointer &returnValue)=0
 
virtual void PreExecute (const QString &commandId, const SmartPointer< const ExecutionEvent > &event)=0
 

Detailed Description

A listener to the execution of commands. This listener will be notified if someone tries to execute a command and it is not enabled or not defined. The listener also be notified if a command is about to execute, and when that execution completes. It is not possible for the listener to prevent the execution, only to respond to it in some way.

Clients may implement.

Definition at line 34 of file berryIExecutionListenerWithChecks.h.

Member Function Documentation

◆ NotDefined()

virtual void berry::IExecutionListenerWithChecks::NotDefined ( const QString &  commandId,
const NotDefinedException *  exception 
)
pure virtual

Notifies the listener that an attempt was made to execute a command that is not defined.

Parameters
commandIdThe identifier of command that is not defined; never null
exceptionThe exception that occurred; never null.

◆ NotEnabled()

virtual void berry::IExecutionListenerWithChecks::NotEnabled ( const QString &  commandId,
const NotEnabledException *  exception 
)
pure virtual

Notifies the listener that an attempt was made to execute a command that is disabled.

Parameters
commandIdThe identifier of command that is not enabled; never null
exceptionThe exception that occurred; never null.

The documentation for this struct was generated from the following file: