berryIPageLayout.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 BERRYIPAGELAYOUT_H_
#define BERRYIPAGELAYOUT_H_

#include "berryIFolderLayout.h"
#include "berryIPlaceholderFolderLayout.h"
#include "berryIViewLayout.h"
#include "berryIPerspectiveDescriptor.h"

#include <string>

namespace berry {

struct BERRY_UI_QT IPageLayout : public Object
{

  berryObjectMacro(berry::IPageLayout)

    
    static const QString ID_EDITOR_AREA; // = "org.blueberry.ui.editors";

    static const QString ID_RES_NAV; // = "org.blueberry.ui.views.ResourceNavigator";

    static const QString ID_PROP_SHEET; // = "org.blueberry.ui.views.PropertySheet";

    static const QString ID_OUTLINE; // = "org.blueberry.ui.views.ContentOutline";

    static const QString ID_BOOKMARKS; // = "org.blueberry.ui.views.BookmarkView";

    static const QString ID_PROBLEM_VIEW; // = "org.blueberry.ui.views.ProblemView";

    static const QString ID_PROGRESS_VIEW; // = "org.blueberry.ui.views.ProgressView";

    static const QString ID_TASK_LIST; // = "org.blueberry.ui.views.TaskList";

    static const QString ID_NAVIGATE_ACTION_SET; // = "org.blueberry.ui.NavigateActionSet";

    static const int LEFT; // = 1;

    static const int RIGHT; // = 2;

    static const int TOP; // = 3;

    static const int BOTTOM; // = 4;

    static const float RATIO_MIN; // = 0.05f;

    static const float RATIO_MAX; // = 0.95f;

    static const float DEFAULT_VIEW_RATIO; // = 0.5f;

    static const float INVALID_RATIO; // = -1f;

    static const float NULL_RATIO; // = -2f;

    //virtual void AddActionSet(const QString& actionSetId) = 0;


    virtual void AddPerspectiveShortcut(const QString& id) = 0;

    virtual void AddPlaceholder(const QString& viewId, int relationship, float ratio,
            const QString& refId) = 0;

    virtual void AddShowInPart(const QString& id) = 0;

    virtual void AddShowViewShortcut(const QString& id) = 0;

    virtual void AddView(const QString& viewId, int relationship, float ratio,
            const QString& refId) = 0;

    virtual IFolderLayout::Pointer CreateFolder(const QString& folderId, int relationship,
            float ratio, const QString& refId) = 0;

    virtual IPlaceholderFolderLayout::Pointer CreatePlaceholderFolder(const QString& folderId,
            int relationship, float ratio, const QString& refId) = 0;

    virtual QString GetEditorArea() = 0;

    virtual bool IsEditorAreaVisible() = 0;

    virtual void SetEditorAreaVisible(bool showEditorArea) = 0;

    virtual void SetFixed(bool isFixed) = 0;

    virtual bool IsFixed() = 0;

    virtual IViewLayout::Pointer GetViewLayout(const QString& id) = 0;

    virtual void AddStandaloneView(const QString& viewId, bool showTitle,
            int relationship, float ratio, const QString& refId) = 0;

    virtual void AddStandaloneViewPlaceholder(const QString& viewId, int relationship,
      float ratio, const QString& refId, bool showTitle) = 0;


    virtual IPerspectiveDescriptor::Pointer GetDescriptor() = 0;

    virtual IPlaceholderFolderLayout::Pointer GetFolderForView(const QString& id) = 0;
};

}

#endif /*BERRYIPAGELAYOUT_H_*/