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
  62       /**
  63        * Set the stretch factor of the item at position @a index to @a stretch.
  64        */
  65       void setStretch(size_t index, int stretch);
  66
  67       /**
  68        * Get the stretch factor of the item at position @a index
  69        */
  70       int stretch(size_t index) const;
  71
  72       virtual void setSpacing(int spacing);
  73       virtual int spacing() const;
  74
  75       void setDirection(Direction dir);
  76       Direction direction() const;
  77
  78       virtual bool hasHeightForWidth() const;
  79       virtual int heightForWidth(int w) const;
  80       virtual int minimumHeightForWidth(int w) const;
  81
  82       virtual void setCanvas(const CanvasWeakPtr& canvas);
  83
  84       bool horiz() const;
  85
  86     protected:
  87
  88       typedef const int& (SGVec2i::*CoordGetter)() const;
  89       CoordGetter _get_layout_coord,    //<! getter for coordinate in layout
  90                                         //   direction
  91                   _get_fixed_coord;     //<! getter for coordinate in secondary
  92                                         //   (fixed) direction
  93
  94       int _padding;
  95       Direction _direction;
  96
  97       typedef std::vector<ItemData> LayoutItems;
  98
  99       mutable LayoutItems _layout_items;
 100       mutable ItemData _layout_data;
 101
 102       // Cache for last height-for-width query
 103       mutable int _hfw_width,
 104                   _hfw_height,
 105                   _hfw_min_height;
 106
 107       void updateSizeHints() const;
 108       void updateWFHCache(int w) const;
 109
 110       virtual SGVec2i sizeHintImpl() const;
 111       virtual SGVec2i minimumSizeImpl() const;
 112       virtual SGVec2i maximumSizeImpl() const;
 113
 114       virtual void doLayout(const SGRecti& geom);
 115   };
 116
 117   /**
 118    * Shortcut for creating a horizontal box layout
 119    */
 120   class HBoxLayout:
 121     public BoxLayout
 122   {
 123     public:
 124       HBoxLayout();
 125   };
 126
 127   /**
 128    * Shortcut for creating a vertical box layout
 129    */
 130   class VBoxLayout:
 131     public BoxLayout
 132   {
 133     public:
 134       VBoxLayout();
 135   };
 136
 137   typedef SGSharedPtr<BoxLayout> BoxLayoutRef;
 138
 139 } // namespace canvas
 140 } // namespace simgear
 141
 142
 143 #endif /* SG_CANVAS_BOX_LAYOUT_HXX_ */
 144