berryIHandlerService.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 BERRYIHANDLERSERVICE_H_
#define BERRYIHANDLERSERVICE_H_

#include "services/berryIServiceWithSources.h"

#include "common/berryCommandExceptions.h"

namespace berry {

class Command;
class ExecutionEvent;
class ParameterizedCommand;
class Expression;
class UIElement;

struct IEvaluationContext;
struct IHandler;
struct IHandlerActivation;

struct BERRY_UI_QT IHandlerService : public IServiceWithSources
{

  berryObjectMacro(berry::IHandlerService)

  ~IHandlerService();

  virtual SmartPointer<IHandlerActivation> ActivateHandler(const SmartPointer<IHandlerActivation>& activation) = 0;

  virtual SmartPointer<IHandlerActivation> ActivateHandler(
      const QString& commandId, const SmartPointer<IHandler>& handler) = 0;

  virtual SmartPointer<IHandlerActivation> ActivateHandler(
      const QString& commandId,
      const SmartPointer<IHandler>& handler,
      const SmartPointer<Expression>& expression) = 0;

  virtual SmartPointer<IHandlerActivation> ActivateHandler(
      const QString& commandId,
      const SmartPointer<IHandler>& handler,
      const SmartPointer<Expression>& expression, bool global) = 0;

  virtual SmartPointer<const ExecutionEvent> CreateExecutionEvent(
      const SmartPointer<const Command>& command,
      const SmartPointer<const UIElement>& uielement) = 0;

  virtual SmartPointer<const ExecutionEvent> CreateExecutionEvent(
      const SmartPointer<const ParameterizedCommand>& command,
      const SmartPointer<const UIElement>& uielement) = 0;

  virtual void DeactivateHandler(const SmartPointer<IHandlerActivation>& activation) = 0;

  virtual void DeactivateHandlers(
      const QList<SmartPointer<IHandlerActivation> >& activations) = 0;

  virtual Object::Pointer ExecuteCommand(const QString& commandId,
                                         const SmartPointer<const UIElement>& uielement) = 0;

  virtual Object::Pointer ExecuteCommand(const SmartPointer<ParameterizedCommand>& command,
                                         const SmartPointer<const UIElement>& uielement) = 0;

  virtual Object::Pointer ExecuteCommandInContext(
      const SmartPointer<ParameterizedCommand>& command,
      const SmartPointer<const UIElement>& uielement,
      const SmartPointer<IEvaluationContext>& context) = 0;

  virtual SmartPointer<IEvaluationContext> CreateContextSnapshot(bool includeSelection) = 0;

  virtual SmartPointer<IEvaluationContext> GetCurrentState() const = 0;

  virtual void ReadRegistry() = 0;

  virtual void SetHelpContextId(const SmartPointer<IHandler>& handler, const QString& helpContextId) = 0;
};

}

Q_DECLARE_INTERFACE(berry::IHandlerService, "org.blueberry.ui.IHandlerService")

#endif /* BERRYIHANDLERSERVICE_H_ */