simgear/canvas/layout/BoxLayout.hxx

   1 // Align items horizontally or vertically in a box
   2 //
   3 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef SG_CANVAS_BOX_LAYOUT_HXX_
  20 #define SG_CANVAS_BOX_LAYOUT_HXX_
  21
  22 #include "Layout.hxx"
  23
  24 namespace simgear
  25 {
  26 namespace canvas
  27 {
  28
  29   class BoxLayout:
  30     public Layout
  31   {
  32     public:
  33
  34       enum Direction
  35       {
  36         LeftToRight,
  37         RightToLeft,
  38         TopToBottom,
  39         BottomToTop
  40       };
  41
  42       BoxLayout(Direction dir);
  43
  44       virtual void addItem(const LayoutItemRef& item);
  45
  46       void addItem(const LayoutItemRef& item, int stretch);
  47
  48       void addStretch(int stretch = 0);
  49
  50       void addSpacing(int size);
  51
  52       void insertItem(int index, const LayoutItemRef& item, int stretch = 0);
  53
  54       void insertStretch(int index, int stretch = 0);
  55
  56       void insertSpacing(int index, int size);
  57
  58       virtual size_t count() const;
  59       virtual LayoutItemRef itemAt(size_t index);
  60       virtual LayoutItemRef takeAt(size_t index);
  61       virtual void clear();
  62
  63       /**
  64        * Set the stretch factor of the item at position @a index to @a stretch.
  65        */
  66       void setStretch(size_t index, int stretch);
  67
  68       /**
  69        * Get the stretch factor of the item at position @a index
  70        */
  71       int stretch(size_t index) const;
  72
  73       virtual void setSpacing(int spacing);
  74       virtual int spacing() const;
  75
  76       void setDirection(Direction dir);
  77       Direction direction() const;
  78
  79       virtual bool hasHeightForWidth() const;
  80       virtual int heightForWidth(int w) const;
  81       virtual int minimumHeightForWidth(int w) const;
  82
  83       virtual void setCanvas(const CanvasWeakPtr& canvas);
  84
  85       bool horiz() const;
  86
  87     protected:
  88
  89       typedef const int& (SGVec2i::*CoordGetter)() const;
  90       CoordGetter _get_layout_coord,    //<! getter for coordinate in layout
  91                                         //   direction
  92                   _get_fixed_coord;     //<! getter for coordinate in secondary
  93                                         //   (fixed) direction
  94
  95       int _padding;
  96       Direction _direction;
  97
  98       typedef std::vector<ItemData> LayoutItems;
  99
 100       mutable LayoutItems _layout_items;
 101       mutable ItemData _layout_data;
 102
 103       // Cache for last height-for-width query
 104       mutable int _hfw_width,
 105                   _hfw_height,
 106                   _hfw_min_height;
 107
 108       void updateSizeHints() const;
 109       void updateWFHCache(int w) const;
 110
 111       virtual SGVec2i sizeHintImpl() const;
 112       virtual SGVec2i minimumSizeImpl() const;
 113       virtual SGVec2i maximumSizeImpl() const;
 114
 115       virtual void doLayout(const SGRecti& geom);
 116   };
 117
 118   /**
 119    * Shortcut for creating a horizontal box layout
 120    */
 121   class HBoxLayout:
 122     public BoxLayout
 123   {
 124     public:
 125       HBoxLayout();
 126   };
 127
 128   /**
 129    * Shortcut for creating a vertical box layout
 130    */
 131   class VBoxLayout:
 132     public BoxLayout
 133   {
 134     public:
 135       VBoxLayout();
 136   };
 137
 138   typedef SGSharedPtr<BoxLayout> BoxLayoutRef;
 139
 140 } // namespace canvas
 141 } // namespace simgear
 142
 143
 144 #endif /* SG_CANVAS_BOX_LAYOUT_HXX_ */
 145