source/widget.h

   1 #ifndef MSP_GLTK_WIDGET_H_
   2 #define MSP_GLTK_WIDGET_H_
   3
   4 #include <string>
   5 #include <msp/datafile/objectloader.h>
   6 #include <msp/gl/renderer.h>
   7 #include "geometry.h"
   8 #include "inputmethod.h"
   9 #include "partcache.h"
  10 #include "state.h"
  11
  12 namespace Msp {
  13 namespace GLtk {
  14
  15 class Container;
  16 class Part;
  17 class Resources;
  18 class Style;
  19
  20 /**
  21 Base class for all widgets.
  22 */
  23 class Widget
  24 {
  25         friend class Container;
  26
  27 public:
  28         class Loader: public DataFile::ObjectLoader<Widget>
  29         {
  30         public:
  31                 Loader(Widget &);
  32         private:
  33                 void position(int, int);
  34                 void size(unsigned, unsigned);
  35                 void style(const std::string &);
  36         };
  37
  38         sigc::signal<void, bool> signal_visibility_changed;
  39         sigc::signal<void> signal_autosize_changed;
  40         sigc::signal<void> signal_request_focus;
  41         sigc::signal<void> signal_grab_pointer;
  42         sigc::signal<void> signal_ungrab_pointer;
  43
  44 protected:
  45         Geometry geom;
  46         std::string style_name;
  47         const Style *style;
  48         State state;
  49         bool visible;
  50         InputType input_type;
  51         Container *parent;
  52         std::string tooltip;
  53         PartCache part_cache;
  54
  55         Widget();
  56 private:
  57         Widget(const Widget &);
  58         Widget &operator=(const Widget &);
  59 public:
  60         virtual ~Widget();
  61
  62         /// Returns the name of the widget class.  Used for style lookup.
  63         virtual const char *get_class() const { return "widget"; }
  64
  65         void set_position(int, int);
  66         void set_size(unsigned, unsigned);
  67         void autosize();
  68         void autosize(Geometry &) const;
  69 protected:
  70         virtual void autosize_special(const Part &, Geometry &) const { };
  71 public:
  72         void set_geometry(const Geometry &);
  73         const Geometry &get_geometry() const { return geom; }
  74
  75         void map_coords_to_ancestor(int &, int &, const Widget &) const;
  76
  77 protected:
  78         /** Sets the widget's parent Container.  The widget must be unparented when
  79         calling this function with a non-null parameter. */
  80         void set_parent(Container *);
  81 public:
  82         Container *get_parent() const { return parent; }
  83
  84         /** Finds the closest ancestor of a specific type. */
  85         template<typename T>
  86         T *find_ancestor() const
  87         {
  88                 for(Widget *w=parent; w; w=w->get_parent())
  89                         if(T *tw = dynamic_cast<T *>(w))
  90                                 return tw;
  91                 return 0;
  92         }
  93
  94         /** Sets the widget style.  The name of the resource to be looked up is
  95         constructed by concatenating the widget class and the style name with a
  96         dash. */
  97         void set_style(const std::string &);
  98         const Style &get_style() const { return *style; }
  99
 100 protected:
 101         /** Gets a style object from the resource collection based on the class and
 102         style names of the widget. */
 103         void update_style();
 104
 105 public:
 106         void set_tooltip(const std::string &);
 107         const std::string &get_tooltip() const { return tooltip; }
 108
 109         void set_visible(bool);
 110         bool is_visible() const { return visible; }
 111         InputType get_input_type() const { return input_type; }
 112         bool is_focusable() const { return visible && input_type!=INPUT_NONE; }
 113         void set_focus();
 114         void set_enabled(bool);
 115         bool is_enabled() const { return !(state&DISABLED); }
 116
 117         // Deprecated
 118         void set_focusable(bool);
 119
 120 protected:
 121         void set_state(State s) { set_state(s, s); }
 122         void clear_state(State s) { set_state(s, NORMAL); }
 123         void set_state(State, State);
 124 public:
 125         State get_state() const { return state; }
 126
 127 protected:
 128         void rebuild();
 129         virtual void rebuild_special(const Part &);
 130
 131 public:
 132         void render(GL::Renderer &) const;
 133 protected:
 134         virtual void render_special(const Part &, GL::Renderer &) const { }
 135
 136 public:
 137         // Events
 138         virtual void button_press(int, int, unsigned) { }
 139         virtual void button_release(int, int, unsigned) { }
 140         virtual void pointer_motion(int, int) { }
 141         virtual void pointer_enter();
 142         virtual void pointer_leave();
 143         virtual void touch_press(int, int, unsigned);
 144         virtual void touch_release(int, int, unsigned);
 145         virtual void touch_motion(int, int, unsigned);
 146         virtual bool key_press(unsigned, unsigned) { return false; }
 147         virtual bool key_release(unsigned, unsigned) { return false; }
 148         virtual bool character(wchar_t) { return false; }
 149         virtual void focus_in();
 150         virtual void focus_out();
 151 protected:
 152         virtual void on_geometry_change() { }
 153         virtual void on_style_change() { }
 154         virtual void on_reparent() { }
 155 };
 156
 157 } // namespace GLtk
 158 } // namespace Msp
 159
 160 #endif