berry::IExecutionListener Struct Reference

#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 39 of file berryIExecutionListener.h.

Constructor & Destructor Documentation

berry::IExecutionListener::~IExecutionListener ( )

virtual

Definition at line 70 of file berryIExecutionListener.cpp.

Member Function Documentation

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

commandId	The identifier of command that is not handled; never null
exception	The exception that occurred; never null.

Referenced by berry::IExecutionListener::Events::AddListener(), and berry::IExecutionListener::Events::RemoveListener().

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

commandId	The identifier of the command that has executed; never null.
exception	The exception that occurred; never null.

Referenced by berry::IExecutionListener::Events::AddListener(), and berry::IExecutionListener::Events::RemoveListener().

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

commandId	The identifier of the command that has executed; never null.
returnValue	The return value from the command; may be null.

Referenced by berry::IExecutionListener::Events::AddListener(), and berry::IExecutionListener::Events::RemoveListener().

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

commandId	The identifier of the command that is about to execute, never null.
event	The event that will be passed to the execute method; never null.

Referenced by berry::IExecutionListener::Events::AddListener(), and berry::IExecutionListener::Events::RemoveListener().

---

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

• berryIExecutionListener.h
• berryIExecutionListener.cpp