layout.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <promeki/namespace.h>
#include <promeki/objectbase.h>
#include <promeki/rect.h>
#include <promeki/size2d.h>
#include <promeki/list.h>
#include <promeki/map.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class Widget;
 
class Layout : public ObjectBase {
                PROMEKI_OBJECT(Layout, ObjectBase)
        public:
                Layout(ObjectBase *parent = nullptr);
                virtual ~Layout();
 
                virtual void addWidget(Widget *widget);
 
                void removeWidget(Widget *widget);
 
                virtual void addLayout(Layout *layout);
 
                void setMargins(int top, int right, int bottom, int left);
 
                void setMargins(int margin) { setMargins(margin, margin, margin, margin); }
 
                void setSpacing(int spacing) { _spacing = spacing; }
 
                int spacing() const { return _spacing; }
 
                void margins(int &top, int &right, int &bottom, int &left) const {
                        top = _marginTop;
                        right = _marginRight;
                        bottom = _marginBottom;
                        left = _marginLeft;
                }
 
                virtual void calculateLayout(const Rect2Di32 &available) = 0;
 
                virtual Size2Di32 sizeHint() const;
 
                const List<Widget *> &widgets() const { return _widgets; }
 
                const List<Layout *> &layouts() const { return _layouts; }
 
        protected:
                Rect2Di32 contentRect(const Rect2Di32 &available) const;
 
                List<Widget *> _widgets;
                List<Layout *> _layouts;
 
        private:
                int _spacing = 0;
                int _marginTop = 0;
                int _marginRight = 0;
                int _marginBottom = 0;
                int _marginLeft = 0;
};
 
enum BoxDirection {
        LeftToRight,
        RightToLeft,
        TopToBottom,
        BottomToTop
};
 
class BoxLayout : public Layout {
                PROMEKI_OBJECT(BoxLayout, Layout)
        public:
                BoxLayout(BoxDirection direction, ObjectBase *parent = nullptr);
 
                BoxDirection direction() const { return _direction; }
 
                void addWidget(Widget *widget) override;
 
                void addLayout(Layout *layout) override;
 
                void addStretch(int factor = 1);
 
                void setStretch(int index, int factor);
 
                void calculateLayout(const Rect2Di32 &available) override;
 
                Size2Di32 sizeHint() const override;
 
        private:
                struct Item {
                                enum Type {
                                        WidgetItem,
                                        LayoutItem,
                                        StretchItem
                                };
                                Type    type;
                                Widget *widget = nullptr;
                                Layout *layout = nullptr;
                                int     stretchFactor = 0;
                };
 
                BoxDirection _direction;
                List<Item>   _items;
};
 
class HBoxLayout : public BoxLayout {
                PROMEKI_OBJECT(HBoxLayout, BoxLayout)
        public:
                HBoxLayout(ObjectBase *parent = nullptr) : BoxLayout(LeftToRight, parent) {}
};
 
class VBoxLayout : public BoxLayout {
                PROMEKI_OBJECT(VBoxLayout, BoxLayout)
        public:
                VBoxLayout(ObjectBase *parent = nullptr) : BoxLayout(TopToBottom, parent) {}
};
 
class GridLayout : public Layout {
                PROMEKI_OBJECT(GridLayout, Layout)
        public:
                GridLayout(ObjectBase *parent = nullptr);
 
                // Bring the base-class single-arg addWidget(Widget*) back into
                // scope so the row/col overload below doesn't hide it.
                using Layout::addWidget;
 
                void addWidget(Widget *widget, int row, int col, int rowSpan = 1, int colSpan = 1);
 
                void setRowStretch(int row, int factor);
 
                void setColumnStretch(int col, int factor);
 
                void setRowMinimumHeight(int row, int height);
 
                void setColumnMinimumWidth(int col, int width);
 
                void calculateLayout(const Rect2Di32 &available) override;
 
        private:
                struct GridItem {
                                Widget *widget;
                                int     row;
                                int     col;
                                int     rowSpan;
                                int     colSpan;
                };
                List<GridItem> _items;
                Map<int, int>  _rowStretch;
                Map<int, int>  _colStretch;
                Map<int, int>  _rowMinHeight;
                Map<int, int>  _colMinWidth;
                int            _rowCount = 0;
                int            _colCount = 0;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE