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         /// Returns the name of the widget class.  Used for style lookup.
  60         virtual const char *get_class() const { return "widget"; }
  61
  62         void set_position(int, int);
  63         void set_size(unsigned, unsigned);
  64         virtual void autosize();
  65         void set_geometry(const Geometry &);
  66         const Geometry &get_geometry() const { return geom; }
  67
  68 protected:
  69         /** Sets the widget's parent Container.  The widget must be unparented when
  70         calling this function with a non-null parameter. */
  71         void set_parent(Container *);
  72 public:
  73         Container *get_parent() const { return parent; }
  74
  75         /** Sets the widget style.  The name of the resource to be looked up is
  76         constructed by concatenating the widget class and the style name with a
  77         dash. */
  78         void set_style(const std::string &);
  79         const Style &get_style() const { return *style; }
  80
  81 protected:
  82         /** Gets a style object from the resource collection based on the class and
  83         style names of the widget. */
  84         void update_style();
  85
  86 public:
  87         void set_tooltip(const std::string &);
  88         const std::string &get_tooltip() const { return tooltip; }
  89
  90         void set_visible(bool);
  91         bool is_visible() const { return visible; }
  92         void set_focusable(bool);
  93         bool is_focusable() const { return focusable; }
  94         void set_focus();
  95
  96 protected:
  97         void set_state(State s) { set_state(s, s); }
  98         void clear_state(State s) { set_state(s, NORMAL); }
  99         void set_state(State, State);
 100
 101         void rebuild();
 102         virtual void rebuild_special(const Part &, CachedPart &) { }
 103
 104 public:
 105         void render(GL::Renderer &) const;
 106 protected:
 107         virtual void render_special(const Part &, GL::Renderer &) const { }
 108
 109 public:
 110         // Events
 111         virtual void button_press(int, int, unsigned) { }
 112         virtual void button_release(int, int, unsigned) { }
 113         virtual void pointer_motion(int, int) { }
 114         virtual void pointer_enter();
 115         virtual void pointer_leave();
 116         virtual void key_press(unsigned, unsigned) { }
 117         virtual void key_release(unsigned, unsigned) { }
 118         virtual void character(wchar_t) { }
 119         virtual void focus_in();
 120         virtual void focus_out();
 121 protected:
 122         virtual void on_geometry_change() { }
 123         virtual void on_style_change() { }
 124         virtual void on_reparent() { }
 125 };
 126
 127 } // namespace GLtk
 128 } // namespace Msp
 129
 130 #endif