DockLayout.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <UI/UIFramework.h>
#include <UI/Layout/LayoutManager.h>

BEGIN_BENTLEY_UIFRAMEWORK_NAMESPACE

class LayoutControl;
class LayoutItem;

//=======================================================================================
//=======================================================================================
enum LayoutDockPosition 
    { 
    DP_Top, 
    DP_Bottom, 
    DP_Left, 
    DP_Right, 
    DP_Fill,
    DP_None 
    };

//=======================================================================================
//=======================================================================================
class DockLayout : public LayoutManager
    {
public:
    DLLEXPORT static DockLayout* Create (LayoutControl *parent, int spacing = -1);

    DLLEXPORT static DockLayout* Create (int spacing = -1);

    DLLEXPORT void      AddControl (LayoutControl *ctl, LayoutDockPosition position);

    DLLEXPORT void      AddLayout (LayoutManager *layout, LayoutDockPosition position);

    DLLEXPORT virtual bool      HasHeightForWidth() const override;

    DLLEXPORT virtual int       GetHeightForWidth (int width) const override;

    DLLEXPORT virtual BSize     GetMinimumSize() const override;

    DLLEXPORT virtual BSize     GetDesiredSize() const override;

    DLLEXPORT virtual void      SetGeometry (const BRect &rect) override;

    DLLEXPORT virtual size_t    Count() const override;

    DLLEXPORT virtual LayoutItem *ItemAt (int index) const override;

    DLLEXPORT virtual LayoutItem *TakeAt (int index) override;

    DLLEXPORT virtual LayoutOrientations GetExpandingOrientations() const override;

    };

END_BENTLEY_UIFRAMEWORK_NAMESPACE