simgear/canvas/layout/NasalWidget.hxx

   1 ///@file Glue for GUI widgets implemented in Nasal space
   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_NASAL_WIDGET_HXX_
  20 #define SG_CANVAS_NASAL_WIDGET_HXX_
  21
  22 #include "LayoutItem.hxx"
  23
  24 #include <simgear/nasal/cppbind/from_nasal.hxx>
  25 #include <simgear/nasal/cppbind/NasalHash.hxx>
  26 #include <simgear/nasal/cppbind/NasalObject.hxx>
  27
  28 namespace simgear
  29 {
  30 namespace canvas
  31 {
  32
  33   /**
  34    * Baseclass/ghost to create widgets with Nasal.
  35    */
  36   class NasalWidget:
  37     public LayoutItem,
  38     public nasal::Object
  39   {
  40     public:
  41
  42       typedef boost::function<void (nasal::Me, const SGRecti&)> SetGeometryFunc;
  43       typedef boost::function<int (nasal::Me, int)> HeightForWidthFunc;
  44
  45       /**
  46        *
  47        * @param impl    Initial implementation hash (nasal part of
  48        *                implementation)
  49        */
  50       NasalWidget(naRef impl);
  51
  52       ~NasalWidget();
  53
  54       virtual void invalidate();
  55       virtual void setGeometry(const SGRecti& geom);
  56       virtual void onRemove();
  57
  58       void setSetGeometryFunc(const SetGeometryFunc& func);
  59       void setHeightForWidthFunc(const HeightForWidthFunc& func);
  60       void setMinimumHeightForWidthFunc(const HeightForWidthFunc& func);
  61
  62       /** Set size hint.
  63        *
  64        * Overrides default size hint. Set to (0, 0) to fall back to default size
  65        * hint.
  66        */
  67       void setSizeHint(const SGVec2i& s);
  68
  69       /** Set minimum size.
  70        *
  71        * Overrides default minimum size. Set to (0, 0) to fall back to default
  72        * minimum size.
  73        */
  74       void setMinimumSize(const SGVec2i& s);
  75
  76       /** Set maximum size.
  77        *
  78        * Overrides default maximum size hint. Set to LayoutItem::MAX_SIZE to
  79        * fall back to default maximum size.
  80        */
  81       void setMaximumSize(const SGVec2i& s);
  82
  83       void setLayoutSizeHint(const SGVec2i& s);
  84       void setLayoutMinimumSize(const SGVec2i& s);
  85       void setLayoutMaximumSize(const SGVec2i& s);
  86
  87       virtual bool hasHeightForWidth() const;
  88       virtual int heightForWidth(int w) const;
  89       virtual int minimumHeightForWidth(int w) const;
  90
  91       /**
  92        * @param ns  Namespace to register the class interface
  93        */
  94       static void setupGhost(nasal::Hash& ns);
  95
  96     protected:
  97       enum WidgetFlags
  98       {
  99         LAYOUT_DIRTY = LayoutItem::LAST_FLAG << 1,
 100         LAST_FLAG = LAYOUT_DIRTY
 101       };
 102
 103       SetGeometryFunc       _set_geometry;
 104       HeightForWidthFunc    _height_for_width,
 105                             _min_height_for_width;
 106
 107       SGVec2i _layout_size_hint,
 108               _layout_min_size,
 109               _layout_max_size,
 110               _user_size_hint,
 111               _user_min_size,
 112               _user_max_size;
 113
 114       int callHeightForWidthFunc( const HeightForWidthFunc& hfw,
 115                                   int w ) const;
 116
 117       virtual SGVec2i sizeHintImpl() const;
 118       virtual SGVec2i minimumSizeImpl() const;
 119       virtual SGVec2i maximumSizeImpl() const;
 120
 121   };
 122
 123   typedef SGSharedPtr<NasalWidget> NasalWidgetRef;
 124
 125 } // namespace canvas
 126 } // namespace simgear
 127
 128
 129 #endif /* SG_CANVAS_NASAL_WIDGET_HXX_ */