berryIContextService.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 BERRYICONTEXTSERVICE_H
#define BERRYICONTEXTSERVICE_H

#include "berryIServiceWithSources.h"

namespace berry {

struct IContextActivation;
struct IContextManagerListener;

class Context;
class Expression;
class Shell;

struct IContextService : public IServiceWithSources
{

  static const QString CONTEXT_ID_WORKBENCH_MENU; // = "org.blueberry.ui.contexts.workbenchMenu";

  static const QString CONTEXT_ID_DIALOG; // = "org.blueberry.ui.contexts.dialog";

  static const QString CONTEXT_ID_DIALOG_AND_WINDOW; // = "org.blueberry.ui.contexts.dialogAndWindow";

  static const QString CONTEXT_ID_WINDOW; // = "org.blueberry.ui.contexts.window";

  enum ShellType {
    TYPE_DIALOG = 0,

    TYPE_NONE = 1,

    TYPE_WINDOW = 2
  };

  virtual SmartPointer<IContextActivation> ActivateContext(const QString& contextId) = 0;

  virtual SmartPointer<IContextActivation> ActivateContext(const QString& contextId,
                                                           const SmartPointer<Expression>& expression) = 0;

  virtual SmartPointer<IContextActivation> ActivateContext(const QString& contextId,
                                                           const SmartPointer<Expression>& expression,
                                                           bool global) = 0;

  virtual void AddContextManagerListener(IContextManagerListener* listener) = 0;

  virtual void DeactivateContext(const SmartPointer<IContextActivation>& activation) = 0;

  virtual void DeactivateContexts(const QList<SmartPointer<IContextActivation> >& activations) = 0;

  virtual QList<QString> GetActiveContextIds() const = 0;

  virtual SmartPointer<Context> GetContext(const QString& contextId) const = 0;

  virtual QList<SmartPointer<Context> > GetDefinedContexts() const = 0;

  virtual QList<QString> GetDefinedContextIds() const = 0;

  virtual ShellType GetShellType(const SmartPointer<Shell>& shell) const = 0;

  virtual ShellType GetShellType(QWidget* widget) const = 0;

  virtual void ReadRegistry() = 0;

  virtual bool RegisterShell(const SmartPointer<Shell>& shell, ShellType type) = 0;

  virtual void RemoveContextManagerListener(IContextManagerListener* listener) = 0;

  virtual bool UnregisterShell(const SmartPointer<Shell>& shell) = 0;

  virtual void DeferUpdates(bool defer) = 0;

};

}

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

#endif // BERRYICONTEXTSERVICE_H