berryIWorkbenchConfigurer.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 BERRYIWORKBENCHCONFIGURER_H_
#define BERRYIWORKBENCHCONFIGURER_H_

#include <berryMacros.h>

#include <org_blueberry_ui_qt_Export.h>
#include "berryIWorkbench.h"

#include "berryIWorkbenchWindowConfigurer.h"

namespace berry {

struct BERRY_UI_QT IWorkbenchConfigurer : public Object
{

  berryObjectMacro(berry::IWorkbenchConfigurer)

  ~IWorkbenchConfigurer();

    static const int RESTORE_CODE_RESET = 1;

    static const int RESTORE_CODE_EXIT = 2;

    virtual IWorkbench* GetWorkbench() = 0;

    virtual bool GetSaveAndRestore() = 0;

    virtual void SetSaveAndRestore(bool enabled) = 0;

  virtual IWorkbenchWindowConfigurer::Pointer RestoreWorkbenchWindow(IMemento::Pointer memento) = 0;

    /*
     * Declares a workbench image.
     * <p>
     * The workbench remembers the given image descriptor under the given name,
     * and makes the image available to plug-ins via
     * {@link IWorkbench#GetSharedImages() IWorkbench.getSharedImages()}.
     * For "shared" images, the workbench remembers the image descriptor and
     * will manages the image object create from it; clients retrieve "shared"
     * images via
     * {@link org.blueberry.ui.ISharedImages#getImage ISharedImages.getImage()}.
     * For the other, "non-shared" images, the workbench remembers only the
     * image descriptor; clients retrieve the image descriptor via
     * {@link org.blueberry.ui.ISharedImages#getImageDescriptor
     * ISharedImages.getImageDescriptor()} and are entirely
     * responsible for managing the image objects they create from it.
     * (This is made confusing by the historical fact that the API interface
     *  is called "ISharedImages".)
     * </p>
     *
     * @param symbolicName the symbolic name of the image
     * @param descriptor the image descriptor
     * @param shared <code>true</code> if this is a shared image, and
     * <code>false</code> if this is not a shared image
     * @see org.blueberry.ui.ISharedImages#getImage
     * @see org.blueberry.ui.ISharedImages#getImageDescriptor
     */
//    virtual void declareImage(String symbolicName, ImageDescriptor descriptor,
//            boolean shared);

    virtual void EmergencyClose() = 0;

    virtual bool EmergencyClosing() = 0;

    virtual IWorkbenchWindowConfigurer::Pointer GetWindowConfigurer(
            IWorkbenchWindow::Pointer window) = 0;

    virtual Object::Pointer GetData(const QString& key) const = 0;

    virtual void SetData(const QString& key, Object::Pointer data) = 0;

    virtual bool RestoreState() = 0;

    virtual void OpenFirstTimeWindow() = 0;

    virtual bool GetExitOnLastWindowClose() = 0;

    virtual void SetExitOnLastWindowClose(bool enabled) = 0;
};

}

#endif /*BERRYIWORKBENCHCONFIGURER_H_*/