berryIExecutionListener.h

Go to the documentation of this file.

/*===================================================================

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/


#ifndef BERRYIEXECUTIONLISTENER_H_
#define BERRYIEXECUTIONLISTENER_H_

#include <berryObject.h>
#include <berryMessage.h>

#include <org_blueberry_core_commands_Export.h>
#include "common/berryCommandExceptions.h"

namespace berry {

class ExecutionEvent;

struct BERRY_COMMANDS IExecutionListener
{

  struct Events {

    Message2<const QString&, const NotHandledException*> notHandled;
    Message2<const QString&, const ExecutionException*> postExecuteFailure;
    Message2<const QString&, const Object::Pointer&> postExecuteSuccess;
    Message2<const QString&, const SmartPointer<const ExecutionEvent>& > preExecute;

    virtual ~Events();

    virtual void AddListener(IExecutionListener* listener);
    virtual void RemoveListener(IExecutionListener* listener);
    virtual bool HasListeners() const;
    virtual bool IsEmpty() const;

    private:

    typedef MessageDelegate2<IExecutionListener, const QString&, const NotHandledException* > NotHandledDelegate;
    typedef MessageDelegate2<IExecutionListener, const QString&, const ExecutionException*> PostExecuteFailureDelegate;
    typedef MessageDelegate2<IExecutionListener, const QString&, const Object::Pointer&> PostExecuteSuccessDelegate;
    typedef MessageDelegate2<IExecutionListener, const QString&, const SmartPointer<const ExecutionEvent>& > PreExecuteDelegate;
  };

  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;
};

}

#endif /* BERRYIEXECUTIONLISTENER_H_ */