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

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 BERRYIEDITORSITE_H_
#define BERRYIEDITORSITE_H_

#include "berryIWorkbenchPartSite.h"

namespace berry {

/**
 * \ingroup org_blueberry_ui_qt
 *
 * The primary interface between an editor part and the workbench.
 * <p>
 * The workbench exposes its implementation of editor part sites via this
 * interface, which is not intended to be implemented or extended by clients.
 * </p>
 */
struct BERRY_UI_QT IEditorSite : public virtual IWorkbenchPartSite {

  berryObjectMacro(berry::IEditorSite);

  ~IEditorSite() override;

    /**
     * Returns the action bar contributor for this editor.
     * <p>
     * An action contributor is responsible for the creation of actions.
     * By design, this contributor is used for one or more editors of the same type.
     * Thus, the contributor returned by this method is not owned completely
     * by the editor - it is shared.
     * </p>
     *
     * @return the editor action bar contributor, or <code>null</code> if none exists
     */
    //virtual IEditorActionBarContributor getActionBarContributor();

    /**
   * Returns the action bars for this part site. Editors of the same type (and
   * in the same window) share the same action bars. Contributions to the
   * action bars are done by the <code>IEditorActionBarContributor</code>.
   *
   * @return the action bars
   * @since 2.1
   */
    //virtual IActionBars getActionBars();

    /**
     * <p>
     * Registers a pop-up menu with the default id for extension. The default id
     * is defined as the part id.
     * </p>
     * <p>
     * By default, context menus include object contributions based on the
     * editor input for the current editor. It is possible to override this
     * behaviour by calling this method with <code>includeEditorInput</code>
     * as <code>false</code>. This might be desirable for editors that
     * present a localized view of an editor input (e.g., a node in a model
     * editor).
     * </p>
     * <p>
     * For a detailed description of context menu registration see
     * {@link IWorkbenchPartSite#registerContextMenu(MenuManager, ISelectionProvider)}
     * </p>
     *
     * @param menuManager
     *            the menu manager; must not be <code>null</code>.
     * @param selectionProvider
     *            the selection provider; must not be <code>null</code>.
     * @param includeEditorInput
     *            Whether the editor input should be included when adding object
     *            contributions to this context menu.
     * @see IWorkbenchPartSite#registerContextMenu(MenuManager,
     *      ISelectionProvider)
     * @since 3.1
     */
//    virtual void registerContextMenu(MenuManager menuManager,
//            ISelectionProvider selectionProvider, boolean includeEditorInput);

    /**
     * <p>
     * Registers a pop-up menu with a particular id for extension. This method
     * should only be called if the target part has more than one context menu
     * to register.
     * </p>
     * <p>
     * By default, context menus include object contributions based on the
     * editor input for the current editor. It is possible to override this
     * behaviour by calling this method with <code>includeEditorInput</code>
     * as <code>false</code>. This might be desirable for editors that
     * present a localized view of an editor input (e.g., a node in a model
     * editor).
     * </p>
     * <p>
     * For a detailed description of context menu registration see
     * {@link IWorkbenchPartSite#registerContextMenu(MenuManager, ISelectionProvider)}
     * </p>
     *
     * @param menuId
     *            the menu id; must not be <code>null</code>.
     * @param menuManager
     *            the menu manager; must not be <code>null</code>.
     * @param selectionProvider
     *            the selection provider; must not be <code>null</code>.
     * @param includeEditorInput
     *            Whether the editor input should be included when adding object
     *            contributions to this context menu.
     * @see IWorkbenchPartSite#registerContextMenu(MenuManager,
     *      ISelectionProvider)
     * @since 3.1
     */
//    virtual void registerContextMenu(String menuId, MenuManager menuManager,
//            ISelectionProvider selectionProvider, boolean includeEditorInput);
};

}

#endif /*BERRYIEDITORSITE_H_*/
