FlowLayout.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
9 
10 #include <UI/UIFramework.h>
11 #include <UI/Layout/LayoutManager.h>
12 
13 BEGIN_BENTLEY_UIFRAMEWORK_NAMESPACE
14 
15 class LayoutControl;
16 class LayoutItem;
17 
18 //=======================================================================================
22 //
25 //=======================================================================================
26 class FlowLayout : public LayoutManager
27  {
28 public:
35  DLLEXPORT static FlowLayout* Create (LayoutControl *parent, int hSpacing = -1, int vSpacing = -1, LayoutDirection layoutDirection = LD_LeftToRight);
36 
42  DLLEXPORT static FlowLayout* Create (int hSpacing = -1, int vSpacing = -1, LayoutDirection layoutDirection = LD_LeftToRight);
43 
47  DLLEXPORT void AddControl (LayoutControl *ctl, LayoutAlignment alignment = Align_None);
48 
52  DLLEXPORT void AddLayout (LayoutManager *layout, LayoutAlignment alignment = Align_None);
53 
56  DLLEXPORT void AddSpacing (int spacing);
57 
60  DLLEXPORT void SetHorizontalSpacing (int spacing);
61 
63  DLLEXPORT int GetHorizontalSpacing() const;
64 
67  DLLEXPORT void SetVerticalSpacing (int spacing);
68 
70  DLLEXPORT int GetVerticalSpacing() const;
71 
73  DLLEXPORT int GetLineHeight() const;
74 
77  DLLEXPORT virtual bool HasHeightForWidth() const override;
78 
81  DLLEXPORT virtual int GetHeightForWidth (int width) const override;
82 
84  DLLEXPORT virtual BSize GetMinimumSize() const override;
85 
87  DLLEXPORT virtual BSize GetDesiredSize() const override;
88 
91  DLLEXPORT virtual void SetGeometry (const BRect &rect) override;
92 
94  DLLEXPORT virtual size_t Count() const override;
95 
99  DLLEXPORT virtual LayoutItem *ItemAt (int index) const override;
100 
104  DLLEXPORT virtual LayoutItem *TakeAt (int index) override;
105 
108  DLLEXPORT virtual LayoutOrientations GetExpandingOrientations() const override;
109 
110  };
111 
112 
113 END_BENTLEY_UIFRAMEWORK_NAMESPACE
LayoutControl
The LayoutControl class is the abstract base class of all user interface elements for layout manager ...
Definition: LayoutControl.h:54
FlowLayout::GetVerticalSpacing
int GetVerticalSpacing() const
Returns the vertical spacing between rows in the layout.
Align_None
Definition: LayoutEnums.h:53
FlowLayout::AddSpacing
void AddSpacing(int spacing)
Adds a non-stretchable space item to the layout with a given width.
FlowLayout::SetGeometry
virtual void SetGeometry(const BRect &rect) override
Sets the geometry for this layout to the given rectangle.
FlowLayout::GetHorizontalSpacing
int GetHorizontalSpacing() const
Returns the horizontal spacing between items in the layout.
FlowLayout::ItemAt
virtual LayoutItem * ItemAt(int index) const override
Retrieves the item at index in the layout and returns the item.
FlowLayout::SetHorizontalSpacing
void SetHorizontalSpacing(int spacing)
Sets the horizontal spacing between items in the layout.
FlowLayout::GetMinimumSize
virtual BSize GetMinimumSize() const override
Returns the minimum size for this layout.
LayoutFlags
LayoutFlags - Creates a "Flags" class out of an enum with constructors and operator overloading...
Definition: LayoutFlags.h:43
LayoutItem
The LayoutItem class provides an abstract item that a LayoutManager manipulates.
Definition: LayoutItem.h:52
BRect
The BRect class defines a rectangle using integer precision.
Definition: BRect.h:71
FlowLayout::GetHeightForWidth
virtual int GetHeightForWidth(int width) const override
Returns the preferred height for this layout item, given the width.
FlowLayout::GetLineHeight
int GetLineHeight() const
Returns the current line height.
BSize
The BSize class defines the size of a two - dimensional object using integer point precision...
Definition: BSize.h:38
BEGIN_BENTLEY_UIFRAMEWORK_NAMESPACE
#define BEGIN_BENTLEY_UIFRAMEWORK_NAMESPACE
Definition: UIFramework.h:14
LayoutDirection
LayoutDirection
This type is used to determine the direction of a layout.
Definition: LayoutEnums.h:81
LD_LeftToRight
Definition: LayoutEnums.h:83
DLLEXPORT
#define DLLEXPORT
Definition: basedefs.h:137
FlowLayout::AddLayout
void AddLayout(LayoutManager *layout, LayoutAlignment alignment=Align_None)
Adds a nested child layout to the layout.
FlowLayout::GetExpandingOrientations
virtual LayoutOrientations GetExpandingOrientations() const override
Returns whether this layout item can make use of more space than GetDesiredSize().
FlowLayout::GetDesiredSize
virtual BSize GetDesiredSize() const override
Returns the desired size for this layout.
FlowLayout::SetVerticalSpacing
void SetVerticalSpacing(int spacing)
Sets the vertical spacing between rows in the layout.
END_BENTLEY_UIFRAMEWORK_NAMESPACE
#define END_BENTLEY_UIFRAMEWORK_NAMESPACE
Definition: UIFramework.h:15
FlowLayout::Count
virtual size_t Count() const override
Returns the number of items in this layout.
FlowLayout::AddControl
void AddControl(LayoutControl *ctl, LayoutAlignment alignment=Align_None)
Adds a control to the FlowLayout Layout Manager.
LayoutManager
The LayoutManager class is the base class of the layout managers.
Definition: LayoutManager.h:46
FlowLayout::TakeAt
virtual LayoutItem * TakeAt(int index) override
Removes the item at index from the layout, and returns the item.
FlowLayout::Create
static FlowLayout * Create(LayoutControl *parent, int hSpacing=-1, int vSpacing=-1, LayoutDirection layoutDirection=LD_LeftToRight)
Creates a FlowLayout Layout Manager.
FlowLayout::HasHeightForWidth
virtual bool HasHeightForWidth() const override
Returns whether this layout's preferred height depends on its width.
FlowLayout
The Flow Layout Manager arranges items from left to right and top to bottom.
Definition: FlowLayout.h:26
Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.