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         sigc::signal<void, const Time::TimeDelta &> signal_request_animation;
  44         sigc::signal<void> signal_rebuild_needed;
  45
  46 protected:
  47         Geometry geom;
  48         std::string style_name;
  49         const Style *style;
  50         State state;
  51         bool visible;
  52         InputType input_type;
  53         Container *parent;
  54         std::string tooltip;
  55         PartCache part_cache;
  56         bool rebuild_needed;
  57         Time::TimeDelta anim_interval;
  58
  59         Widget();
  60 private:
  61         Widget(const Widget &);
  62         Widget &operator=(const Widget &);
  63 public:
  64         virtual ~Widget();
  65
  66         /// Returns the name of the widget class.  Used for style lookup.
  67         virtual const char *get_class() const { return "widget"; }
  68
  69         void set_position(int, int);
  70         void set_size(unsigned, unsigned);
  71         void autosize();
  72         void autosize(Geometry &) const;
  73 protected:
  74         virtual void autosize_special(const Part &, Geometry &) const { };
  75 public:
  76         void set_geometry(const Geometry &);
  77         const Geometry &get_geometry() const { return geom; }
  78
  79         void map_coords_to_ancestor(int &, int &, const Widget &) const;
  80
  81 protected:
  82         /** Sets the widget's parent Container.  The widget must be unparented when
  83         calling this function with a non-null parameter. */
  84         void set_parent(Container *);
  85 public:
  86         Container *get_parent() const { return parent; }
  87
  88         /** Finds the closest ancestor of a specific type. */
  89         template<typename T>
  90         T *find_ancestor() const
  91         {
  92                 for(Widget *w=parent; w; w=w->get_parent())
  93                         if(T *tw = dynamic_cast<T *>(w))
  94                                 return tw;
  95                 return 0;
  96         }
  97
  98         /** Sets the widget style.  The name of the resource to be looked up is
  99         constructed by concatenating the widget class and the style name with a
 100         dash. */
 101         void set_style(const std::string &);
 102         const Style &get_style() const { return *style; }
 103
 104 protected:
 105         /** Gets a style object from the resource collection based on the class and
 106         style names of the widget. */
 107         void update_style();
 108
 109 public:
 110         void set_tooltip(const std::string &);
 111         const std::string &get_tooltip() const { return tooltip; }
 112
 113         void set_visible(bool);
 114         bool is_visible() const { return visible; }
 115         InputType get_input_type() const { return input_type; }
 116         bool is_focusable() const { return visible && input_type!=INPUT_NONE; }
 117         void set_focus();
 118         void set_enabled(bool);
 119         bool is_enabled() const { return !(state&DISABLED); }
 120
 121         // Deprecated
 122         void set_focusable(bool);
 123
 124 protected:
 125         void set_state(State s) { set_state(s, s); }
 126         void clear_state(State s) { set_state(s, NORMAL); }
 127         void set_state(State, State);
 128 public:
 129         State get_state() const { return state; }
 130
 131 protected:
 132         void set_animation_interval(const Time::TimeDelta &);
 133         void stop_animation();
 134 public:
 135         const Time::TimeDelta &get_animation_interval() const { return anim_interval; }
 136
 137 protected:
 138         void mark_rebuild();
 139         virtual void rebuild_hierarchy();
 140         void rebuild();
 141         virtual void rebuild_special(const Part &);
 142
 143 public:
 144         void render(GL::Renderer &) const;
 145 protected:
 146         virtual void render_special(const Part &, GL::Renderer &) const { }
 147
 148 public:
 149         // Events
 150         virtual void button_press(int, int, unsigned) { }
 151         virtual void button_release(int, int, unsigned) { }
 152         virtual void pointer_motion(int, int) { }
 153         virtual void pointer_enter();
 154         virtual void pointer_leave();
 155         virtual void touch_press(int, int, unsigned);
 156         virtual void touch_release(int, int, unsigned);
 157         virtual void touch_motion(int, int, unsigned);
 158         virtual bool key_press(unsigned, unsigned) { return false; }
 159         virtual bool key_release(unsigned, unsigned) { return false; }
 160         virtual bool character(wchar_t) { return false; }
 161         virtual void focus_in();
 162         virtual void focus_out();
 163         virtual bool navigate(Navigation) { return false; }
 164         virtual void animate(const Time::TimeDelta &) { }
 165 protected:
 166         virtual void on_size_change() { on_geometry_change(); }
 167         virtual void on_style_change() { }
 168         virtual void on_reparent() { }
 169
 170         // Deprecated
 171         virtual void on_geometry_change() { }
 172 };
 173
 174 } // namespace GLtk
 175 } // namespace Msp
 176
 177 #endif