Medical Imaging Interaction Toolkit  2021.10.99-1c4db16f
Medical Imaging Interaction Toolkit
berry::IExecutionListener Struct Referenceabstract

#include <berryIExecutionListener.h>

Inheritance diagram for berry::IExecutionListener:

Classes

struct  Events
 

Public Member Functions

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 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.

Definition at line 35 of file berryIExecutionListener.h.

Constructor & Destructor Documentation

◆ ~IExecutionListener()

virtual berry::IExecutionListener::~IExecutionListener ( )
virtual

Member Function Documentation

◆ NotHandled()

virtual void berry::IExecutionListener::NotHandled ( const QString &  commandId,
const NotHandledException *  exception 
)
pure virtual

Notifies the listener that an attempt was made to execute a command with no handler.

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

◆ PostExecuteFailure()

virtual void berry::IExecutionListener::PostExecuteFailure ( const QString &  commandId,
const ExecutionException *  exception 
)
pure virtual

Notifies the listener that a command has failed to complete execution.

Parameters
commandIdThe identifier of the command that has executed; never null.
exceptionThe exception that occurred; never null.

◆ PostExecuteSuccess()

virtual void berry::IExecutionListener::PostExecuteSuccess ( const QString &  commandId,
const Object::Pointer returnValue 
)
pure virtual

Notifies the listener that a command has completed execution successfully.

Parameters
commandIdThe identifier of the command that has executed; never null.
returnValueThe return value from the command; may be null.

◆ PreExecute()

virtual void berry::IExecutionListener::PreExecute ( const QString &  commandId,
const SmartPointer< const ExecutionEvent > &  event 
)
pure virtual

Notifies the listener that a command is about to execute.

Parameters
commandIdThe identifier of the command that is about to execute, never null.
eventThe event that will be passed to the execute method; never null.

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