berryIWorkbenchPage.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 BERRYIWORKBENCHPAGE_H_
#define BERRYIWORKBENCHPAGE_H_

#include <berryMacros.h>

#include "berryIEditorReference.h"
#include "berryIViewReference.h"
#include "berryIPerspectiveDescriptor.h"
#include "berryIEditorPart.h"
#include "berryIViewPart.h"
#include "berryIEditorInput.h"
#include "berryIPartService.h"
#include "berryISelectionService.h"
#include "berryIReusableEditor.h"

#include "berryIWorkbenchWindow.h"


namespace berry {

struct IExtensionTracker;

struct BERRY_UI_QT IWorkbenchPage : public IPartService, public ISelectionService, public Object
{

  berryObjectMacro(berry::IWorkbenchPage);

  ~IWorkbenchPage() override;

  static const QString EDITOR_ID_ATTR; // = "org.blueberry.ui.editorID";

  static const QString CHANGE_RESET; // = "reset";

  static const QString CHANGE_RESET_COMPLETE; // = "resetComplete";

  static const QString CHANGE_VIEW_SHOW; // = "viewShow";

  static const QString CHANGE_VIEW_HIDE; // = "viewHide";

  static const QString CHANGE_EDITOR_OPEN; // = "editorOpen";

  static const QString CHANGE_EDITOR_CLOSE; // = "editorClose";

  static const QString CHANGE_EDITOR_AREA_SHOW; // = "editorAreaShow";

  static const QString CHANGE_EDITOR_AREA_HIDE; // = "editorAreaHide";

  static const QString CHANGE_ACTION_SET_SHOW; // = "actionSetShow";

  static const QString CHANGE_ACTION_SET_HIDE; // = "actionSetHide";

  static const int VIEW_ACTIVATE; // = 1;

  static const int VIEW_VISIBLE; // = 2;

  static const int VIEW_CREATE; // = 3;

  static const int MATCH_NONE; // = 0;

  static const int MATCH_INPUT; // = 1;

  static const int MATCH_ID; // = 2;

  virtual void Activate(IWorkbenchPart::Pointer part) = 0;

  //virtual void addPropertyChangeListener(IPropertyChangeListener listener);

  virtual void BringToTop(IWorkbenchPart::Pointer part) = 0;

  virtual bool Close() = 0;

  virtual bool CloseAllEditors(bool save) = 0;

  virtual bool CloseEditors(const QList<IEditorReference::Pointer>& editorRefs, bool save) = 0;

  virtual bool CloseEditor(IEditorPart::Pointer editor, bool save) = 0;

  virtual IViewPart::Pointer FindView(const QString& viewId) = 0;

  virtual IViewReference::Pointer FindViewReference(const QString& viewId) = 0;

  virtual IViewReference::Pointer FindViewReference(const QString& viewId, const QString& secondaryId) = 0;

  virtual IEditorPart::Pointer GetActiveEditor() = 0;

  virtual IEditorPart::Pointer FindEditor(IEditorInput::Pointer input) = 0;

  virtual QList<IEditorReference::Pointer> FindEditors(IEditorInput::Pointer input, const QString& editorId,
      int matchFlags) = 0;

  virtual QList<IEditorPart::Pointer> GetEditors() = 0;

  virtual QList<IEditorReference::Pointer> GetEditorReferences() = 0;

  virtual QList<IEditorPart::Pointer> GetDirtyEditors() = 0;

  virtual IAdaptable* GetInput() = 0;

  virtual QString GetLabel() = 0;

  virtual IPerspectiveDescriptor::Pointer GetPerspective() = 0;

  virtual QList<IViewReference::Pointer> GetViewReferences() = 0;

  virtual QList<IViewPart::Pointer> GetViews() = 0;

  virtual IWorkbenchWindow::Pointer GetWorkbenchWindow() const = 0;

  virtual void HideView(IViewPart::Pointer view) = 0;

  virtual void HideView(IViewReference::Pointer view) = 0;

  //virtual bool HasView(const QString& perspectiveId, const QString& viewId) = 0;

  virtual bool IsPartVisible(IWorkbenchPart::Pointer part) = 0;

  //virtual void RemovePerspective(IPerspectiveDescriptor::Pointer desc) = 0;

  virtual void ReuseEditor(IReusableEditor::Pointer editor, IEditorInput::Pointer input) = 0;

  virtual IEditorPart::Pointer OpenEditor(IEditorInput::Pointer input, const QString& editorId) = 0;

  virtual IEditorPart::Pointer OpenEditor(IEditorInput::Pointer input, const QString& editorId,
      bool activate) = 0;

  virtual IEditorPart::Pointer OpenEditor(IEditorInput::Pointer input,
      const QString& editorId, bool activate, int matchFlags) = 0;

  //virtual void removePropertyChangeListener(IPropertyChangeListener listener);

  virtual void ResetPerspective() = 0;

  virtual bool SaveAllEditors(bool confirm) = 0;

  virtual bool SaveEditor(IEditorPart::Pointer editor, bool confirm) = 0;

  virtual void SavePerspective() = 0;

  virtual void SavePerspectiveAs(IPerspectiveDescriptor::Pointer perspective) = 0;


  virtual void SetPerspective(IPerspectiveDescriptor::Pointer perspective) = 0;

  virtual IViewPart::Pointer ShowView(const QString& viewId) = 0;

  virtual IViewPart::Pointer ShowView(const QString& viewId, const QString& secondaryId, int mode) = 0;

  virtual bool IsEditorPinned(IEditorPart::Pointer editor) = 0;

  virtual QList<QString> GetPerspectiveShortcuts() = 0;

  virtual QList<QString> GetShowViewShortcuts() = 0;

  virtual QList<IPerspectiveDescriptor::Pointer> GetOpenPerspectives() = 0;

  virtual QList<IPerspectiveDescriptor::Pointer> GetSortedPerspectives() = 0;

  //virtual void CloseCurrentPerspective(bool saveParts, bool closePage) = 0;

  virtual void ClosePerspective(IPerspectiveDescriptor::Pointer desc,
                                bool saveParts, bool closePage) = 0;

  virtual void CloseAllPerspectives(bool saveEditors, bool closePage) = 0;

  virtual IExtensionTracker* GetExtensionTracker() const = 0;

  virtual IWorkbenchPartReference::Pointer GetReference(IWorkbenchPart::Pointer part) = 0;
};

}  // namespace berry

#endif /*BERRYIWORKBENCHPAGE_H_*/