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 "partcache.h"
   9 #include "state.h"
  10
  11 namespace Msp {
  12 namespace GLtk {
  13
  14 class Container;
  15 class Part;
  16 class Resources;
  17 class Style;
  18
  19 /**
  20 Base class for all widgets.  Derived classes should call update_style in
  21 constructor, because it can't be done correctly in the Widget constructor.
  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         bool focusable;
  51         Container *parent;
  52         std::string tooltip;
  53         std::list<CachedPart> cached_parts;
  54
  55         Widget();
  56 public:
  57         virtual ~Widget();
  58
  59         /**
  60         Returns the name of the widget class.  Used for style lookup.
  61         */
  62         virtual const char *get_class() const { return "widget"; }
  63
  64         void set_position(int, int);
  65         void set_size(unsigned, unsigned);
  66         virtual void autosize();
  67         void set_geometry(const Geometry &);
  68         const Geometry &get_geometry() const { return geom; }
  69
  70 protected:
  71         /**
  72         Sets the widget's parent Container.  The widget must be unparented when
  73         calling this function with a non-null parameter.
  74         */
  75         void set_parent(Container *);
  76 public:
  77         Container *get_parent() const { return parent; }
  78
  79         /**
  80         Sets the widget style.  The final style name is constructed by concatenating
  81         the widget class and the style name with a dash.
  82         */
  83         void set_style(const std::string &);
  84         const Style &get_style() const { return *style; }
  85
  86 protected:
  87         /**
  88         Gets a style object from the resource collection based on the class and
  89         style names of the widget.
  90         */
  91         void update_style();
  92
  93 public:
  94         void set_tooltip(const std::string &);
  95         const std::string &get_tooltip() const { return tooltip; }
  96
  97         void set_visible(bool);
  98         bool is_visible() const { return visible; }
  99         void set_focusable(bool);
 100         bool is_focusable() const { return focusable; }
 101         void set_focus();
 102
 103 protected:
 104         void set_state(State s) { set_state(s, s); }
 105         void clear_state(State s) { set_state(s, NORMAL); }
 106         void set_state(State, State);
 107
 108         void rebuild();
 109         virtual void rebuild_special(const Part &, CachedPart &) { }
 110
 111 public:
 112         void render(GL::Renderer &) const;
 113 protected:
 114         virtual void render_special(const Part &, GL::Renderer &) const { }
 115
 116 public:
 117         // Events
 118         virtual void button_press(int, int, unsigned) { }
 119         virtual void button_release(int, int, unsigned) { }
 120         virtual void pointer_motion(int, int) { }
 121         virtual void pointer_enter();
 122         virtual void pointer_leave();
 123         virtual void key_press(unsigned, unsigned) { }
 124         virtual void key_release(unsigned, unsigned) { }
 125         virtual void character(wchar_t) { }
 126         virtual void focus_in();
 127         virtual void focus_out();
 128 protected:
 129         virtual void on_geometry_change() { }
 130         virtual void on_style_change() { }
 131         virtual void on_reparent() { }
 132 };
 133
 134 } // namespace GLtk
 135 } // namespace Msp
 136
 137 #endif