berryICommandService.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
 
#ifndef BERRYICOMMANDSERVICE_H_
#define BERRYICOMMANDSERVICE_H_
 
#include "../services/berryIDisposable.h"
 
#include <QHash>
 
namespace berry {
 
struct IExecutionListener;
struct IHandler;
struct IElementReference;
 
class UIElement;
class Command;
class CommandCategory;
class ParameterizedCommand;
class ParameterType;
 
struct BERRY_UI_QT ICommandService : public IDisposable
{
 
  berryObjectMacro(berry::ICommandService);
 
  static const QString AUTOGENERATED_CATEGORY_ID();
 
  virtual void AddExecutionListener(IExecutionListener* listener) = 0;
 
  virtual void DefineUncategorizedCategory(const QString& name, const QString& description) = 0;
 
  virtual SmartPointer<ParameterizedCommand> Deserialize(const QString& serializedParameterizedCommand) const = 0;
 
  virtual SmartPointer<CommandCategory> GetCategory(const QString& categoryId) const = 0;
 
  virtual SmartPointer<Command> GetCommand(const QString& commandId) const = 0;
 
  virtual QList<SmartPointer<CommandCategory> > GetDefinedCategories() const = 0;
 
  virtual QStringList GetDefinedCategoryIds() const = 0;
 
  virtual QStringList GetDefinedCommandIds() const = 0;
 
  virtual QList<SmartPointer<Command> > GetDefinedCommands() const = 0;
 
  virtual QStringList GetDefinedParameterTypeIds() const = 0;
 
  virtual QList<SmartPointer<ParameterType> > GetDefinedParameterTypes() const = 0;
 
  virtual QString GetHelpContextId(const SmartPointer<const Command>& command) const = 0;
 
  virtual QString GetHelpContextId(const QString& commandId) const = 0;
 
  virtual SmartPointer<ParameterType> GetParameterType(const QString& parameterTypeId) const = 0;
 
  virtual void ReadRegistry() = 0;
 
  virtual void RemoveExecutionListener(IExecutionListener* listener) = 0;
 
  virtual void SetHelpContextId(const SmartPointer<IHandler>& handler, const QString& helpContextId) = 0;
 
  virtual SmartPointer<IElementReference> RegisterElementForCommand(
      const SmartPointer<ParameterizedCommand>& command,
      const SmartPointer<UIElement>& element) = 0;
 
  virtual void RegisterElement(const SmartPointer<IElementReference>& elementReference) = 0;
 
  virtual void UnregisterElement(const SmartPointer<IElementReference>& elementReference) = 0;
 
  virtual void RefreshElements(const QString& commandId, const QHash<QString, Object::Pointer>& filter) = 0;
};
 
}
 
Q_DECLARE_INTERFACE(berry::ICommandService, "org.blueberry.ui.ICommandService")
 
#endif /* BERRYICOMMANDSERVICE_H_ */