simgear/canvas/layout/LayoutItem.hxx

   1 ///@file Basic element for layouting canvas elements
   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_LAYOUT_ITEM_HXX_
  20 #define SG_CANVAS_LAYOUT_ITEM_HXX_
  21
  22 #include <simgear/canvas/canvas_fwd.hxx>
  23 #include <simgear/math/SGMath.hxx>
  24 #include <simgear/math/SGRect.hxx>
  25 #include <simgear/misc/stdint.hxx>
  26 #include <simgear/structure/SGWeakReferenced.hxx>
  27 #include <simgear/structure/SGSharedPtr.hxx>
  28
  29 namespace simgear
  30 {
  31 namespace canvas
  32 {
  33   class LayoutItem;
  34   typedef SGSharedPtr<LayoutItem> LayoutItemRef;
  35   typedef SGWeakPtr<LayoutItem> LayoutItemWeakRef;
  36
  37   /**
  38    * Base class for all layouting elements. Specializations either implement a
  39    * layouting algorithm or a widget.
  40    */
  41   class LayoutItem:
  42     public virtual SGVirtualWeakReferenced
  43   {
  44     public:
  45
  46       LayoutItem();
  47       virtual ~LayoutItem();
  48
  49       /**
  50        * Get the preferred size of this item.
  51        */
  52       SGVec2i sizeHint() const;
  53
  54       /**
  55        * Get the minimum amount of the space this item requires.
  56        */
  57       SGVec2i minimumSize() const;
  58
  59       /**
  60        * Get the maximum amount of space this item can use.
  61        */
  62       SGVec2i maximumSize() const;
  63
  64       /**
  65        * Mark all cached data as invalid and require it to be recalculated.
  66        */
  67       virtual void invalidate();
  68
  69       /**
  70        * Mark all cached data of parent item as invalid (if it is known)
  71        */
  72       void invalidateParent();
  73
  74       /**
  75        * Set position and size of this element. For layouts this triggers a
  76        * recalculation of the layout.
  77        */
  78       virtual void setGeometry(const SGRecti& geom);
  79
  80       /**
  81        * Get position and size of this element.
  82        */
  83       virtual SGRecti geometry() const;
  84
  85       /**
  86        * Set the canvas this item is attached to.
  87        */
  88       virtual void setCanvas(const CanvasWeakPtr& canvas);
  89
  90       /**
  91        * Get the canvas this item is attached to.
  92        */
  93       CanvasPtr getCanvas() const;
  94
  95       /**
  96        * Set the parent layout item (usually this is a layout).
  97        */
  98       void setParent(const LayoutItemWeakRef& parent);
  99
 100       /**
 101        * Get the parent layout.
 102        */
 103       LayoutItemRef getParent() const;
 104
 105     protected:
 106
 107       friend class Canvas;
 108
 109       enum Flags
 110       {
 111         SIZE_HINT_DIRTY = 1,
 112         MINIMUM_SIZE_DIRTY = SIZE_HINT_DIRTY << 1,
 113         MAXIMUM_SIZE_DIRTY = MINIMUM_SIZE_DIRTY << 1,
 114         SIZE_INFO_DIRTY = SIZE_HINT_DIRTY
 115                         | MINIMUM_SIZE_DIRTY
 116                         | MAXIMUM_SIZE_DIRTY,
 117         LAST_FLAG = MAXIMUM_SIZE_DIRTY
 118       };
 119
 120       CanvasWeakPtr     _canvas;
 121       LayoutItemWeakRef _parent;
 122
 123       SGRecti           _geometry;
 124
 125       mutable uint32_t  _flags;
 126       mutable SGVec2i   _size_hint,
 127                         _min_size,
 128                         _max_size;
 129
 130       virtual SGVec2i sizeHintImpl() const;
 131       virtual SGVec2i minimumSizeImpl() const;
 132       virtual SGVec2i maximumSizeImpl() const;
 133
 134   };
 135
 136 } // namespace canvas
 137 } // namespace simgear
 138
 139 #endif /* SG_CANVAS_LAYOUT_ITEM_HXX_ */