GridLayout.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>
#include <Bentley\WString.h>

BEGIN_BENTLEY_UIFRAMEWORK_NAMESPACE

//=======================================================================================
//=======================================================================================
class GridLayout : public LayoutManager
    {
public:
    DLLEXPORT static GridLayout* Create (LayoutControl *parent = NULL);

    DLLEXPORT void    SetHorizontalSpacing (int spacing);

    DLLEXPORT int     GetHorizontalSpacing () const;

    DLLEXPORT void    SetVerticalSpacing (int spacing);

    DLLEXPORT int     GetVerticalSpacing () const;

    DLLEXPORT void    SetSpacing (int spacing);

    DLLEXPORT int     GetSpacing() const;

    DLLEXPORT int     GetRowStretch (int row) const;

    DLLEXPORT void    SetRowStretch (int row, int stretch);

    DLLEXPORT int     GetColumnStretch (int column) const;

    DLLEXPORT void    SetColumnStretch (int column, int stretch);

    DLLEXPORT int     GetRowMinimumHeight (int row) const;

    DLLEXPORT void    SetRowMinimumHeight (int row, int minHeight);

    DLLEXPORT int     GetColumnMinimumWidth (int column) const;

    DLLEXPORT void    SetColumnMinimumWidth (int column, int minWidth);

    DLLEXPORT StatusInt SetColumnSharedSizeGroup (int column, WCharCP groupName);

    DLLEXPORT int     GetColumnCount () const;

    DLLEXPORT int     GetRowCount () const;

    DLLEXPORT BRect   GetCellRect (int row, int column) const;

    DLLEXPORT void    AddControl (LayoutControl *ctl, int row, int column, LayoutAlignment alignment = Align_None);

    DLLEXPORT void    AddControl (LayoutControl *ctl, int row, int column, int rowSpan, int columnSpan, LayoutAlignment alignment = Align_None);

    DLLEXPORT void    AddLayout (LayoutManager *layout, int row, int column, LayoutAlignment alignment = Align_None);

    DLLEXPORT void    AddLayout (LayoutManager *layout, int row, int column, int rowSpan, int columnSpan, LayoutAlignment alignment = Align_None);

    DLLEXPORT void    SetDefaultPositioning (int n, LayoutOrientation orient);

    DLLEXPORT void    GetItemPosition (int index, int *row, int *column, int *rowSpan, int *columnSpan);

    DLLEXPORT LayoutItem *ItemAtPosition (int row, int column) const;

    DLLEXPORT virtual void Invalidate () override;

    DLLEXPORT virtual void SetDirty () override;
    
    DLLEXPORT virtual BSize   GetDesiredSize() const override;
    
    DLLEXPORT virtual BSize   GetMinimumSize() const override;
    
    DLLEXPORT virtual BSize   GetMaximumSize() const override;

    DLLEXPORT virtual bool    HasHeightForWidth () const override;

    DLLEXPORT virtual int     GetHeightForWidth (int width) const override;

    DLLEXPORT virtual int     GetMinimumHeightForWidth (int width) const override;

    DLLEXPORT virtual void    SetGeometry (const BRect& rect) override;
    
    DLLEXPORT virtual LayoutOrientations GetExpandingOrientations() const;
    
    DLLEXPORT virtual size_t  Count() const override;
    
    DLLEXPORT virtual LayoutItem *ItemAt (int index) const override;
    
    DLLEXPORT virtual LayoutItem *TakeAt (int index) override;

    };

END_BENTLEY_UIFRAMEWORK_NAMESPACE